Switch Services

GET /cliTemplates/examples

Get Examples

Return Type:

Changed response : 200 OK

OK

Changed content type : application/json
- Changed property cli (object)
  The CLI command template text containing configuration commands for switch management.
- Changed property id (object)
  The identifier
- Changed property name (object)
  The name of the CLI template sample for identification and reference.
- Changed property version (object)
  The firmware version or compatibility version for which this CLI template is designed.
Changed content type : application/vnd.ruckus.v1+json
- Changed property cli (object)
  The CLI command template text containing configuration commands for switch management.
- Changed property id (object)
  The identifier
- Changed property name (object)
  The name of the CLI template sample for identification and reference.
- Changed property version (object)
  The firmware version or compatibility version for which this CLI template is designed.

Changed response : 400 Bad Request

Bad/malformed request

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 401 Unauthorized

Unauthorized

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 403 Forbidden

Forbidden

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 404 Not Found

Requested resource or related entity not found

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 422 Unprocessable Entity

Validation error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 500 Internal Server Error

Internal Server Error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

POST /cliTemplates/query

Query Command Line Interface Templates

Request:

Changed content type : application/json

Changed property fields (object)
The list of field names to include in the query response, allowing clients to request only specific fields.
Changed property filterType (object)
The dynamic filter type (deprecated, use filters instead).
Changed property filters (object)
The dynamic filter map where keys are field names and values are lists of filter criteria to apply for each field.
Changed property page (object)
The page number for pagination, starting from 1, defaulting to 1.
Changed property pageSize (object)
The number of records to return per page, defaulting to 25.
Changed property searchString (object)
The search string for full text search across the specified target fields.
Changed property searchTargetFields (object)
The list of field names to search within when applying the search string.
Changed property sortField (object)
The field name to use for sorting the query results.
Changed property sortOrder (object)
The sort order direction for the query results, either ascending or descending, defaulting to ascending.

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

Changed property fields (object)
The list of field names to include in the query response, allowing clients to request only specific fields.
Changed property filterType (object)
The dynamic filter type (deprecated, use filters instead).
Changed property filters (object)
The dynamic filter map where keys are field names and values are lists of filter criteria to apply for each field.
Changed property page (object)
The page number for pagination, starting from 1, defaulting to 1.
Changed property pageSize (object)
The number of records to return per page, defaulting to 25.
Changed property searchString (object)
The search string for full text search across the specified target fields.
Changed property searchTargetFields (object)
The list of field names to search within when applying the search string.
Changed property sortField (object)
The field name to use for sorting the query results.
Changed property sortOrder (object)
The sort order direction for the query results, either ascending or descending, defaulting to ascending.

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

Changed property fields (object)
The list of field names to include in the query response, allowing clients to request only specific fields.
Changed property filterType (object)
The dynamic filter type (deprecated, use filters instead).
Changed property filters (object)
The dynamic filter map where keys are field names and values are lists of filter criteria to apply for each field.
Changed property page (object)
The page number for pagination, starting from 1, defaulting to 1.
Changed property pageSize (object)
The number of records to return per page, defaulting to 25.
Changed property searchString (object)
The search string for full text search across the specified target fields.
Changed property searchTargetFields (object)
The list of field names to search within when applying the search string.
Changed property sortField (object)
The field name to use for sorting the query results.
Changed property sortOrder (object)
The sort order direction for the query results, either ascending or descending, defaulting to ascending.

Return Type:

Changed response : 200 OK

OK

Changed content type : application/json
- Changed property data (object)
  The list of data records returned by the query, with each item representing a result object.
- Changed property fields (object)
  The list of field names included in the query response data.
- Changed property page (object)
  The current page number of the paginated results.
- Changed property totalCount (object)
  The total number of records matching the query criteria across all pages.
- Changed property totalPages (object)
  The total number of pages available based on the page size and total record count.
Changed content type : application/vnd.ruckus.v1+json
- Changed property data (object)
  The list of data records returned by the query, with each item representing a result object.
- Changed property fields (object)
  The list of field names included in the query response data.
- Changed property page (object)
  The current page number of the paginated results.
- Changed property totalCount (object)
  The total number of records matching the query criteria across all pages.
- Changed property totalPages (object)
  The total number of pages available based on the page size and total record count.
Changed content type : application/vnd.ruckus.v1.1+json
- Changed property data (object)
  The list of data records returned by the query, with each item representing a result object.
- Changed property fields (object)
  The list of field names included in the query response data.
- Changed property page (object)
  The current page number of the paginated results.
- Changed property totalCount (object)
  The total number of records matching the query criteria across all pages.
- Changed property totalPages (object)
  The total number of pages available based on the page size and total record count.

Changed response : 400 Bad Request

Bad/malformed request

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 401 Unauthorized

Unauthorized

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 403 Forbidden

Forbidden

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 404 Not Found

Requested resource or related entity not found

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 422 Unprocessable Entity

Validation error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 500 Internal Server Error

Internal Server Error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

GET /switchFirmwares/currentVersions

Return Type:

Changed response : 200 OK

OK

Changed content type : application/json
- Changed property currentVersions (object)
  The list of current firmware versions running on switches with version 10 or below in this venue.
- Changed property currentVersionsAboveTen (object)
  The list of current firmware versions running on switches with version above 10 in this venue.
Changed content type : application/vnd.ruckus.v1+json
- Changed property currentVersions (object)
  The list of current firmware versions running on switches with version 10 or below in this venue.
- Changed property currentVersionsAboveTen (object)
  The list of current firmware versions running on switches with version above 10 in this venue.
Changed content type : application/vnd.ruckus.v1.1+json
- Changed property currentVersions (object)
  The list of current firmware versions grouped by switch model, showing which versions are running on which models in this venue.

Changed response : 400 Bad Request

Bad/malformed request

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 401 Unauthorized

Unauthorized

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 403 Forbidden

Forbidden

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 404 Not Found

Requested resource or related entity not found

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 422 Unprocessable Entity

Validation error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 500 Internal Server Error

Internal Server Error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

POST /switchFirmwares/schedules/query

Request:

Changed content type : application/json

Changed property firmwareVersion (object)
Firmware version string to filter venues by switch firmware version.
Changed property searchFilter (object)
Search filter string for filtering venues by name or other attributes.

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

Changed property firmwareVersion (object)
Firmware version string to filter venues by switch firmware version.
Changed property searchFilter (object)
Search filter string for filtering venues by name or other attributes.

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

Changed property firmwareVersion (object)
The firmware version to filter venues based on the current or target firmware version of their switches.
Changed property modelGroup (object)
The switch model group to filter venues by the types of switch models deployed within them.
Changed property searchFilter (object)
The search filter text for matching venues by name or other identifiable fields.

Return Type:

Changed response : 400 Bad Request

Bad/malformed request

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 401 Unauthorized

Unauthorized

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 403 Forbidden

Forbidden

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 404 Not Found

Requested resource or related entity not found

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 422 Unprocessable Entity

Validation error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 500 Internal Server Error

Internal Server Error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

POST /switchFirmwares/schedules/switches/query

Request:

Changed content type : application/json

Changed property searchFilter (object)
Search filter string for filtering switches by name, model, or other attributes.
Changed property venueIdList (object)
List of venue identifiers to filter switches by venue.

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

Changed property searchFilter (object)
Search filter string for filtering switches by name, model, or other attributes.
Changed property venueIdList (object)
List of venue identifiers to filter switches by venue.

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

Changed property searchFilter (object)
The search filter text for matching switches by name, MAC address, IP address, or other identifiable fields.
Changed property searchTargetFields (object)
The list of field names to be used as search targets when applying the search filter.
Changed property venueIdList (object)
The list of venue identifiers to filter switches by their associated venues for targeted firmware upgrades.

Return Type:

Changed response : 400 Bad Request

Bad/malformed request

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 401 Unauthorized

Unauthorized

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 403 Forbidden

Forbidden

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 404 Not Found

Requested resource or related entity not found

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 422 Unprocessable Entity

Validation error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 500 Internal Server Error

Internal Server Error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

GET /switchFirmwares/versions/{versionType}

Return Type:

Changed response : 400 Bad Request

Bad/malformed request

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 401 Unauthorized

Unauthorized

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 403 Forbidden

Forbidden

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 404 Not Found

Requested resource or related entity not found

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 422 Unprocessable Entity

Validation error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 500 Internal Server Error

Internal Server Error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

POST /switchProfiles/query

Request:

Changed content type : application/json

Changed property fields (object)
The list of field names to include in the query response, allowing clients to request only specific fields.
Changed property filterType (object)
The dynamic filter type (deprecated, use filters instead).
Changed property filters (object)
The dynamic filter map where keys are field names and values are lists of filter criteria to apply for each field.
Changed property page (object)
The page number for pagination, starting from 1, defaulting to 1.
Changed property pageSize (object)
The number of records to return per page, defaulting to 25.
Changed property searchString (object)
The search string for full text search across the specified target fields.
Changed property searchTargetFields (object)
The list of field names to search within when applying the search string.
Changed property sortField (object)
The field name to use for sorting the query results.
Changed property sortOrder (object)
The sort order direction for the query results, either ascending or descending, defaulting to ascending.

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

Changed property fields (object)
The list of field names to include in the query response, allowing clients to request only specific fields.
Changed property filterType (object)
The dynamic filter type (deprecated, use filters instead).
Changed property filters (object)
The dynamic filter map where keys are field names and values are lists of filter criteria to apply for each field.
Changed property page (object)
The page number for pagination, starting from 1, defaulting to 1.
Changed property pageSize (object)
The number of records to return per page, defaulting to 25.
Changed property searchString (object)
The search string for full text search across the specified target fields.
Changed property searchTargetFields (object)
The list of field names to search within when applying the search string.
Changed property sortField (object)
The field name to use for sorting the query results.
Changed property sortOrder (object)
The sort order direction for the query results, either ascending or descending, defaulting to ascending.

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

Changed property fields (object)
The list of field names to include in the query response, allowing clients to request only specific fields.
Changed property filterType (object)
The dynamic filter type (deprecated, use filters instead).
Changed property filters (object)
The dynamic filter map where keys are field names and values are lists of filter criteria to apply for each field.
Changed property page (object)
The page number for pagination, starting from 1, defaulting to 1.
Changed property pageSize (object)
The number of records to return per page, defaulting to 25.
Changed property searchString (object)
The search string for full text search across the specified target fields.
Changed property searchTargetFields (object)
The list of field names to search within when applying the search string.
Changed property sortField (object)
The field name to use for sorting the query results.
Changed property sortOrder (object)
The sort order direction for the query results, either ascending or descending, defaulting to ascending.

Return Type:

Changed response : 200 OK

OK

Changed content type : application/json
- Changed property data (object)
  The list of data records returned by the query, with each item representing a result object.
- Changed property fields (object)
  The list of field names included in the query response data.
- Changed property page (object)
  The current page number of the paginated results.
- Changed property totalCount (object)
  The total number of records matching the query criteria across all pages.
- Changed property totalPages (object)
  The total number of pages available based on the page size and total record count.
Changed content type : application/vnd.ruckus.v1+json
- Changed property data (object)
  The list of data records returned by the query, with each item representing a result object.
- Changed property fields (object)
  The list of field names included in the query response data.
- Changed property page (object)
  The current page number of the paginated results.
- Changed property totalCount (object)
  The total number of records matching the query criteria across all pages.
- Changed property totalPages (object)
  The total number of pages available based on the page size and total record count.
Changed content type : application/vnd.ruckus.v1.1+json
- Changed property data (object)
  The list of data records returned by the query, with each item representing a result object.
- Changed property fields (object)
  The list of field names included in the query response data.
- Changed property page (object)
  The current page number of the paginated results.
- Changed property totalCount (object)
  The total number of records matching the query criteria across all pages.
- Changed property totalPages (object)
  The total number of pages available based on the page size and total record count.

Changed response : 400 Bad Request

Bad/malformed request

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 401 Unauthorized

Unauthorized

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 403 Forbidden

Forbidden

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 404 Not Found

Requested resource or related entity not found

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 422 Unprocessable Entity

Validation error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 500 Internal Server Error

Internal Server Error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

GET /switches/acls/{aclId}

Return Type:

Changed response : 200 OK

OK

Changed content type : application/json
- Changed property aclRules (object)
  The set of rules associated with this ACL, defining the filtering criteria and actions to be taken.
- Changed property aclType (object)
  The type of access control list, specifying whether it filters based on IP addresses, MAC addresses, or other criteria.
- Changed property aclViewList (object)
  The list of ACL views, used for retrieving multiple ACL configurations in a single response.
- Changed property id (object)
  The identifier
- Changed property name (object)
  The unique name identifier for this access control list.
Changed content type : application/vnd.ruckus.v1+json
- Changed property aclRules (object)
  The set of rules associated with this ACL, defining the filtering criteria and actions to be taken.
- Changed property aclType (object)
  The type of access control list, specifying whether it filters based on IP addresses, MAC addresses, or other criteria.
- Changed property aclViewList (object)
  The list of ACL views, used for retrieving multiple ACL configurations in a single response.
- Changed property id (object)
  The identifier
- Changed property name (object)
  The unique name identifier for this access control list.

Changed response : 400 Bad Request

Bad/malformed request

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 401 Unauthorized

Unauthorized

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 403 Forbidden

Forbidden

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 404 Not Found

Requested resource or related entity not found

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 422 Unprocessable Entity

Validation error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 500 Internal Server Error

Internal Server Error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

POST /switches/configBackups/comparisons

Request:

Changed content type : application/json

Changed property backupId1 (object)
The first configuration backup id for comparison.
Changed property backupId2 (object)
The second configuration backup id for comparison.

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

Changed property backupId1 (object)
The first configuration backup id for comparison.
Changed property backupId2 (object)
The second configuration backup id for comparison.

Return Type:

Changed response : 200 OK

OK

Changed content type : application/json
- Deleted property response (object)
- Changed property id (object)
  The identifier
Changed content type : application/vnd.ruckus.v1+json
- Deleted property response (object)
- Changed property id (object)
  The identifier

Changed response : 400 Bad Request

Bad/malformed request

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 401 Unauthorized

Unauthorized

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 403 Forbidden

Forbidden

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 404 Not Found

Requested resource or related entity not found

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 422 Unprocessable Entity

Validation error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 500 Internal Server Error

Internal Server Error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

POST /switches/deviceRequests

Request:

Changed content type : application/json

Changed property deviceRequestAction (object)
Action to be performed on the specified devices (e.g., reboot, upgrade, delete).
Changed property switchIdList (object)
List of switch identifiers (serial numbers or IDs) to perform the action on.

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

Changed property deviceRequestAction (object)
Action to be performed on the specified devices (e.g., reboot, upgrade, delete).
Changed property switchIdList (object)
List of switch identifiers (serial numbers or IDs) to perform the action on.

Return Type:

Changed response : 200 OK

OK

Changed content type : application/json
- Changed property id (object)
  The identifier
- Changed property switchIdList (object)
  The list of switch identifiers to which the admin password will be synchronized.
- Changed property tenantId (object)
  The unique identifier of the tenant for which admin passwords should be synchronized.
Changed content type : application/vnd.ruckus.v1+json
- Changed property id (object)
  The identifier
- Changed property switchIdList (object)
  The list of switch identifiers to which the admin password will be synchronized.
- Changed property tenantId (object)
  The unique identifier of the tenant for which admin passwords should be synchronized.

Changed response : 400 Bad Request

Bad/malformed request

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 401 Unauthorized

Unauthorized

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 403 Forbidden

Forbidden

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 404 Not Found

Requested resource or related entity not found

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 422 Unprocessable Entity

Validation error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 500 Internal Server Error

Internal Server Error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

POST /switches/dhcpServers/query

Request:

Changed content type : application/json

Changed property fields (object)
The list of field names to include in the query response, allowing clients to request only specific fields.
Changed property page (object)
The page number for pagination, starting from 1, defaulting to 1.
Changed property pageSize (object)
The number of records to return per page, defaulting to 25.
Changed property sortField (object)
The field name to use for sorting the query results.
Changed property sortOrder (object)
The sort order direction for the query results, either ascending or descending, defaulting to ascending.
Changed property venueId (object)
The venue identifier to filter DHCP server configurations by specific venue.

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

Changed property fields (object)
The list of field names to include in the query response, allowing clients to request only specific fields.
Changed property page (object)
The page number for pagination, starting from 1, defaulting to 1.
Changed property pageSize (object)
The number of records to return per page, defaulting to 25.
Changed property sortField (object)
The field name to use for sorting the query results.
Changed property sortOrder (object)
The sort order direction for the query results, either ascending or descending, defaulting to ascending.
Changed property venueId (object)
The venue identifier to filter DHCP server configurations by specific venue.

Return Type:

Changed response : 200 OK

OK

Changed content type : application/json
- Changed property data (object)
  The list of data records returned by the query, with each item representing a result object.
- Changed property fields (object)
  The list of field names included in the query response data.
- Changed property page (object)
  The current page number of the paginated results.
- Changed property totalCount (object)
  The total number of records matching the query criteria across all pages.
- Changed property totalPages (object)
  The total number of pages available based on the page size and total record count.
Changed content type : application/vnd.ruckus.v1+json
- Changed property data (object)
  The list of data records returned by the query, with each item representing a result object.
- Changed property fields (object)
  The list of field names included in the query response data.
- Changed property page (object)
  The current page number of the paginated results.
- Changed property totalCount (object)
  The total number of records matching the query criteria across all pages.
- Changed property totalPages (object)
  The total number of pages available based on the page size and total record count.

Changed response : 400 Bad Request

Bad/malformed request

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 401 Unauthorized

Unauthorized

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 403 Forbidden

Forbidden

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 404 Not Found

Requested resource or related entity not found

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 422 Unprocessable Entity

Validation error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 500 Internal Server Error

Internal Server Error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

GET /switches/dhcpServers/{dhcpServerId}

Get DHCP Server Setting

Return Type:

Changed response : 200 OK

OK

Changed content type : application/json
- Changed property defaultRouterIp (object)
  The default gateway IP address provided to DHCP clients.
- Changed property dhcpOptions (object)
  The list of additional DHCP options to be provided to clients.
- Changed property excludedEnd (object)
  The ending IP address of the excluded address range that will not be assigned to clients.
- Changed property excludedStart (object)
  The starting IP address of the excluded address range that will not be assigned to clients.
- Changed property id (object)
  The unique identifier of the DHCP server configuration.
- Changed property leaseDays (object)
  The number of days in the DHCP lease duration.
- Changed property leaseHrs (object)
  The number of hours in the DHCP lease duration.
- Changed property leaseMins (object)
  The number of minutes in the DHCP lease duration.
- Changed property network (object)
  The network address for the DHCP pool.
- Changed property poolName (object)
  The name of the DHCP address pool.
- Changed property subnetAddress (object)
  The subnet network address for the DHCP pool.
- Changed property subnetMask (object)
  The subnet mask for the DHCP network.
Changed content type : application/vnd.ruckus.v1+json
- Changed property defaultRouterIp (object)
  The default gateway IP address provided to DHCP clients.
- Changed property dhcpOptions (object)
  The list of additional DHCP options to be provided to clients.
- Changed property excludedEnd (object)
  The ending IP address of the excluded address range that will not be assigned to clients.
- Changed property excludedStart (object)
  The starting IP address of the excluded address range that will not be assigned to clients.
- Changed property id (object)
  The unique identifier of the DHCP server configuration.
- Changed property leaseDays (object)
  The number of days in the DHCP lease duration.
- Changed property leaseHrs (object)
  The number of hours in the DHCP lease duration.
- Changed property leaseMins (object)
  The number of minutes in the DHCP lease duration.
- Changed property network (object)
  The network address for the DHCP pool.
- Changed property poolName (object)
  The name of the DHCP address pool.
- Changed property subnetAddress (object)
  The subnet network address for the DHCP pool.
- Changed property subnetMask (object)
  The subnet mask for the DHCP network.

Changed response : 400 Bad Request

Bad/malformed request

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 401 Unauthorized

Unauthorized

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 403 Forbidden

Forbidden

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 404 Not Found

Requested resource or related entity not found

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 422 Unprocessable Entity

Validation error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 500 Internal Server Error

Internal Server Error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

POST /switches/vlans/query

Request:

Changed content type : application/json

Changed property isDefault (object)
Flag indicating whether this is a default VLAN operation (default: false).
Changed property switchIds (object)
List of switch identifiers (serial numbers) to perform the VLAN operation on.

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

Changed property isDefault (object)
Flag indicating whether this is a default VLAN operation (default: false).
Changed property switchIds (object)
List of switch identifiers (serial numbers) to perform the VLAN operation on.

Return Type:

Changed response : 200 OK

OK

Changed content type : application/json
- Changed property defaultVlanId (object)
  Default VLAN identifier for the switch (typically 1).
- Changed property id (object)
  The identifier
- Changed property switchId (object)
  Switch identifier (serial number).
- Changed property vlanList (object)
  List of VLAN configurations present on the switch.
Changed content type : application/vnd.ruckus.v1+json
- Changed property defaultVlanId (object)
  Default VLAN identifier for the switch (typically 1).
- Changed property id (object)
  The identifier
- Changed property switchId (object)
  Switch identifier (serial number).
- Changed property vlanList (object)
  List of VLAN configurations present on the switch.

Changed response : 400 Bad Request

Bad/malformed request

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 401 Unauthorized

Unauthorized

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 403 Forbidden

Forbidden

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 404 Not Found

Requested resource or related entity not found

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 422 Unprocessable Entity

Validation error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 500 Internal Server Error

Internal Server Error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

GET /switches/{switchId}/aclUnions

Return Type:

Changed response : 200 OK

OK

Changed content type : application/json
- Changed property profileAcl (object)
  The list of ACL (Access Control List) names configured in the profile, representing the access control rules defined at the profile level.
- Changed property switchAcl (object)
  The list of ACL (Access Control List) names configured on the switch, representing the access control rules directly applied to the network device.
Changed content type : application/vnd.ruckus.v1+json
- Changed property profileAcl (object)
  The list of ACL (Access Control List) names configured in the profile, representing the access control rules defined at the profile level.
- Changed property switchAcl (object)
  The list of ACL (Access Control List) names configured on the switch, representing the access control rules directly applied to the network device.

Changed response : 400 Bad Request

Bad/malformed request

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 401 Unauthorized

Unauthorized

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 403 Forbidden

Forbidden

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 404 Not Found

Requested resource or related entity not found

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 422 Unprocessable Entity

Validation error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 500 Internal Server Error

Internal Server Error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

GET /switches/{switchId}/acls

Return Type:

Changed response : 200 OK

OK

Changed content type : application/json
- Changed property aclRules (object)
  The set of rules associated with this ACL, defining the filtering criteria and actions to be taken.
- Changed property aclType (object)
  The type of access control list, specifying whether it filters based on IP addresses, MAC addresses, or other criteria.
- Changed property aclViewList (object)
  The list of ACL views, used for retrieving multiple ACL configurations in a single response.
- Changed property id (object)
  The identifier
- Changed property name (object)
  The unique name identifier for this access control list.
Changed content type : application/vnd.ruckus.v1+json
- Changed property aclRules (object)
  The set of rules associated with this ACL, defining the filtering criteria and actions to be taken.
- Changed property aclType (object)
  The type of access control list, specifying whether it filters based on IP addresses, MAC addresses, or other criteria.
- Changed property aclViewList (object)
  The list of ACL views, used for retrieving multiple ACL configurations in a single response.
- Changed property id (object)
  The identifier
- Changed property name (object)
  The unique name identifier for this access control list.

Changed response : 400 Bad Request

Bad/malformed request

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 401 Unauthorized

Unauthorized

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 403 Forbidden

Forbidden

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 404 Not Found

Requested resource or related entity not found

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 422 Unprocessable Entity

Validation error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 500 Internal Server Error

Internal Server Error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

POST /switches/{switchId}/acls/query

Request:

Changed content type : application/json

Changed property fields (object)
The list of field names to include in the query response, allowing clients to request only specific fields.
Changed property page (object)
The page number for pagination, starting from 1, defaulting to 1.
Changed property pageSize (object)
The number of records to return per page, defaulting to 25.
Changed property sortField (object)
The field name to use for sorting the query results.
Changed property sortOrder (object)
The sort order direction for the query results, either ascending or descending, defaulting to ascending.

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

Changed property fields (object)
The list of field names to include in the query response, allowing clients to request only specific fields.
Changed property page (object)
The page number for pagination, starting from 1, defaulting to 1.
Changed property pageSize (object)
The number of records to return per page, defaulting to 25.
Changed property sortField (object)
The field name to use for sorting the query results.
Changed property sortOrder (object)
The sort order direction for the query results, either ascending or descending, defaulting to ascending.

Return Type:

Changed response : 200 OK

OK

Changed content type : application/json
- Changed property data (object)
  The list of data records returned by the query, with each item representing a result object.
- Changed property fields (object)
  The list of field names included in the query response data.
- Changed property page (object)
  The current page number of the paginated results.
- Changed property totalCount (object)
  The total number of records matching the query criteria across all pages.
- Changed property totalPages (object)
  The total number of pages available based on the page size and total record count.
Changed content type : application/vnd.ruckus.v1+json
- Changed property data (object)
  The list of data records returned by the query, with each item representing a result object.
- Changed property fields (object)
  The list of field names included in the query response data.
- Changed property page (object)
  The current page number of the paginated results.
- Changed property totalCount (object)
  The total number of records matching the query criteria across all pages.
- Changed property totalPages (object)
  The total number of pages available based on the page size and total record count.

Changed response : 400 Bad Request

Bad/malformed request

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 401 Unauthorized

Unauthorized

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 403 Forbidden

Forbidden

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 404 Not Found

Requested resource or related entity not found

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 422 Unprocessable Entity

Validation error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 500 Internal Server Error

Internal Server Error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

POST /switches/{switchId}/configBackups/query

Request:

Changed content type : application/json

Changed property fields (object)
The list of field names to include in the query response, allowing clients to request only specific fields.
Changed property page (object)
The page number for pagination, starting from 1, defaulting to 1.
Changed property pageSize (object)
The number of records to return per page, defaulting to 25.
Changed property sortField (object)
The field name to use for sorting the query results.
Changed property sortOrder (object)
The sort order direction for the query results, either ascending or descending, defaulting to ascending.

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

Changed property fields (object)
The list of field names to include in the query response, allowing clients to request only specific fields.
Changed property page (object)
The page number for pagination, starting from 1, defaulting to 1.
Changed property pageSize (object)
The number of records to return per page, defaulting to 25.
Changed property sortField (object)
The field name to use for sorting the query results.
Changed property sortOrder (object)
The sort order direction for the query results, either ascending or descending, defaulting to ascending.

Return Type:

Changed response : 200 OK

OK

Changed content type : application/json
- Changed property data (object)
  The list of data records returned by the query, with each item representing a result object.
- Changed property fields (object)
  The list of field names included in the query response data.
- Changed property page (object)
  The current page number of the paginated results.
- Changed property totalCount (object)
  The total number of records matching the query criteria across all pages.
- Changed property totalPages (object)
  The total number of pages available based on the page size and total record count.
Changed content type : application/vnd.ruckus.v1+json
- Changed property data (object)
  The list of data records returned by the query, with each item representing a result object.
- Changed property fields (object)
  The list of field names included in the query response data.
- Changed property page (object)
  The current page number of the paginated results.
- Changed property totalCount (object)
  The total number of records matching the query criteria across all pages.
- Changed property totalPages (object)
  The total number of pages available based on the page size and total record count.

Changed response : 400 Bad Request

Bad/malformed request

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 401 Unauthorized

Unauthorized

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 403 Forbidden

Forbidden

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 404 Not Found

Requested resource or related entity not found

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 422 Unprocessable Entity

Validation error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 500 Internal Server Error

Internal Server Error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

POST /switches/{switchId}/deviceRequests

Sync or Reboot ICX Device

Request:

Changed content type : application/json

Changed property deviceRequestAction (object)
Action to be performed on the specified devices (e.g., reboot, upgrade, delete).
Changed property switchIdList (object)
List of switch identifiers (serial numbers or IDs) to perform the action on.

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

Changed property deviceRequestAction (object)
Action to be performed on the specified devices (e.g., reboot, upgrade, delete).
Changed property switchIdList (object)
List of switch identifiers (serial numbers or IDs) to perform the action on.

Return Type:

Changed response : 200 OK

OK

Changed content type : application/json
- Changed property errors (object)
  List of error codes with detailed information about validation or processing failures.
- Changed property requestId (object)
  Unique identifier for tracking the request.
Changed content type : application/vnd.ruckus.v1+json
- Changed property errors (object)
  List of error codes with detailed information about validation or processing failures.
- Changed property requestId (object)
  Unique identifier for tracking the request.

Changed response : 400 Bad Request

Bad/malformed request

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 401 Unauthorized

Unauthorized

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 403 Forbidden

Forbidden

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 404 Not Found

Requested resource or related entity not found

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 422 Unprocessable Entity

Validation error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 500 Internal Server Error

Internal Server Error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

POST /switches/{switchId}/dhcpServerStateSettings

Request:

Changed content type : application/json

Changed property state (object)
DHCP server state (true to enable, false to disable).

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

Changed property state (object)
DHCP server state (true to enable, false to disable).

Return Type:

Changed response : 200 OK

OK

Changed content type : application/json
- Changed property defaultRouterIp (object)
  The default gateway IP address provided to DHCP clients.
- Changed property dhcpOptions (object)
  The list of additional DHCP options to be provided to clients.
- Changed property excludedEnd (object)
  The ending IP address of the excluded address range that will not be assigned to clients.
- Changed property excludedStart (object)
  The starting IP address of the excluded address range that will not be assigned to clients.
- Changed property id (object)
  The unique identifier of the DHCP server configuration.
- Changed property leaseDays (object)
  The number of days in the DHCP lease duration.
- Changed property leaseHrs (object)
  The number of hours in the DHCP lease duration.
- Changed property leaseMins (object)
  The number of minutes in the DHCP lease duration.
- Changed property network (object)
  The network address for the DHCP pool.
- Changed property poolName (object)
  The name of the DHCP address pool.
- Changed property subnetAddress (object)
  The subnet network address for the DHCP pool.
- Changed property subnetMask (object)
  The subnet mask for the DHCP network.
Changed content type : application/vnd.ruckus.v1+json
- Changed property defaultRouterIp (object)
  The default gateway IP address provided to DHCP clients.
- Changed property dhcpOptions (object)
  The list of additional DHCP options to be provided to clients.
- Changed property excludedEnd (object)
  The ending IP address of the excluded address range that will not be assigned to clients.
- Changed property excludedStart (object)
  The starting IP address of the excluded address range that will not be assigned to clients.
- Changed property id (object)
  The unique identifier of the DHCP server configuration.
- Changed property leaseDays (object)
  The number of days in the DHCP lease duration.
- Changed property leaseHrs (object)
  The number of hours in the DHCP lease duration.
- Changed property leaseMins (object)
  The number of minutes in the DHCP lease duration.
- Changed property network (object)
  The network address for the DHCP pool.
- Changed property poolName (object)
  The name of the DHCP address pool.
- Changed property subnetAddress (object)
  The subnet network address for the DHCP pool.
- Changed property subnetMask (object)
  The subnet mask for the DHCP network.

Changed response : 400 Bad Request

Bad/malformed request

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 401 Unauthorized

Unauthorized

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 403 Forbidden

Forbidden

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 404 Not Found

Requested resource or related entity not found

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 422 Unprocessable Entity

Validation error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 500 Internal Server Error

Internal Server Error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

POST /switches/{switchId}/dhcpServers/query

Request:

Changed content type : application/json

Changed property fields (object)
The list of field names to include in the query response, allowing clients to request only specific fields.
Changed property page (object)
The page number for pagination, starting from 1, defaulting to 1.
Changed property pageSize (object)
The number of records to return per page, defaulting to 25.
Changed property sortField (object)
The field name to use for sorting the query results.
Changed property sortOrder (object)
The sort order direction for the query results, either ascending or descending, defaulting to ascending.
Changed property venueId (object)
The venue identifier to filter DHCP server configurations by specific venue.

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

Changed property fields (object)
The list of field names to include in the query response, allowing clients to request only specific fields.
Changed property page (object)
The page number for pagination, starting from 1, defaulting to 1.
Changed property pageSize (object)
The number of records to return per page, defaulting to 25.
Changed property sortField (object)
The field name to use for sorting the query results.
Changed property sortOrder (object)
The sort order direction for the query results, either ascending or descending, defaulting to ascending.
Changed property venueId (object)
The venue identifier to filter DHCP server configurations by specific venue.

Return Type:

Changed response : 200 OK

OK

Changed content type : application/json
- Changed property data (object)
  The list of data records returned by the query, with each item representing a result object.
- Changed property fields (object)
  The list of field names included in the query response data.
- Changed property page (object)
  The current page number of the paginated results.
- Changed property totalCount (object)
  The total number of records matching the query criteria across all pages.
- Changed property totalPages (object)
  The total number of pages available based on the page size and total record count.
Changed content type : application/vnd.ruckus.v1+json
- Changed property data (object)
  The list of data records returned by the query, with each item representing a result object.
- Changed property fields (object)
  The list of field names included in the query response data.
- Changed property page (object)
  The current page number of the paginated results.
- Changed property totalCount (object)
  The total number of records matching the query criteria across all pages.
- Changed property totalPages (object)
  The total number of pages available based on the page size and total record count.

Changed response : 400 Bad Request

Bad/malformed request

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 401 Unauthorized

Unauthorized

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 403 Forbidden

Forbidden

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 404 Not Found

Requested resource or related entity not found

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 422 Unprocessable Entity

Validation error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 500 Internal Server Error

Internal Server Error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

GET /switches/{switchId}/lags

Return Type:

Changed response : 200 OK

OK

Changed content type : application/json
- Changed property addPorts (object)
  The list of port identifiers to be added to this LAG.
- Changed property defaultVlanId (object)
  The default VLAN identifier for the LAG interface.
- Changed property id (object)
  The identifier
- Changed property lagId (object)
  The unique identifier of the LAG interface.
- Changed property lagViewList (object)
  The list of LAG view objects for batch operations.
- Changed property lastName (object)
  The previous name of the LAG interface, used when renaming.
- Changed property name (object)
  The name of the LAG interface, limited to 64 characters without quotes.
- Changed property originalUntaggedVlan (object)
  The original untagged VLAN identifier before modification.
- Changed property portAddVlans (object)
  The list of port VLAN associations to be added for LAG member ports.
- Changed property portVlans (object)
  The list of port VLAN associations for LAG member ports.
- Changed property ports (object)
  The set of physical port identifiers that are members of this LAG.
- Changed property realRemove (object)
  Whether to perform a real removal operation when deleting the LAG.
- Changed property removePorts (object)
  The list of port identifiers to be removed from this LAG.
- Changed property switchId (object)
  The unique identifier of the switch where this LAG is configured.
- Changed property taggedVlans (object)
  The set of VLAN identifiers that are tagged on this LAG interface.
- Changed property tenantId (object)
  The unique identifier of the tenant.
- Changed property type (object)
  The type of LAG protocol, such as static or LACP (Link Aggregation Control Protocol).
- Changed property untaggedVlan (object)
  The VLAN identifier for untagged traffic on this LAG interface.
Changed content type : application/vnd.ruckus.v1+json
- Changed property addPorts (object)
  The list of port identifiers to be added to this LAG.
- Changed property defaultVlanId (object)
  The default VLAN identifier for the LAG interface.
- Changed property id (object)
  The identifier
- Changed property lagId (object)
  The unique identifier of the LAG interface.
- Changed property lagViewList (object)
  The list of LAG view objects for batch operations.
- Changed property lastName (object)
  The previous name of the LAG interface, used when renaming.
- Changed property name (object)
  The name of the LAG interface, limited to 64 characters without quotes.
- Changed property originalUntaggedVlan (object)
  The original untagged VLAN identifier before modification.
- Changed property portAddVlans (object)
  The list of port VLAN associations to be added for LAG member ports.
- Changed property portVlans (object)
  The list of port VLAN associations for LAG member ports.
- Changed property ports (object)
  The set of physical port identifiers that are members of this LAG.
- Changed property realRemove (object)
  Whether to perform a real removal operation when deleting the LAG.
- Changed property removePorts (object)
  The list of port identifiers to be removed from this LAG.
- Changed property switchId (object)
  The unique identifier of the switch where this LAG is configured.
- Changed property taggedVlans (object)
  The set of VLAN identifiers that are tagged on this LAG interface.
- Changed property tenantId (object)
  The unique identifier of the tenant.
- Changed property type (object)
  The type of LAG protocol, such as static or LACP (Link Aggregation Control Protocol).
- Changed property untaggedVlan (object)
  The VLAN identifier for untagged traffic on this LAG interface.

Changed response : 400 Bad Request

Bad/malformed request

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 401 Unauthorized

Unauthorized

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 403 Forbidden

Forbidden

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 404 Not Found

Requested resource or related entity not found

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 422 Unprocessable Entity

Validation error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 500 Internal Server Error

Internal Server Error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

POST /switches/{switchId}/lags

Return Type:

Changed response : 200 OK

OK

Changed content type : application/json
- Changed property addPorts (object)
  The list of port identifiers to be added to this LAG.
- Changed property defaultVlanId (object)
  The default VLAN identifier for the LAG interface.
- Changed property id (object)
  The identifier
- Changed property lagId (object)
  The unique identifier of the LAG interface.
- Changed property lagViewList (object)
  The list of LAG view objects for batch operations.
- Changed property lastName (object)
  The previous name of the LAG interface, used when renaming.
- Changed property name (object)
  The name of the LAG interface, limited to 64 characters without quotes.
- Changed property originalUntaggedVlan (object)
  The original untagged VLAN identifier before modification.
- Changed property portAddVlans (object)
  The list of port VLAN associations to be added for LAG member ports.
- Changed property portVlans (object)
  The list of port VLAN associations for LAG member ports.
- Changed property ports (object)
  The set of physical port identifiers that are members of this LAG.
- Changed property realRemove (object)
  Whether to perform a real removal operation when deleting the LAG.
- Changed property removePorts (object)
  The list of port identifiers to be removed from this LAG.
- Changed property switchId (object)
  The unique identifier of the switch where this LAG is configured.
- Changed property taggedVlans (object)
  The set of VLAN identifiers that are tagged on this LAG interface.
- Changed property tenantId (object)
  The unique identifier of the tenant.
- Changed property type (object)
  The type of LAG protocol, such as static or LACP (Link Aggregation Control Protocol).
- Changed property untaggedVlan (object)
  The VLAN identifier for untagged traffic on this LAG interface.
Changed content type : application/vnd.ruckus.v1+json
- Changed property addPorts (object)
  The list of port identifiers to be added to this LAG.
- Changed property defaultVlanId (object)
  The default VLAN identifier for the LAG interface.
- Changed property id (object)
  The identifier
- Changed property lagId (object)
  The unique identifier of the LAG interface.
- Changed property lagViewList (object)
  The list of LAG view objects for batch operations.
- Changed property lastName (object)
  The previous name of the LAG interface, used when renaming.
- Changed property name (object)
  The name of the LAG interface, limited to 64 characters without quotes.
- Changed property originalUntaggedVlan (object)
  The original untagged VLAN identifier before modification.
- Changed property portAddVlans (object)
  The list of port VLAN associations to be added for LAG member ports.
- Changed property portVlans (object)
  The list of port VLAN associations for LAG member ports.
- Changed property ports (object)
  The set of physical port identifiers that are members of this LAG.
- Changed property realRemove (object)
  Whether to perform a real removal operation when deleting the LAG.
- Changed property removePorts (object)
  The list of port identifiers to be removed from this LAG.
- Changed property switchId (object)
  The unique identifier of the switch where this LAG is configured.
- Changed property taggedVlans (object)
  The set of VLAN identifiers that are tagged on this LAG interface.
- Changed property tenantId (object)
  The unique identifier of the tenant.
- Changed property type (object)
  The type of LAG protocol, such as static or LACP (Link Aggregation Control Protocol).
- Changed property untaggedVlan (object)
  The VLAN identifier for untagged traffic on this LAG interface.

Changed response : 400 Bad Request

Bad/malformed request

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 401 Unauthorized

Unauthorized

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 403 Forbidden

Forbidden

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 404 Not Found

Requested resource or related entity not found

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 422 Unprocessable Entity

Validation error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 500 Internal Server Error

Internal Server Error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

GET /switches/{switchId}/staticRoutes

Return Type:

Changed response : 200 OK

OK

Changed content type : application/json
New required properties:
- destinationIp
- nextHop
- Changed property adminDistance (object)
  The administrative distance value for route preference, with lower values having higher priority.
- Changed property destinationIp (object)
  The destination IP address in CIDR notation. For IPv4: '192.168.10.0/24', For IPv6: '2001:db8::/32'.
- Changed property id (object)
  The unique identifier of the static route configuration.
- Changed property nextHop (object)
  The IP address of the next hop gateway to route traffic. For IPv4: '192.168.1.1', For IPv6: '2001:db8::1'.
- Changed property staticRouteViewList (object)
  The list of static route configurations for batch operations or nested route management.
Changed content type : application/vnd.ruckus.v1+json
New required properties:
- destinationIp
- nextHop
- Changed property adminDistance (object)
  The administrative distance value for route preference, with lower values having higher priority.
- Changed property destinationIp (object)
  The destination IP address in CIDR notation. For IPv4: '192.168.10.0/24', For IPv6: '2001:db8::/32'.
- Changed property id (object)
  The unique identifier of the static route configuration.
- Changed property nextHop (object)
  The IP address of the next hop gateway to route traffic. For IPv4: '192.168.1.1', For IPv6: '2001:db8::1'.
- Changed property staticRouteViewList (object)
  The list of static route configurations for batch operations or nested route management.

Changed response : 400 Bad Request

Bad/malformed request

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 401 Unauthorized

Unauthorized

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 403 Forbidden

Forbidden

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 404 Not Found

Requested resource or related entity not found

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 422 Unprocessable Entity

Validation error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 500 Internal Server Error

Internal Server Error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

POST /switches/{switchId}/staticRoutes

Return Type:

Changed response : 200 OK

OK

Changed content type : application/json
New required properties:
- destinationIp
- nextHop
- Changed property adminDistance (object)
  The administrative distance value for route preference, with lower values having higher priority.
- Changed property destinationIp (object)
  The destination IP address in CIDR notation. For IPv4: '192.168.10.0/24', For IPv6: '2001:db8::/32'.
- Changed property id (object)
  The unique identifier of the static route configuration.
- Changed property nextHop (object)
  The IP address of the next hop gateway to route traffic. For IPv4: '192.168.1.1', For IPv6: '2001:db8::1'.
- Changed property staticRouteViewList (object)
  The list of static route configurations for batch operations or nested route management.
Changed content type : application/vnd.ruckus.v1+json
New required properties:
- destinationIp
- nextHop
- Changed property adminDistance (object)
  The administrative distance value for route preference, with lower values having higher priority.
- Changed property destinationIp (object)
  The destination IP address in CIDR notation. For IPv4: '192.168.10.0/24', For IPv6: '2001:db8::/32'.
- Changed property id (object)
  The unique identifier of the static route configuration.
- Changed property nextHop (object)
  The IP address of the next hop gateway to route traffic. For IPv4: '192.168.1.1', For IPv6: '2001:db8::1'.
- Changed property staticRouteViewList (object)
  The list of static route configurations for batch operations or nested route management.

Changed response : 400 Bad Request

Bad/malformed request

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 401 Unauthorized

Unauthorized

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 403 Forbidden

Forbidden

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 404 Not Found

Requested resource or related entity not found

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 422 Unprocessable Entity

Validation error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 500 Internal Server Error

Internal Server Error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

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

Return Type:

Changed response : 200 OK

OK

Changed content type : application/json
- Changed property id (object)
  The identifier
- Changed property list (object)
  The list of configuration history information records containing deployment details and status.
- Changed property totalCount (object)
  The total number of configuration history records matching the query criteria.
Changed content type : application/vnd.ruckus.v1+json
- Changed property id (object)
  The identifier
- Changed property list (object)
  The list of configuration history information records containing deployment details and status.
- Changed property totalCount (object)
  The total number of configuration history records matching the query criteria.

Changed response : 400 Bad Request

Bad/malformed request

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 401 Unauthorized

Unauthorized

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 403 Forbidden

Forbidden

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 404 Not Found

Requested resource or related entity not found

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 422 Unprocessable Entity

Validation error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 500 Internal Server Error

Internal Server Error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

GET /switches/{switchId}/vePorts

Return Type:

Changed response : 200 OK

OK

Changed content type : application/json
- Changed property connectedVe (object)
  The flag indicating whether this VE interface is connected and operational.
- Changed property defaultVlan (object)
  The flag indicating whether this is the default VLAN for the switch (deprecated, use connectedVe instead).
- Changed property deviceStatus (object)
  The operational status of the device associated with this VE interface.
- Changed property dhcpRelayAgent (object)
  The IP address of the DHCP relay agent for forwarding DHCP requests across subnets.
- Changed property egressAclName (object)
  The name of the Access Control List applied to egress (outgoing) traffic on this VE interface.
- Changed property id (object)
  The identifier
- Changed property ingressAclName (object)
  The name of the Access Control List applied to ingress (incoming) traffic on this VE interface.
- Changed property ipAddress (object)
  The IPv4 address assigned to this virtual ethernet interface.
- Changed property ipAddressType (object)
  The IP address assignment method for this VE interface: static or dynamic.
- Changed property ipSubnetMask (object)
  The subnet mask for the IP address of this virtual ethernet interface.
- Changed property name (object)
  The descriptive name assigned to the virtual ethernet interface.
- Changed property ospfArea (object)
  The OSPF area identifier for routing protocol configuration on this VE interface.
- Changed property portType (object)
  The type of port associated with this VE interface.
- Changed property stack (object)
  The flag indicating whether the switch is configured in a stack.
- Changed property switchId (object)
  The identifier of the switch where this VE interface is configured.
- Changed property switchName (object)
  The name of the switch where this VE interface is configured.
- Changed property syncedSwitchConfig (object)
  The flag indicating whether the VE interface configuration has been synchronized with the switch.
- Changed property tenantId (object)
  The unique identifier of the tenant.
- Changed property veId (object)
  The virtual ethernet interface identifier, used as the VE interface number.
- Changed property vePortViewList (object)
  The list of VE port configurations for batch operations or nested VE management.
- Changed property vlanId (object)
  The VLAN ID associated with this virtual ethernet interface for layer 3 routing.
- Changed property vsixEgressAclName (object)
  The name of the VSIX ACL applied to egress traffic for virtual switch integration.
- Changed property vsixIngressAclName (object)
  The name of the VSIX ACL applied to ingress traffic for virtual switch integration.
Changed content type : application/vnd.ruckus.v1+json
- Changed property connectedVe (object)
  The flag indicating whether this VE interface is connected and operational.
- Changed property defaultVlan (object)
  The flag indicating whether this is the default VLAN for the switch (deprecated, use connectedVe instead).
- Changed property deviceStatus (object)
  The operational status of the device associated with this VE interface.
- Changed property dhcpRelayAgent (object)
  The IP address of the DHCP relay agent for forwarding DHCP requests across subnets.
- Changed property egressAclName (object)
  The name of the Access Control List applied to egress (outgoing) traffic on this VE interface.
- Changed property id (object)
  The identifier
- Changed property ingressAclName (object)
  The name of the Access Control List applied to ingress (incoming) traffic on this VE interface.
- Changed property ipAddress (object)
  The IPv4 address assigned to this virtual ethernet interface.
- Changed property ipAddressType (object)
  The IP address assignment method for this VE interface: static or dynamic.
- Changed property ipSubnetMask (object)
  The subnet mask for the IP address of this virtual ethernet interface.
- Changed property name (object)
  The descriptive name assigned to the virtual ethernet interface.
- Changed property ospfArea (object)
  The OSPF area identifier for routing protocol configuration on this VE interface.
- Changed property portType (object)
  The type of port associated with this VE interface.
- Changed property stack (object)
  The flag indicating whether the switch is configured in a stack.
- Changed property switchId (object)
  The identifier of the switch where this VE interface is configured.
- Changed property switchName (object)
  The name of the switch where this VE interface is configured.
- Changed property syncedSwitchConfig (object)
  The flag indicating whether the VE interface configuration has been synchronized with the switch.
- Changed property tenantId (object)
  The unique identifier of the tenant.
- Changed property veId (object)
  The virtual ethernet interface identifier, used as the VE interface number.
- Changed property vePortViewList (object)
  The list of VE port configurations for batch operations or nested VE management.
- Changed property vlanId (object)
  The VLAN ID associated with this virtual ethernet interface for layer 3 routing.
- Changed property vsixEgressAclName (object)
  The name of the VSIX ACL applied to egress traffic for virtual switch integration.
- Changed property vsixIngressAclName (object)
  The name of the VSIX ACL applied to ingress traffic for virtual switch integration.

Changed response : 400 Bad Request

Bad/malformed request

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 401 Unauthorized

Unauthorized

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 403 Forbidden

Forbidden

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 404 Not Found

Requested resource or related entity not found

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 422 Unprocessable Entity

Validation error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 500 Internal Server Error

Internal Server Error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

POST /switches/{switchId}/vePorts

Return Type:

Changed response : 200 OK

OK

Changed content type : application/json
- Changed property connectedVe (object)
  The flag indicating whether this VE interface is connected and operational.
- Changed property defaultVlan (object)
  The flag indicating whether this is the default VLAN for the switch (deprecated, use connectedVe instead).
- Changed property deviceStatus (object)
  The operational status of the device associated with this VE interface.
- Changed property dhcpRelayAgent (object)
  The IP address of the DHCP relay agent for forwarding DHCP requests across subnets.
- Changed property egressAclName (object)
  The name of the Access Control List applied to egress (outgoing) traffic on this VE interface.
- Changed property id (object)
  The identifier
- Changed property ingressAclName (object)
  The name of the Access Control List applied to ingress (incoming) traffic on this VE interface.
- Changed property ipAddress (object)
  The IPv4 address assigned to this virtual ethernet interface.
- Changed property ipAddressType (object)
  The IP address assignment method for this VE interface: static or dynamic.
- Changed property ipSubnetMask (object)
  The subnet mask for the IP address of this virtual ethernet interface.
- Changed property name (object)
  The descriptive name assigned to the virtual ethernet interface.
- Changed property ospfArea (object)
  The OSPF area identifier for routing protocol configuration on this VE interface.
- Changed property portType (object)
  The type of port associated with this VE interface.
- Changed property stack (object)
  The flag indicating whether the switch is configured in a stack.
- Changed property switchId (object)
  The identifier of the switch where this VE interface is configured.
- Changed property switchName (object)
  The name of the switch where this VE interface is configured.
- Changed property syncedSwitchConfig (object)
  The flag indicating whether the VE interface configuration has been synchronized with the switch.
- Changed property tenantId (object)
  The unique identifier of the tenant.
- Changed property veId (object)
  The virtual ethernet interface identifier, used as the VE interface number.
- Changed property vePortViewList (object)
  The list of VE port configurations for batch operations or nested VE management.
- Changed property vlanId (object)
  The VLAN ID associated with this virtual ethernet interface for layer 3 routing.
- Changed property vsixEgressAclName (object)
  The name of the VSIX ACL applied to egress traffic for virtual switch integration.
- Changed property vsixIngressAclName (object)
  The name of the VSIX ACL applied to ingress traffic for virtual switch integration.
Changed content type : application/vnd.ruckus.v1+json
- Changed property connectedVe (object)
  The flag indicating whether this VE interface is connected and operational.
- Changed property defaultVlan (object)
  The flag indicating whether this is the default VLAN for the switch (deprecated, use connectedVe instead).
- Changed property deviceStatus (object)
  The operational status of the device associated with this VE interface.
- Changed property dhcpRelayAgent (object)
  The IP address of the DHCP relay agent for forwarding DHCP requests across subnets.
- Changed property egressAclName (object)
  The name of the Access Control List applied to egress (outgoing) traffic on this VE interface.
- Changed property id (object)
  The identifier
- Changed property ingressAclName (object)
  The name of the Access Control List applied to ingress (incoming) traffic on this VE interface.
- Changed property ipAddress (object)
  The IPv4 address assigned to this virtual ethernet interface.
- Changed property ipAddressType (object)
  The IP address assignment method for this VE interface: static or dynamic.
- Changed property ipSubnetMask (object)
  The subnet mask for the IP address of this virtual ethernet interface.
- Changed property name (object)
  The descriptive name assigned to the virtual ethernet interface.
- Changed property ospfArea (object)
  The OSPF area identifier for routing protocol configuration on this VE interface.
- Changed property portType (object)
  The type of port associated with this VE interface.
- Changed property stack (object)
  The flag indicating whether the switch is configured in a stack.
- Changed property switchId (object)
  The identifier of the switch where this VE interface is configured.
- Changed property switchName (object)
  The name of the switch where this VE interface is configured.
- Changed property syncedSwitchConfig (object)
  The flag indicating whether the VE interface configuration has been synchronized with the switch.
- Changed property tenantId (object)
  The unique identifier of the tenant.
- Changed property veId (object)
  The virtual ethernet interface identifier, used as the VE interface number.
- Changed property vePortViewList (object)
  The list of VE port configurations for batch operations or nested VE management.
- Changed property vlanId (object)
  The VLAN ID associated with this virtual ethernet interface for layer 3 routing.
- Changed property vsixEgressAclName (object)
  The name of the VSIX ACL applied to egress traffic for virtual switch integration.
- Changed property vsixIngressAclName (object)
  The name of the VSIX ACL applied to ingress traffic for virtual switch integration.

Changed response : 400 Bad Request

Bad/malformed request

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 401 Unauthorized

Unauthorized

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 403 Forbidden

Forbidden

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 404 Not Found

Requested resource or related entity not found

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 422 Unprocessable Entity

Validation error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 500 Internal Server Error

Internal Server Error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

POST /switches/{switchId}/vePorts/query

Request:

Changed content type : application/json

Changed property fields (object)
The list of field names to include in the query response, allowing clients to request only specific fields.
Changed property filterType (object)
The dynamic filter type (deprecated, use filters instead).
Changed property filters (object)
The dynamic filter map where keys are field names and values are lists of filter criteria to apply for each field.
Changed property page (object)
The page number for pagination, starting from 1, defaulting to 1.
Changed property pageSize (object)
The number of records to return per page, defaulting to 25.
Changed property sortField (object)
The field name to use for sorting the query results.
Changed property sortOrder (object)
The sort order direction for the query results, either ascending or descending, defaulting to ascending.

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

Changed property fields (object)
The list of field names to include in the query response, allowing clients to request only specific fields.
Changed property filterType (object)
The dynamic filter type (deprecated, use filters instead).
Changed property filters (object)
The dynamic filter map where keys are field names and values are lists of filter criteria to apply for each field.
Changed property page (object)
The page number for pagination, starting from 1, defaulting to 1.
Changed property pageSize (object)
The number of records to return per page, defaulting to 25.
Changed property sortField (object)
The field name to use for sorting the query results.
Changed property sortOrder (object)
The sort order direction for the query results, either ascending or descending, defaulting to ascending.

Return Type:

Changed response : 200 OK

OK

Changed content type : application/json
- Changed property data (object)
  The list of data records returned by the query, with each item representing a result object.
- Changed property fields (object)
  The list of field names included in the query response data.
- Changed property page (object)
  The current page number of the paginated results.
- Changed property totalCount (object)
  The total number of records matching the query criteria across all pages.
- Changed property totalPages (object)
  The total number of pages available based on the page size and total record count.
Changed content type : application/vnd.ruckus.v1+json
- Changed property data (object)
  The list of data records returned by the query, with each item representing a result object.
- Changed property fields (object)
  The list of field names included in the query response data.
- Changed property page (object)
  The current page number of the paginated results.
- Changed property totalCount (object)
  The total number of records matching the query criteria across all pages.
- Changed property totalPages (object)
  The total number of pages available based on the page size and total record count.

Changed response : 400 Bad Request

Bad/malformed request

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 401 Unauthorized

Unauthorized

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 403 Forbidden

Forbidden

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 404 Not Found

Requested resource or related entity not found

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 422 Unprocessable Entity

Validation error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 500 Internal Server Error

Internal Server Error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

GET /switches/{switchId}/vlanUnions

Return Type:

Changed response : 200 OK

OK

Changed content type : application/json
- Changed property profileVlan (object)
  The list of VLAN configurations defined in port profiles.
- Changed property switchDefaultVlan (object)
  The list of switch default VLAN configurations, representing the native VLAN settings on switches.
- Changed property switchVlan (object)
  The list of VLAN configurations directly assigned to switches.
Changed content type : application/vnd.ruckus.v1+json
- Changed property profileVlan (object)
  The list of VLAN configurations defined in port profiles.
- Changed property switchDefaultVlan (object)
  The list of switch default VLAN configurations, representing the native VLAN settings on switches.
- Changed property switchVlan (object)
  The list of VLAN configurations directly assigned to switches.

Changed response : 400 Bad Request

Bad/malformed request

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 401 Unauthorized

Unauthorized

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 403 Forbidden

Forbidden

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 404 Not Found

Requested resource or related entity not found

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 422 Unprocessable Entity

Validation error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 500 Internal Server Error

Internal Server Error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

POST /switches/{switchId}/vlans/query

Request:

Changed content type : application/json

Changed property fields (object)
The list of field names to include in the query response, allowing clients to request only specific fields.
Changed property filterType (object)
The dynamic filter type (deprecated, use filters instead).
Changed property filters (object)
The dynamic filter map where keys are field names and values are lists of filter criteria to apply for each field.
Changed property page (object)
The page number for pagination, starting from 1, defaulting to 1.
Changed property pageSize (object)
The number of records to return per page, defaulting to 25.
Changed property searchString (object)
The search string for full text search across the specified target fields.
Changed property searchTargetFields (object)
The list of field names to search within when applying the search string.
Changed property sortField (object)
The field name to use for sorting the query results.
Changed property sortOrder (object)
The sort order direction for the query results, either ascending or descending, defaulting to ascending.

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

Changed property fields (object)
The list of field names to include in the query response, allowing clients to request only specific fields.
Changed property filterType (object)
The dynamic filter type (deprecated, use filters instead).
Changed property filters (object)
The dynamic filter map where keys are field names and values are lists of filter criteria to apply for each field.
Changed property page (object)
The page number for pagination, starting from 1, defaulting to 1.
Changed property pageSize (object)
The number of records to return per page, defaulting to 25.
Changed property searchString (object)
The search string for full text search across the specified target fields.
Changed property searchTargetFields (object)
The list of field names to search within when applying the search string.
Changed property sortField (object)
The field name to use for sorting the query results.
Changed property sortOrder (object)
The sort order direction for the query results, either ascending or descending, defaulting to ascending.

Return Type:

Changed response : 200 OK

OK

Changed content type : application/json
- Changed property data (object)
  The list of data records returned by the query, with each item representing a result object.
- Changed property fields (object)
  The list of field names included in the query response data.
- Changed property page (object)
  The current page number of the paginated results.
- Changed property totalCount (object)
  The total number of records matching the query criteria across all pages.
- Changed property totalPages (object)
  The total number of pages available based on the page size and total record count.
Changed content type : application/vnd.ruckus.v1+json
- Changed property data (object)
  The list of data records returned by the query, with each item representing a result object.
- Changed property fields (object)
  The list of field names included in the query response data.
- Changed property page (object)
  The current page number of the paginated results.
- Changed property totalCount (object)
  The total number of records matching the query criteria across all pages.
- Changed property totalPages (object)
  The total number of pages available based on the page size and total record count.

Changed response : 400 Bad Request

Bad/malformed request

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 401 Unauthorized

Unauthorized

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 403 Forbidden

Forbidden

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 404 Not Found

Requested resource or related entity not found

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 422 Unprocessable Entity

Validation error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 500 Internal Server Error

Internal Server Error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

POST /templates/switchProfiles/query

Request:

Changed content type : application/json

Changed property fields (object)
The list of field names to include in the query response, allowing clients to request only specific fields.
Changed property filterType (object)
The dynamic filter type (deprecated, use filters instead).
Changed property filters (object)
The dynamic filter map where keys are field names and values are lists of filter criteria to apply for each field.
Changed property page (object)
The page number for pagination, starting from 1, defaulting to 1.
Changed property pageSize (object)
The number of records to return per page, defaulting to 25.
Changed property searchString (object)
The search string for full text search across the specified target fields.
Changed property searchTargetFields (object)
The list of field names to search within when applying the search string.
Changed property sortField (object)
The field name to use for sorting the query results.
Changed property sortOrder (object)
The sort order direction for the query results, either ascending or descending, defaulting to ascending.

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

Changed property fields (object)
The list of field names to include in the query response, allowing clients to request only specific fields.
Changed property filterType (object)
The dynamic filter type (deprecated, use filters instead).
Changed property filters (object)
The dynamic filter map where keys are field names and values are lists of filter criteria to apply for each field.
Changed property page (object)
The page number for pagination, starting from 1, defaulting to 1.
Changed property pageSize (object)
The number of records to return per page, defaulting to 25.
Changed property searchString (object)
The search string for full text search across the specified target fields.
Changed property searchTargetFields (object)
The list of field names to search within when applying the search string.
Changed property sortField (object)
The field name to use for sorting the query results.
Changed property sortOrder (object)
The sort order direction for the query results, either ascending or descending, defaulting to ascending.

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

Changed property fields (object)
The list of field names to include in the query response, allowing clients to request only specific fields.
Changed property filterType (object)
The dynamic filter type (deprecated, use filters instead).
Changed property filters (object)
The dynamic filter map where keys are field names and values are lists of filter criteria to apply for each field.
Changed property page (object)
The page number for pagination, starting from 1, defaulting to 1.
Changed property pageSize (object)
The number of records to return per page, defaulting to 25.
Changed property searchString (object)
The search string for full text search across the specified target fields.
Changed property searchTargetFields (object)
The list of field names to search within when applying the search string.
Changed property sortField (object)
The field name to use for sorting the query results.
Changed property sortOrder (object)
The sort order direction for the query results, either ascending or descending, defaulting to ascending.

Return Type:

Changed response : 200 OK

OK

Changed content type : application/json
- Changed property data (object)
  The list of data records returned by the query, with each item representing a result object.
- Changed property fields (object)
  The list of field names included in the query response data.
- Changed property page (object)
  The current page number of the paginated results.
- Changed property totalCount (object)
  The total number of records matching the query criteria across all pages.
- Changed property totalPages (object)
  The total number of pages available based on the page size and total record count.
Changed content type : application/vnd.ruckus.v1+json
- Changed property data (object)
  The list of data records returned by the query, with each item representing a result object.
- Changed property fields (object)
  The list of field names included in the query response data.
- Changed property page (object)
  The current page number of the paginated results.
- Changed property totalCount (object)
  The total number of records matching the query criteria across all pages.
- Changed property totalPages (object)
  The total number of pages available based on the page size and total record count.
Changed content type : application/vnd.ruckus.v1.1+json
- Changed property data (object)
  The list of data records returned by the query, with each item representing a result object.
- Changed property fields (object)
  The list of field names included in the query response data.
- Changed property page (object)
  The current page number of the paginated results.
- Changed property totalCount (object)
  The total number of records matching the query criteria across all pages.
- Changed property totalPages (object)
  The total number of pages available based on the page size and total record count.

Changed response : 400 Bad Request

Bad/malformed request

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 401 Unauthorized

Unauthorized

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 403 Forbidden

Forbidden

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 404 Not Found

Requested resource or related entity not found

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 422 Unprocessable Entity

Validation error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 500 Internal Server Error

Internal Server Error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

POST /templates/venues/aaaServers/query

Request:

Changed content type : application/json

Changed property fields (object)
The list of field names to include in the query response, allowing clients to request only specific fields.
Changed property page (object)
The page number for pagination, starting from 1, defaulting to 1.
Changed property pageSize (object)
The number of records to return per page, defaulting to 25.
Changed property serverType (object)
The type of AAA server to filter by, with the default value set to LOCAL if not specified.
Changed property sortField (object)
The field name to use for sorting the query results.
Changed property sortOrder (object)
The sort order direction for the query results, either ascending or descending, defaulting to ascending.
Changed property venueId (object)
The venue identifier to filter AAA servers by specific venue location.

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

Changed property fields (object)
The list of field names to include in the query response, allowing clients to request only specific fields.
Changed property page (object)
The page number for pagination, starting from 1, defaulting to 1.
Changed property pageSize (object)
The number of records to return per page, defaulting to 25.
Changed property serverType (object)
The type of AAA server to filter by, with the default value set to LOCAL if not specified.
Changed property sortField (object)
The field name to use for sorting the query results.
Changed property sortOrder (object)
The sort order direction for the query results, either ascending or descending, defaulting to ascending.
Changed property venueId (object)
The venue identifier to filter AAA servers by specific venue location.

Return Type:

Changed response : 200 OK

OK

Changed content type : application/json
- Changed property data (object)
  The list of data records returned by the query, with each item representing a result object.
- Changed property fields (object)
  The list of field names included in the query response data.
- Changed property page (object)
  The current page number of the paginated results.
- Changed property totalCount (object)
  The total number of records matching the query criteria across all pages.
- Changed property totalPages (object)
  The total number of pages available based on the page size and total record count.
Changed content type : application/vnd.ruckus.v1+json
- Changed property data (object)
  The list of data records returned by the query, with each item representing a result object.
- Changed property fields (object)
  The list of field names included in the query response data.
- Changed property page (object)
  The current page number of the paginated results.
- Changed property totalCount (object)
  The total number of records matching the query criteria across all pages.
- Changed property totalPages (object)
  The total number of pages available based on the page size and total record count.

Changed response : 400 Bad Request

Bad/malformed request

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 401 Unauthorized

Unauthorized

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 403 Forbidden

Forbidden

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 404 Not Found

Requested resource or related entity not found

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 422 Unprocessable Entity

Validation error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 500 Internal Server Error

Internal Server Error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

POST /templates/venues/{venueId}/aaaServers/query

Request:

Changed content type : application/json

Changed property fields (object)
The list of field names to include in the query response, allowing clients to request only specific fields.
Changed property page (object)
The page number for pagination, starting from 1, defaulting to 1.
Changed property pageSize (object)
The number of records to return per page, defaulting to 25.
Changed property serverType (object)
The type of AAA server to filter by, with the default value set to LOCAL if not specified.
Changed property sortField (object)
The field name to use for sorting the query results.
Changed property sortOrder (object)
The sort order direction for the query results, either ascending or descending, defaulting to ascending.

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

Changed property fields (object)
The list of field names to include in the query response, allowing clients to request only specific fields.
Changed property page (object)
The page number for pagination, starting from 1, defaulting to 1.
Changed property pageSize (object)
The number of records to return per page, defaulting to 25.
Changed property serverType (object)
The type of AAA server to filter by, with the default value set to LOCAL if not specified.
Changed property sortField (object)
The field name to use for sorting the query results.
Changed property sortOrder (object)
The sort order direction for the query results, either ascending or descending, defaulting to ascending.

Return Type:

Changed response : 200 OK

OK

Changed content type : application/json
- Changed property data (object)
  The list of data records returned by the query, with each item representing a result object.
- Changed property fields (object)
  The list of field names included in the query response data.
- Changed property page (object)
  The current page number of the paginated results.
- Changed property totalCount (object)
  The total number of records matching the query criteria across all pages.
- Changed property totalPages (object)
  The total number of pages available based on the page size and total record count.
Changed content type : application/vnd.ruckus.v1+json
- Changed property data (object)
  The list of data records returned by the query, with each item representing a result object.
- Changed property fields (object)
  The list of field names included in the query response data.
- Changed property page (object)
  The current page number of the paginated results.
- Changed property totalCount (object)
  The total number of records matching the query criteria across all pages.
- Changed property totalPages (object)
  The total number of pages available based on the page size and total record count.

Changed response : 400 Bad Request

Bad/malformed request

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 401 Unauthorized

Unauthorized

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 403 Forbidden

Forbidden

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 404 Not Found

Requested resource or related entity not found

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 422 Unprocessable Entity

Validation error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 500 Internal Server Error

Internal Server Error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

POST /venues/aaaServers/query

Request:

Changed content type : application/json

Changed property fields (object)
The list of field names to include in the query response, allowing clients to request only specific fields.
Changed property page (object)
The page number for pagination, starting from 1, defaulting to 1.
Changed property pageSize (object)
The number of records to return per page, defaulting to 25.
Changed property serverType (object)
The type of AAA server to filter by, with the default value set to LOCAL if not specified.
Changed property sortField (object)
The field name to use for sorting the query results.
Changed property sortOrder (object)
The sort order direction for the query results, either ascending or descending, defaulting to ascending.
Changed property venueId (object)
The venue identifier to filter AAA servers by specific venue location.

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

Changed property fields (object)
The list of field names to include in the query response, allowing clients to request only specific fields.
Changed property page (object)
The page number for pagination, starting from 1, defaulting to 1.
Changed property pageSize (object)
The number of records to return per page, defaulting to 25.
Changed property serverType (object)
The type of AAA server to filter by, with the default value set to LOCAL if not specified.
Changed property sortField (object)
The field name to use for sorting the query results.
Changed property sortOrder (object)
The sort order direction for the query results, either ascending or descending, defaulting to ascending.
Changed property venueId (object)
The venue identifier to filter AAA servers by specific venue location.

Return Type:

Changed response : 200 OK

OK

Changed content type : application/json
- Changed property data (object)
  The list of data records returned by the query, with each item representing a result object.
- Changed property fields (object)
  The list of field names included in the query response data.
- Changed property page (object)
  The current page number of the paginated results.
- Changed property totalCount (object)
  The total number of records matching the query criteria across all pages.
- Changed property totalPages (object)
  The total number of pages available based on the page size and total record count.
Changed content type : application/vnd.ruckus.v1+json
- Changed property data (object)
  The list of data records returned by the query, with each item representing a result object.
- Changed property fields (object)
  The list of field names included in the query response data.
- Changed property page (object)
  The current page number of the paginated results.
- Changed property totalCount (object)
  The total number of records matching the query criteria across all pages.
- Changed property totalPages (object)
  The total number of pages available based on the page size and total record count.

Changed response : 400 Bad Request

Bad/malformed request

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 401 Unauthorized

Unauthorized

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 403 Forbidden

Forbidden

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 404 Not Found

Requested resource or related entity not found

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 422 Unprocessable Entity

Validation error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 500 Internal Server Error

Internal Server Error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

GET /venues/switchFirmwares/currentVersions

Return Type:

Changed response : 200 OK

OK

Changed content type : application/json
- Changed property currentVersions (object)
  The list of firmware versions currently running on switches with version numbers below 10.0.0 in this venue.
- Changed property currentVersionsAboveTen (object)
  The list of firmware versions currently running on switches with version numbers 10.0.0 and above in this venue.
- Changed property id (object)
  The identifier
Changed content type : application/vnd.ruckus.v1+json
- Changed property currentVersions (object)
  The list of firmware versions currently running on switches with version numbers below 10.0.0 in this venue.
- Changed property currentVersionsAboveTen (object)
  The list of firmware versions currently running on switches with version numbers 10.0.0 and above in this venue.
- Changed property id (object)
  The identifier

Changed response : 400 Bad Request

Bad/malformed request

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 401 Unauthorized

Unauthorized

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 403 Forbidden

Forbidden

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 404 Not Found

Requested resource or related entity not found

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 422 Unprocessable Entity

Validation error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 500 Internal Server Error

Internal Server Error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

POST /venues/switchFirmwares/schedules

Request:

Changed content type : application/json

Changed property date (object)
The new scheduled date for the firmware upgrade in string format.
Changed property id (object)
The identifier
Changed property preDownload (object)
The flag indicating whether firmware pre download should be enabled before the scheduled upgrade.
Changed property switchIds (object)
The list of switch identifiers affected by this schedule change.
Changed property switchVersion (object)
The target firmware version for switches with version numbers below 10.0.0.
Changed property switchVersionAboveTen (object)
The target firmware version for switches with version numbers 10.0.0 and above.
Changed property time (object)
The new scheduled time for the firmware upgrade in string format.
Changed property venueIds (object)
The list of venue identifiers affected by this schedule change.

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

Changed property date (object)
The new scheduled date for the firmware upgrade in string format.
Changed property id (object)
The identifier
Changed property preDownload (object)
The flag indicating whether firmware pre download should be enabled before the scheduled upgrade.
Changed property switchIds (object)
The list of switch identifiers affected by this schedule change.
Changed property switchVersion (object)
The target firmware version for switches with version numbers below 10.0.0.
Changed property switchVersionAboveTen (object)
The target firmware version for switches with version numbers 10.0.0 and above.
Changed property time (object)
The new scheduled time for the firmware upgrade in string format.
Changed property venueIds (object)
The list of venue identifiers affected by this schedule change.

Return Type:

Changed response : 200 OK

OK

Changed content type : application/json
- Changed property response (object)
  The response data containing the result of the operation.
Changed content type : application/vnd.ruckus.v1+json
- Changed property response (object)
  The response data containing the result of the operation.

Changed response : 400 Bad Request

Bad/malformed request

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 401 Unauthorized

Unauthorized

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 403 Forbidden

Forbidden

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 404 Not Found

Requested resource or related entity not found

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 422 Unprocessable Entity

Validation error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 500 Internal Server Error

Internal Server Error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

DELETE /venues/switchFirmwares/schedules

Request:

Changed content type : application/json

Changed property id (object)
The identifier
Changed property switchIds (object)
The list of switch identifiers for which the scheduled firmware upgrade should be skipped.
Changed property venueIds (object)
The list of venue identifiers for which the scheduled firmware upgrade should be skipped.

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

Changed property id (object)
The identifier
Changed property switchIds (object)
The list of switch identifiers for which the scheduled firmware upgrade should be skipped.
Changed property venueIds (object)
The list of venue identifiers for which the scheduled firmware upgrade should be skipped.

Return Type:

Changed response : 200 OK

OK

Changed content type : application/json
- Changed property response (object)
  The response data containing the result of the operation.
Changed content type : application/vnd.ruckus.v1+json
- Changed property response (object)
  The response data containing the result of the operation.

Changed response : 400 Bad Request

Bad/malformed request

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 401 Unauthorized

Unauthorized

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 403 Forbidden

Forbidden

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 404 Not Found

Requested resource or related entity not found

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 422 Unprocessable Entity

Validation error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 500 Internal Server Error

Internal Server Error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

POST /venues/switchFirmwares/upgradeStatusDetails/query

Request:

Changed content type : application/json

Changed property venueId (object)
The identifier of venue.

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

Changed property venueId (object)
The identifier of venue.

Return Type:

Changed response : 200 OK

OK

Changed content type : application/json
- Changed property id (object)
  The identifier
- Changed property lastStatusUpdateTime (object)
  The timestamp of the last status update for this upgrade process.
- Changed property status (object)
  The current status of the firmware upgrade process.
- Changed property switchId (object)
  The unique identifier of the switch being upgraded.
- Changed property switchName (object)
  The name of the switch being upgraded.
- Changed property switchStatus (object)
  The operational status of the switch during the upgrade.
- Changed property targetFirmware (object)
  The target firmware version for this upgrade.
- Changed property upgradeStatusDetailsViewList (object)
  The list of upgrade status details for batch operations or nested status tracking.
Changed content type : application/vnd.ruckus.v1+json
- Changed property id (object)
  The identifier
- Changed property lastStatusUpdateTime (object)
  The timestamp of the last status update for this upgrade process.
- Changed property status (object)
  The current status of the firmware upgrade process.
- Changed property switchId (object)
  The unique identifier of the switch being upgraded.
- Changed property switchName (object)
  The name of the switch being upgraded.
- Changed property switchStatus (object)
  The operational status of the switch during the upgrade.
- Changed property targetFirmware (object)
  The target firmware version for this upgrade.
- Changed property upgradeStatusDetailsViewList (object)
  The list of upgrade status details for batch operations or nested status tracking.

Changed response : 400 Bad Request

Bad/malformed request

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 401 Unauthorized

Unauthorized

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 403 Forbidden

Forbidden

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 404 Not Found

Requested resource or related entity not found

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 422 Unprocessable Entity

Validation error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 500 Internal Server Error

Internal Server Error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

GET /venues/switchFirmwares/versions/{versionType}

Return Type:

Changed response : 200 OK

OK

Changed content type : application/json
- Changed property category (object)
  The category classification of the firmware version.
- Changed property createdDate (object)
  The date when this firmware version was released or created.
- Changed property id (object)
  The identifier
- Changed property name (object)
  The firmware version name or number.
Changed content type : application/vnd.ruckus.v1+json
- Changed property category (object)
  The category classification of the firmware version.
- Changed property createdDate (object)
  The date when this firmware version was released or created.
- Changed property id (object)
  The identifier
- Changed property name (object)
  The firmware version name or number.

Changed response : 400 Bad Request

Bad/malformed request

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 401 Unauthorized

Unauthorized

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 403 Forbidden

Forbidden

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 404 Not Found

Requested resource or related entity not found

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 422 Unprocessable Entity

Validation error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 500 Internal Server Error

Internal Server Error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

POST /venues/{venueId}/aaaServers/query

Request:

Changed content type : application/json

Changed property fields (object)
The list of field names to include in the query response, allowing clients to request only specific fields.
Changed property page (object)
The page number for pagination, starting from 1, defaulting to 1.
Changed property pageSize (object)
The number of records to return per page, defaulting to 25.
Changed property serverType (object)
The type of AAA server to filter by, with the default value set to LOCAL if not specified.
Changed property sortField (object)
The field name to use for sorting the query results.
Changed property sortOrder (object)
The sort order direction for the query results, either ascending or descending, defaulting to ascending.

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

Changed property fields (object)
The list of field names to include in the query response, allowing clients to request only specific fields.
Changed property page (object)
The page number for pagination, starting from 1, defaulting to 1.
Changed property pageSize (object)
The number of records to return per page, defaulting to 25.
Changed property serverType (object)
The type of AAA server to filter by, with the default value set to LOCAL if not specified.
Changed property sortField (object)
The field name to use for sorting the query results.
Changed property sortOrder (object)
The sort order direction for the query results, either ascending or descending, defaulting to ascending.

Return Type:

Changed response : 200 OK

OK

Changed content type : application/json
- Changed property data (object)
  The list of data records returned by the query, with each item representing a result object.
- Changed property fields (object)
  The list of field names included in the query response data.
- Changed property page (object)
  The current page number of the paginated results.
- Changed property totalCount (object)
  The total number of records matching the query criteria across all pages.
- Changed property totalPages (object)
  The total number of pages available based on the page size and total record count.
Changed content type : application/vnd.ruckus.v1+json
- Changed property data (object)
  The list of data records returned by the query, with each item representing a result object.
- Changed property fields (object)
  The list of field names included in the query response data.
- Changed property page (object)
  The current page number of the paginated results.
- Changed property totalCount (object)
  The total number of records matching the query criteria across all pages.
- Changed property totalPages (object)
  The total number of pages available based on the page size and total record count.

Changed response : 400 Bad Request

Bad/malformed request

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 401 Unauthorized

Unauthorized

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 403 Forbidden

Forbidden

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 404 Not Found

Requested resource or related entity not found

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 422 Unprocessable Entity

Validation error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 500 Internal Server Error

Internal Server Error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

GET /venues/{venueId}/switchProfiles/acls

Return Type:

Changed response : 200 OK

OK

Changed content type : application/json
- Changed property aclRules (object)
  The set of rules associated with this ACL, defining the filtering criteria and actions to be taken.
- Changed property aclType (object)
  The type of access control list, specifying whether it filters based on IP addresses, MAC addresses, or other criteria.
- Changed property aclViewList (object)
  The list of ACL views, used for retrieving multiple ACL configurations in a single response.
- Changed property id (object)
  The identifier
- Changed property name (object)
  The unique name identifier for this access control list.
Changed content type : application/vnd.ruckus.v1+json
- Changed property aclRules (object)
  The set of rules associated with this ACL, defining the filtering criteria and actions to be taken.
- Changed property aclType (object)
  The type of access control list, specifying whether it filters based on IP addresses, MAC addresses, or other criteria.
- Changed property aclViewList (object)
  The list of ACL views, used for retrieving multiple ACL configurations in a single response.
- Changed property id (object)
  The identifier
- Changed property name (object)
  The unique name identifier for this access control list.

Changed response : 400 Bad Request

Bad/malformed request

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 401 Unauthorized

Unauthorized

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 403 Forbidden

Forbidden

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 404 Not Found

Requested resource or related entity not found

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 422 Unprocessable Entity

Validation error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 500 Internal Server Error

Internal Server Error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

GET /venues/{venueId}/switchProfiles/vlans

Return Type:

Changed response : 200 OK

OK

Changed content type : application/json
- Changed property arpInspection (object)
  The flag indicating whether ARP inspection is enabled for this VLAN to prevent ARP spoofing attacks.
- Changed property arpInspectionTrustPort (object)
  The comma separated list of port identifiers trusted for ARP inspection, bypassing ARP validation.
- Changed property id (object)
  The identifier
- Changed property igmpSnooping (object)
  The IGMP snooping mode for this VLAN to optimize multicast traffic delivery.
- Changed property ipv4DhcpSnooping (object)
  The flag indicating whether IPv4 DHCP snooping is enabled for this VLAN to prevent rogue DHCP servers.
- Changed property ipv4DhcpSnoopingTrustPort (object)
  The comma separated list of port identifiers trusted for DHCP snooping, allowing DHCP server responses.
- Changed property multicastVersion (object)
  The IGMP version number used for multicast group management in this VLAN.
- Changed property rootBridgeFamilyId (object)
  The switch family identifier for the root bridge in spanning tree topology.
- Changed property spanningTreePriority (object)
  The STP (Spanning Tree Protocol) bridge priority value for this VLAN, used in root bridge election.
- Changed property spanningTreeProtocol (object)
  The STP (Spanning Tree Protocol) variant enabled for this VLAN.
- Changed property switchFamilyModels (object)
  The set of switch family models with specific configurations for this VLAN across different hardware types.
- Changed property vlanId (object)
  The VLAN identifier, ranging from 1 to 4095, uniquely identifying this VLAN.
- Changed property vlanName (object)
  The descriptive name assigned to this VLAN for identification purposes.
Changed content type : application/vnd.ruckus.v1+json
- Changed property arpInspection (object)
  The flag indicating whether ARP inspection is enabled for this VLAN to prevent ARP spoofing attacks.
- Changed property arpInspectionTrustPort (object)
  The comma separated list of port identifiers trusted for ARP inspection, bypassing ARP validation.
- Changed property id (object)
  The identifier
- Changed property igmpSnooping (object)
  The IGMP snooping mode for this VLAN to optimize multicast traffic delivery.
- Changed property ipv4DhcpSnooping (object)
  The flag indicating whether IPv4 DHCP snooping is enabled for this VLAN to prevent rogue DHCP servers.
- Changed property ipv4DhcpSnoopingTrustPort (object)
  The comma separated list of port identifiers trusted for DHCP snooping, allowing DHCP server responses.
- Changed property multicastVersion (object)
  The IGMP version number used for multicast group management in this VLAN.
- Changed property rootBridgeFamilyId (object)
  The switch family identifier for the root bridge in spanning tree topology.
- Changed property spanningTreePriority (object)
  The STP (Spanning Tree Protocol) bridge priority value for this VLAN, used in root bridge election.
- Changed property spanningTreeProtocol (object)
  The STP (Spanning Tree Protocol) variant enabled for this VLAN.
- Changed property switchFamilyModels (object)
  The set of switch family models with specific configurations for this VLAN across different hardware types.
- Changed property vlanId (object)
  The VLAN identifier, ranging from 1 to 4095, uniquely identifying this VLAN.
- Changed property vlanName (object)
  The descriptive name assigned to this VLAN for identification purposes.

Changed response : 400 Bad Request

Bad/malformed request

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 401 Unauthorized

Unauthorized

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 403 Forbidden

Forbidden

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 404 Not Found

Requested resource or related entity not found

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 422 Unprocessable Entity

Validation error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 500 Internal Server Error

Internal Server Error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

GET /venues/{venueId}/switches/importResults

Get Download URL and Result

Return Type:

Changed response : 200 OK

OK

Changed content type : application/json
- Changed property failureCount (object)
  The total number of switches that failed to import.
- Changed property failureDownloadUrl (object)
  The URL to download the report of failed switch imports with error details.
- Changed property successCount (object)
  The total number of switches that were successfully imported.
- Changed property successDownloadUrl (object)
  The URL to download the report of successfully imported switches.
- Changed property totalCount (object)
  The total number of switches attempted in the import operation.
Changed content type : application/vnd.ruckus.v1+json
- Changed property failureCount (object)
  The total number of switches that failed to import.
- Changed property failureDownloadUrl (object)
  The URL to download the report of failed switch imports with error details.
- Changed property successCount (object)
  The total number of switches that were successfully imported.
- Changed property successDownloadUrl (object)
  The URL to download the report of successfully imported switches.
- Changed property totalCount (object)
  The total number of switches attempted in the import operation.

Changed response : 400 Bad Request

Bad/malformed request

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 401 Unauthorized

Unauthorized

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 403 Forbidden

Forbidden

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 404 Not Found

Requested resource or related entity not found

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 422 Unprocessable Entity

Validation error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 500 Internal Server Error

Internal Server Error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

GET /venues/{venueId}/switches/{switchId}/aclUnions

Return Type:

Changed response : 200 OK

OK

Changed content type : application/json
- Changed property profileAcl (object)
  The list of ACL names configured at the profile level, applied to multiple switches through profile inheritance.
- Changed property switchAcl (object)
  The list of ACL names configured directly on the switch, overriding or supplementing profile level configurations.
Changed content type : application/vnd.ruckus.v1+json
- Changed property profileAcl (object)
  The list of ACL names configured at the profile level, applied to multiple switches through profile inheritance.
- Changed property switchAcl (object)
  The list of ACL names configured directly on the switch, overriding or supplementing profile level configurations.

Changed response : 400 Bad Request

Bad/malformed request

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 401 Unauthorized

Unauthorized

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 403 Forbidden

Forbidden

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 404 Not Found

Requested resource or related entity not found

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 422 Unprocessable Entity

Validation error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 500 Internal Server Error

Internal Server Error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

GET /venues/{venueId}/switches/{switchId}/acls

Return Type:

Changed response : 400 Bad Request

Bad/malformed request

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 401 Unauthorized

Unauthorized

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 403 Forbidden

Forbidden

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 404 Not Found

Requested resource or related entity not found

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 422 Unprocessable Entity

Validation error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 500 Internal Server Error

Internal Server Error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

POST /venues/{venueId}/switches/{switchId}/acls/query

Request:

Changed content type : application/json

Changed property fields (object)
The list of field names to include in the query response, allowing clients to request only specific fields.
Changed property page (object)
The page number for pagination, starting from 1, defaulting to 1.
Changed property pageSize (object)
The number of records to return per page, defaulting to 25.
Changed property sortField (object)
The field name to use for sorting the query results.
Changed property sortOrder (object)
The sort order direction for the query results, either ascending or descending, defaulting to ascending.

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

Changed property fields (object)
The list of field names to include in the query response, allowing clients to request only specific fields.
Changed property page (object)
The page number for pagination, starting from 1, defaulting to 1.
Changed property pageSize (object)
The number of records to return per page, defaulting to 25.
Changed property sortField (object)
The field name to use for sorting the query results.
Changed property sortOrder (object)
The sort order direction for the query results, either ascending or descending, defaulting to ascending.

Return Type:

Changed response : 200 OK

OK

Changed content type : application/json
- Changed property data (object)
  The list of data records returned by the query, with each item representing a result object.
- Changed property fields (object)
  The list of field names included in the query response data.
- Changed property page (object)
  The current page number of the paginated results.
- Changed property totalCount (object)
  The total number of records matching the query criteria across all pages.
- Changed property totalPages (object)
  The total number of pages available based on the page size and total record count.
Changed content type : application/vnd.ruckus.v1+json
- Changed property data (object)
  The list of data records returned by the query, with each item representing a result object.
- Changed property fields (object)
  The list of field names included in the query response data.
- Changed property page (object)
  The current page number of the paginated results.
- Changed property totalCount (object)
  The total number of records matching the query criteria across all pages.
- Changed property totalPages (object)
  The total number of pages available based on the page size and total record count.

Changed response : 400 Bad Request

Bad/malformed request

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 401 Unauthorized

Unauthorized

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 403 Forbidden

Forbidden

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 404 Not Found

Requested resource or related entity not found

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 422 Unprocessable Entity

Validation error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 500 Internal Server Error

Internal Server Error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

POST /venues/{venueId}/switches/{switchId}/configBackups/query

Request:

Changed content type : application/json

Changed property fields (object)
The list of field names to include in the query response, allowing clients to request only specific fields.
Changed property page (object)
The page number for pagination, starting from 1, defaulting to 1.
Changed property pageSize (object)
The number of records to return per page, defaulting to 25.
Changed property sortField (object)
The field name to use for sorting the query results.
Changed property sortOrder (object)
The sort order direction for the query results, either ascending or descending, defaulting to ascending.

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

Changed property fields (object)
The list of field names to include in the query response, allowing clients to request only specific fields.
Changed property page (object)
The page number for pagination, starting from 1, defaulting to 1.
Changed property pageSize (object)
The number of records to return per page, defaulting to 25.
Changed property sortField (object)
The field name to use for sorting the query results.
Changed property sortOrder (object)
The sort order direction for the query results, either ascending or descending, defaulting to ascending.

Return Type:

Changed response : 200 OK

OK

Changed content type : application/json
- Changed property data (object)
  The list of data records returned by the query, with each item representing a result object.
- Changed property fields (object)
  The list of field names included in the query response data.
- Changed property page (object)
  The current page number of the paginated results.
- Changed property totalCount (object)
  The total number of records matching the query criteria across all pages.
- Changed property totalPages (object)
  The total number of pages available based on the page size and total record count.
Changed content type : application/vnd.ruckus.v1+json
- Changed property data (object)
  The list of data records returned by the query, with each item representing a result object.
- Changed property fields (object)
  The list of field names included in the query response data.
- Changed property page (object)
  The current page number of the paginated results.
- Changed property totalCount (object)
  The total number of records matching the query criteria across all pages.
- Changed property totalPages (object)
  The total number of pages available based on the page size and total record count.

Changed response : 400 Bad Request

Bad/malformed request

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 401 Unauthorized

Unauthorized

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 403 Forbidden

Forbidden

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 404 Not Found

Requested resource or related entity not found

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 422 Unprocessable Entity

Validation error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 500 Internal Server Error

Internal Server Error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

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

Return Type:

Changed response : 200 OK

OK

Changed content type : application/json
- Changed property venueId (object)
  The identifier of venue.
Changed content type : application/vnd.ruckus.v1+json
- Changed property venueId (object)
  The identifier of venue.

Changed response : 400 Bad Request

Bad/malformed request

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 401 Unauthorized

Unauthorized

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 403 Forbidden

Forbidden

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 404 Not Found

Requested resource or related entity not found

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 422 Unprocessable Entity

Validation error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 500 Internal Server Error

Internal Server Error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

POST /venues/{venueId}/switches/{switchId}/configHistDetails/query

Request:

Changed content type : application/json

Changed property filterByConfigType (object)
The configuration type filter to limit results to specific types of configuration deployments.
Added enum values:
- DHCP6_SERVER
- RODAN_AV_PROFILE
Changed property page (object)
The page number for pagination, starting from 1.
Changed property pageSize (object)
The number of records to return per page.
Changed property sortField (object)
The field name used to sort the configuration history records.
Changed property sortOrder (object)
The sort order direction for the query results, either ascending or descending.

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

Changed property filterByConfigType (object)
The configuration type filter to limit results to specific types of configuration deployments.
Added enum values:
- DHCP6_SERVER
- RODAN_AV_PROFILE
Changed property page (object)
The page number for pagination, starting from 1.
Changed property pageSize (object)
The number of records to return per page.
Changed property sortField (object)
The field name used to sort the configuration history records.
Changed property sortOrder (object)
The sort order direction for the query results, either ascending or descending.

Return Type:

Changed response : 200 OK

OK

Changed content type : application/json
- Changed property list (object)
  The list of configuration history information records containing deployment details and status.
- Changed property totalCount (object)
  The total number of configuration history records matching the query criteria.
Changed content type : application/vnd.ruckus.v1+json
- Changed property list (object)
  The list of configuration history information records containing deployment details and status.
- Changed property totalCount (object)
  The total number of configuration history records matching the query criteria.

Changed response : 400 Bad Request

Bad/malformed request

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 401 Unauthorized

Unauthorized

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 403 Forbidden

Forbidden

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 404 Not Found

Requested resource or related entity not found

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 422 Unprocessable Entity

Validation error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 500 Internal Server Error

Internal Server Error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

POST /venues/{venueId}/switches/{switchId}/dhcpServers/query

Request:

Changed content type : application/json

Changed property fields (object)
The list of field names to include in the query response, allowing clients to request only specific fields.
Changed property page (object)
The page number for pagination, starting from 1, defaulting to 1.
Changed property pageSize (object)
The number of records to return per page, defaulting to 25.
Changed property sortField (object)
The field name to use for sorting the query results.
Changed property sortOrder (object)
The sort order direction for the query results, either ascending or descending, defaulting to ascending.

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

Changed property fields (object)
The list of field names to include in the query response, allowing clients to request only specific fields.
Changed property page (object)
The page number for pagination, starting from 1, defaulting to 1.
Changed property pageSize (object)
The number of records to return per page, defaulting to 25.
Changed property sortField (object)
The field name to use for sorting the query results.
Changed property sortOrder (object)
The sort order direction for the query results, either ascending or descending, defaulting to ascending.

Return Type:

Changed response : 200 OK

OK

Changed content type : application/json
- Changed property data (object)
  The list of data records returned by the query, with each item representing a result object.
- Changed property fields (object)
  The list of field names included in the query response data.
- Changed property page (object)
  The current page number of the paginated results.
- Changed property totalCount (object)
  The total number of records matching the query criteria across all pages.
- Changed property totalPages (object)
  The total number of pages available based on the page size and total record count.
Changed content type : application/vnd.ruckus.v1+json
- Changed property data (object)
  The list of data records returned by the query, with each item representing a result object.
- Changed property fields (object)
  The list of field names included in the query response data.
- Changed property page (object)
  The current page number of the paginated results.
- Changed property totalCount (object)
  The total number of records matching the query criteria across all pages.
- Changed property totalPages (object)
  The total number of pages available based on the page size and total record count.

Changed response : 400 Bad Request

Bad/malformed request

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 401 Unauthorized

Unauthorized

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 403 Forbidden

Forbidden

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 404 Not Found

Requested resource or related entity not found

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 422 Unprocessable Entity

Validation error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 500 Internal Server Error

Internal Server Error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

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

Return Type:

Changed response : 200 OK

OK

Changed content type : application/json
- Changed property list (object)
  The list of configuration history information records containing deployment details and status.
- Changed property totalCount (object)
  The total number of configuration history records matching the query criteria.
Changed content type : application/vnd.ruckus.v1+json
- Changed property list (object)
  The list of configuration history information records containing deployment details and status.
- Changed property totalCount (object)
  The total number of configuration history records matching the query criteria.

Changed response : 400 Bad Request

Bad/malformed request

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 401 Unauthorized

Unauthorized

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 403 Forbidden

Forbidden

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 404 Not Found

Requested resource or related entity not found

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 422 Unprocessable Entity

Validation error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 500 Internal Server Error

Internal Server Error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

POST /venues/{venueId}/switches/{switchId}/vePorts/query

Request:

Changed content type : application/json

Changed property fields (object)
The list of field names to include in the query response, allowing clients to request only specific fields.
Changed property filterType (object)
The dynamic filter type (deprecated, use filters instead).
Changed property filters (object)
The dynamic filter map where keys are field names and values are lists of filter criteria to apply for each field.
Changed property page (object)
The page number for pagination, starting from 1, defaulting to 1.
Changed property pageSize (object)
The number of records to return per page, defaulting to 25.
Changed property sortField (object)
The field name to use for sorting the query results.
Changed property sortOrder (object)
The sort order direction for the query results, either ascending or descending, defaulting to ascending.

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

Changed property fields (object)
The list of field names to include in the query response, allowing clients to request only specific fields.
Changed property filterType (object)
The dynamic filter type (deprecated, use filters instead).
Changed property filters (object)
The dynamic filter map where keys are field names and values are lists of filter criteria to apply for each field.
Changed property page (object)
The page number for pagination, starting from 1, defaulting to 1.
Changed property pageSize (object)
The number of records to return per page, defaulting to 25.
Changed property sortField (object)
The field name to use for sorting the query results.
Changed property sortOrder (object)
The sort order direction for the query results, either ascending or descending, defaulting to ascending.

Return Type:

Changed response : 200 OK

OK

Changed content type : application/json
- Changed property data (object)
  The list of data records returned by the query, with each item representing a result object.
- Changed property fields (object)
  The list of field names included in the query response data.
- Changed property page (object)
  The current page number of the paginated results.
- Changed property totalCount (object)
  The total number of records matching the query criteria across all pages.
- Changed property totalPages (object)
  The total number of pages available based on the page size and total record count.
Changed content type : application/vnd.ruckus.v1+json
- Changed property data (object)
  The list of data records returned by the query, with each item representing a result object.
- Changed property fields (object)
  The list of field names included in the query response data.
- Changed property page (object)
  The current page number of the paginated results.
- Changed property totalCount (object)
  The total number of records matching the query criteria across all pages.
- Changed property totalPages (object)
  The total number of pages available based on the page size and total record count.

Changed response : 400 Bad Request

Bad/malformed request

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 401 Unauthorized

Unauthorized

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 403 Forbidden

Forbidden

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 404 Not Found

Requested resource or related entity not found

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 422 Unprocessable Entity

Validation error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 500 Internal Server Error

Internal Server Error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

GET /venues/{venueId}/switches/{switchId}/vlanUnions

Return Type:

Changed response : 200 OK

OK

Changed content type : application/json
- Changed property profileVlan (object)
  The list of VLAN configurations defined in port profiles.
- Changed property switchDefaultVlan (object)
  The list of switch default VLAN configurations, representing the native VLAN settings on switches.
- Changed property switchVlan (object)
  The list of VLAN configurations directly assigned to switches.
Changed content type : application/vnd.ruckus.v1+json
- Changed property profileVlan (object)
  The list of VLAN configurations defined in port profiles.
- Changed property switchDefaultVlan (object)
  The list of switch default VLAN configurations, representing the native VLAN settings on switches.
- Changed property switchVlan (object)
  The list of VLAN configurations directly assigned to switches.

Changed response : 400 Bad Request

Bad/malformed request

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 401 Unauthorized

Unauthorized

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 403 Forbidden

Forbidden

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 404 Not Found

Requested resource or related entity not found

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 422 Unprocessable Entity

Validation error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 500 Internal Server Error

Internal Server Error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

POST /venues/{venueId}/switches/{switchId}/vlans/query

Request:

Changed content type : application/json

Changed property fields (object)
The list of field names to include in the query response, allowing clients to request only specific fields.
Changed property filterType (object)
The dynamic filter type (deprecated, use filters instead).
Changed property filters (object)
The dynamic filter map where keys are field names and values are lists of filter criteria to apply for each field.
Changed property page (object)
The page number for pagination, starting from 1, defaulting to 1.
Changed property pageSize (object)
The number of records to return per page, defaulting to 25.
Changed property searchString (object)
The search string for full text search across the specified target fields.
Changed property searchTargetFields (object)
The list of field names to search within when applying the search string.
Changed property sortField (object)
The field name to use for sorting the query results.
Changed property sortOrder (object)
The sort order direction for the query results, either ascending or descending, defaulting to ascending.

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

Changed property fields (object)
The list of field names to include in the query response, allowing clients to request only specific fields.
Changed property filterType (object)
The dynamic filter type (deprecated, use filters instead).
Changed property filters (object)
The dynamic filter map where keys are field names and values are lists of filter criteria to apply for each field.
Changed property page (object)
The page number for pagination, starting from 1, defaulting to 1.
Changed property pageSize (object)
The number of records to return per page, defaulting to 25.
Changed property searchString (object)
The search string for full text search across the specified target fields.
Changed property searchTargetFields (object)
The list of field names to search within when applying the search string.
Changed property sortField (object)
The field name to use for sorting the query results.
Changed property sortOrder (object)
The sort order direction for the query results, either ascending or descending, defaulting to ascending.

Return Type:

Changed response : 200 OK

OK

Changed content type : application/json
- Changed property data (object)
  The list of data records returned by the query, with each item representing a result object.
- Changed property fields (object)
  The list of field names included in the query response data.
- Changed property page (object)
  The current page number of the paginated results.
- Changed property totalCount (object)
  The total number of records matching the query criteria across all pages.
- Changed property totalPages (object)
  The total number of pages available based on the page size and total record count.
Changed content type : application/vnd.ruckus.v1+json
- Changed property data (object)
  The list of data records returned by the query, with each item representing a result object.
- Changed property fields (object)
  The list of field names included in the query response data.
- Changed property page (object)
  The current page number of the paginated results.
- Changed property totalCount (object)
  The total number of records matching the query criteria across all pages.
- Changed property totalPages (object)
  The total number of pages available based on the page size and total record count.

Changed response : 400 Bad Request

Bad/malformed request

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 401 Unauthorized

Unauthorized

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 403 Forbidden

Forbidden

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 404 Not Found

Requested resource or related entity not found

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 422 Unprocessable Entity

Validation error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 500 Internal Server Error

Internal Server Error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

POST /venues/{venueId}/taggedVlans/query

Retrieve Tagged VLANs

Request:

Changed content type : application/json

Changed property model (object)
The switch model to determine the VLAN tagging capabilities and supported features.
Added enum values:
- ICX8200-C08ZP-V
- ICX8200-24ZP-V
- ICX8200-48ZP2-V
- ICX8200-48P-V
- ICX8200-48PF-V
- ICX8200-48PF2-V
- ICX8100-C08PF-V
- ICX8100-24P-V
- ICX8100-48P-V

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

Changed property model (object)
The switch model to determine the VLAN tagging capabilities and supported features.
Added enum values:
- ICX8200-C08ZP-V
- ICX8200-24ZP-V
- ICX8200-48ZP2-V
- ICX8200-48P-V
- ICX8200-48PF-V
- ICX8200-48PF2-V
- ICX8100-C08PF-V
- ICX8100-24P-V
- ICX8100-48P-V

Return Type:

Changed response : 200 OK

OK

Changed content type : application/json
- Changed property arpInspection (object)
  The flag indicating whether ARP inspection is enabled for this VLAN to prevent ARP spoofing attacks.
- Changed property arpInspectionTrustPort (object)
  The comma separated list of port identifiers trusted for ARP inspection, bypassing ARP validation.
- Changed property id (object)
  The identifier
- Changed property igmpSnooping (object)
  The IGMP snooping mode for this VLAN to optimize multicast traffic delivery.
- Changed property ipv4DhcpSnooping (object)
  The flag indicating whether IPv4 DHCP snooping is enabled for this VLAN to prevent rogue DHCP servers.
- Changed property ipv4DhcpSnoopingTrustPort (object)
  The comma separated list of port identifiers trusted for DHCP snooping, allowing DHCP server responses.
- Changed property multicastVersion (object)
  The IGMP version number used for multicast group management in this VLAN.
- Changed property rootBridgeFamilyId (object)
  The switch family identifier for the root bridge in spanning tree topology.
- Changed property spanningTreePriority (object)
  The STP (Spanning Tree Protocol) bridge priority value for this VLAN, used in root bridge election.
- Changed property spanningTreeProtocol (object)
  The STP (Spanning Tree Protocol) variant enabled for this VLAN.
- Changed property switchFamilyModels (object)
  The set of switch family models with specific configurations for this VLAN across different hardware types.
- Changed property vlanId (object)
  The VLAN identifier, ranging from 1 to 4095, uniquely identifying this VLAN.
- Changed property vlanName (object)
  The descriptive name assigned to this VLAN for identification purposes.
Changed content type : application/vnd.ruckus.v1+json
- Changed property arpInspection (object)
  The flag indicating whether ARP inspection is enabled for this VLAN to prevent ARP spoofing attacks.
- Changed property arpInspectionTrustPort (object)
  The comma separated list of port identifiers trusted for ARP inspection, bypassing ARP validation.
- Changed property id (object)
  The identifier
- Changed property igmpSnooping (object)
  The IGMP snooping mode for this VLAN to optimize multicast traffic delivery.
- Changed property ipv4DhcpSnooping (object)
  The flag indicating whether IPv4 DHCP snooping is enabled for this VLAN to prevent rogue DHCP servers.
- Changed property ipv4DhcpSnoopingTrustPort (object)
  The comma separated list of port identifiers trusted for DHCP snooping, allowing DHCP server responses.
- Changed property multicastVersion (object)
  The IGMP version number used for multicast group management in this VLAN.
- Changed property rootBridgeFamilyId (object)
  The switch family identifier for the root bridge in spanning tree topology.
- Changed property spanningTreePriority (object)
  The STP (Spanning Tree Protocol) bridge priority value for this VLAN, used in root bridge election.
- Changed property spanningTreeProtocol (object)
  The STP (Spanning Tree Protocol) variant enabled for this VLAN.
- Changed property switchFamilyModels (object)
  The set of switch family models with specific configurations for this VLAN across different hardware types.
- Changed property vlanId (object)
  The VLAN identifier, ranging from 1 to 4095, uniquely identifying this VLAN.
- Changed property vlanName (object)
  The descriptive name assigned to this VLAN for identification purposes.

Changed response : 400 Bad Request

Bad/malformed request

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 401 Unauthorized

Unauthorized

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 403 Forbidden

Forbidden

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 404 Not Found

Requested resource or related entity not found

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 422 Unprocessable Entity

Validation error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 500 Internal Server Error

Internal Server Error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

GET /venues/{venueId}/trustedPorts

Return Type:

Changed response : 200 OK

OK

Changed content type : application/json
- Changed property id (object)
  The identifier
- Changed property model (object)
  The switch model to which this trusted port configuration applies.
  Added enum values:
  - ICX8200-C08ZP-V
  - ICX8200-24ZP-V
  - ICX8200-48ZP2-V
  - ICX8200-48P-V
  - ICX8200-48PF-V
  - ICX8200-48PF2-V
  - ICX8100-C08PF-V
  - ICX8100-24P-V
  - ICX8100-48P-V
- Changed property slots (object)
  The set of switch family model and slot configurations for trusted port assignment across different hardware types.
- Changed property trustPorts (object)
  The list of port identifiers configured as trusted ports for DHCP snooping or ARP inspection.
- Changed property trustedPortType (object)
  The type of trusted port configuration: DHCP snooping or ARP inspection.
  Added enum values:
  - ipv6_dhcp
  - ipv6_nd
- Changed property vlanDemand (object)
  The flag indicating whether trusted port configuration requires VLAN specification.
Changed content type : application/vnd.ruckus.v1+json
- Changed property id (object)
  The identifier
- Changed property model (object)
  The switch model to which this trusted port configuration applies.
  Added enum values:
  - ICX8200-C08ZP-V
  - ICX8200-24ZP-V
  - ICX8200-48ZP2-V
  - ICX8200-48P-V
  - ICX8200-48PF-V
  - ICX8200-48PF2-V
  - ICX8100-C08PF-V
  - ICX8100-24P-V
  - ICX8100-48P-V
- Changed property slots (object)
  The set of switch family model and slot configurations for trusted port assignment across different hardware types.
- Changed property trustPorts (object)
  The list of port identifiers configured as trusted ports for DHCP snooping or ARP inspection.
- Changed property trustedPortType (object)
  The type of trusted port configuration: DHCP snooping or ARP inspection.
  Added enum values:
  - ipv6_dhcp
  - ipv6_nd
- Changed property vlanDemand (object)
  The flag indicating whether trusted port configuration requires VLAN specification.

Changed response : 400 Bad Request

Bad/malformed request

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 401 Unauthorized

Unauthorized

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 403 Forbidden

Forbidden

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 404 Not Found

Requested resource or related entity not found

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 422 Unprocessable Entity

Validation error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 500 Internal Server Error

Internal Server Error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

POST /venues/{venueId}/untaggedVlans/query

Retrieve Untagged VLANs

Request:

Changed content type : application/json

Changed property model (object)
The switch model to determine the VLAN tagging capabilities and supported features.
Added enum values:
- ICX8200-C08ZP-V
- ICX8200-24ZP-V
- ICX8200-48ZP2-V
- ICX8200-48P-V
- ICX8200-48PF-V
- ICX8200-48PF2-V
- ICX8100-C08PF-V
- ICX8100-24P-V
- ICX8100-48P-V

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

Changed property model (object)
The switch model to determine the VLAN tagging capabilities and supported features.
Added enum values:
- ICX8200-C08ZP-V
- ICX8200-24ZP-V
- ICX8200-48ZP2-V
- ICX8200-48P-V
- ICX8200-48PF-V
- ICX8200-48PF2-V
- ICX8100-C08PF-V
- ICX8100-24P-V
- ICX8100-48P-V

Return Type:

Changed response : 200 OK

OK

Changed content type : application/json
- Changed property arpInspection (object)
  The flag indicating whether ARP inspection is enabled for this VLAN to prevent ARP spoofing attacks.
- Changed property arpInspectionTrustPort (object)
  The comma separated list of port identifiers trusted for ARP inspection, bypassing ARP validation.
- Changed property id (object)
  The identifier
- Changed property igmpSnooping (object)
  The IGMP snooping mode for this VLAN to optimize multicast traffic delivery.
- Changed property ipv4DhcpSnooping (object)
  The flag indicating whether IPv4 DHCP snooping is enabled for this VLAN to prevent rogue DHCP servers.
- Changed property ipv4DhcpSnoopingTrustPort (object)
  The comma separated list of port identifiers trusted for DHCP snooping, allowing DHCP server responses.
- Changed property multicastVersion (object)
  The IGMP version number used for multicast group management in this VLAN.
- Changed property rootBridgeFamilyId (object)
  The switch family identifier for the root bridge in spanning tree topology.
- Changed property spanningTreePriority (object)
  The STP (Spanning Tree Protocol) bridge priority value for this VLAN, used in root bridge election.
- Changed property spanningTreeProtocol (object)
  The STP (Spanning Tree Protocol) variant enabled for this VLAN.
- Changed property switchFamilyModels (object)
  The set of switch family models with specific configurations for this VLAN across different hardware types.
- Changed property vlanId (object)
  The VLAN identifier, ranging from 1 to 4095, uniquely identifying this VLAN.
- Changed property vlanName (object)
  The descriptive name assigned to this VLAN for identification purposes.
Changed content type : application/vnd.ruckus.v1+json
- Changed property arpInspection (object)
  The flag indicating whether ARP inspection is enabled for this VLAN to prevent ARP spoofing attacks.
- Changed property arpInspectionTrustPort (object)
  The comma separated list of port identifiers trusted for ARP inspection, bypassing ARP validation.
- Changed property id (object)
  The identifier
- Changed property igmpSnooping (object)
  The IGMP snooping mode for this VLAN to optimize multicast traffic delivery.
- Changed property ipv4DhcpSnooping (object)
  The flag indicating whether IPv4 DHCP snooping is enabled for this VLAN to prevent rogue DHCP servers.
- Changed property ipv4DhcpSnoopingTrustPort (object)
  The comma separated list of port identifiers trusted for DHCP snooping, allowing DHCP server responses.
- Changed property multicastVersion (object)
  The IGMP version number used for multicast group management in this VLAN.
- Changed property rootBridgeFamilyId (object)
  The switch family identifier for the root bridge in spanning tree topology.
- Changed property spanningTreePriority (object)
  The STP (Spanning Tree Protocol) bridge priority value for this VLAN, used in root bridge election.
- Changed property spanningTreeProtocol (object)
  The STP (Spanning Tree Protocol) variant enabled for this VLAN.
- Changed property switchFamilyModels (object)
  The set of switch family models with specific configurations for this VLAN across different hardware types.
- Changed property vlanId (object)
  The VLAN identifier, ranging from 1 to 4095, uniquely identifying this VLAN.
- Changed property vlanName (object)
  The descriptive name assigned to this VLAN for identification purposes.

Changed response : 400 Bad Request

Bad/malformed request

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 401 Unauthorized

Unauthorized

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 403 Forbidden

Forbidden

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 404 Not Found

Requested resource or related entity not found

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 422 Unprocessable Entity

Validation error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 500 Internal Server Error

Internal Server Error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

POST /venues/{venueId}/vePorts/query

Request:

Changed content type : application/json

Changed property fields (object)
The list of field names to include in the query response, allowing clients to request only specific fields.
Changed property filterType (object)
The dynamic filter type (deprecated, use filters instead).
Changed property filters (object)
The dynamic filter map where keys are field names and values are lists of filter criteria to apply for each field.
Changed property page (object)
The page number for pagination, starting from 1, defaulting to 1.
Changed property pageSize (object)
The number of records to return per page, defaulting to 25.
Changed property sortField (object)
The field name to use for sorting the query results.
Changed property sortOrder (object)
The sort order direction for the query results, either ascending or descending, defaulting to ascending.

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

Changed property fields (object)
The list of field names to include in the query response, allowing clients to request only specific fields.
Changed property filterType (object)
The dynamic filter type (deprecated, use filters instead).
Changed property filters (object)
The dynamic filter map where keys are field names and values are lists of filter criteria to apply for each field.
Changed property page (object)
The page number for pagination, starting from 1, defaulting to 1.
Changed property pageSize (object)
The number of records to return per page, defaulting to 25.
Changed property sortField (object)
The field name to use for sorting the query results.
Changed property sortOrder (object)
The sort order direction for the query results, either ascending or descending, defaulting to ascending.

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

Changed property fields (object)
The list of field names to include in the query response, allowing clients to request only specific fields.
Changed property filterType (object)
The dynamic filter type (deprecated, use filters instead).
Changed property filters (object)
The dynamic filter map where keys are field names and values are lists of filter criteria to apply for each field.
Changed property page (object)
The page number for pagination, starting from 1, defaulting to 1.
Changed property pageSize (object)
The number of records to return per page, defaulting to 25.
Changed property sortField (object)
The field name to use for sorting the query results.
Changed property sortOrder (object)
The sort order direction for the query results, either ascending or descending, defaulting to ascending.

Return Type:

Changed response : 200 OK

OK

Changed content type : application/json
- Changed property data (object)
  The list of data records returned by the query, with each item representing a result object.
- Changed property fields (object)
  The list of field names included in the query response data.
- Changed property page (object)
  The current page number of the paginated results.
- Changed property totalCount (object)
  The total number of records matching the query criteria across all pages.
- Changed property totalPages (object)
  The total number of pages available based on the page size and total record count.
Changed content type : application/vnd.ruckus.v1+json
- Changed property data (object)
  The list of data records returned by the query, with each item representing a result object.
- Changed property fields (object)
  The list of field names included in the query response data.
- Changed property page (object)
  The current page number of the paginated results.
- Changed property totalCount (object)
  The total number of records matching the query criteria across all pages.
- Changed property totalPages (object)
  The total number of pages available based on the page size and total record count.
Changed content type : application/vnd.ruckus.v1.1+json
- Changed property data (object)
  The list of data records returned by the query, with each item representing a result object.
- Changed property fields (object)
  The list of field names included in the query response data.
- Changed property page (object)
  The current page number of the paginated results.
- Changed property totalCount (object)
  The total number of records matching the query criteria across all pages.
- Changed property totalPages (object)
  The total number of pages available based on the page size and total record count.

Changed response : 400 Bad Request

Bad/malformed request

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 401 Unauthorized

Unauthorized

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 403 Forbidden

Forbidden

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 404 Not Found

Requested resource or related entity not found

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 422 Unprocessable Entity

Validation error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 500 Internal Server Error

Internal Server Error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

GET /venues/{venueId}/vlanUnions

Return Type:

Changed response : 200 OK

OK

Changed content type : application/json
- Changed property id (object)
  The identifier
- Changed property vlanConfigName (object)
  VLAN configuration name (maximum 32 characters).
- Changed property vlanId (object)
  The VLAN identifier (1-4095).
Changed content type : application/vnd.ruckus.v1+json
- Changed property id (object)
  The identifier
- Changed property vlanConfigName (object)
  VLAN configuration name (maximum 32 characters).
- Changed property vlanId (object)
  The VLAN identifier (1-4095).

Changed response : 400 Bad Request

Bad/malformed request

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 401 Unauthorized

Unauthorized

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 403 Forbidden

Forbidden

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 404 Not Found

Requested resource or related entity not found

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 422 Unprocessable Entity

Validation error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 500 Internal Server Error

Internal Server Error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

POST /venues/{venueId}/vlans/query

Return Type:

Changed response : 400 Bad Request

Bad/malformed request

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 401 Unauthorized

Unauthorized

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 403 Forbidden

Forbidden

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 404 Not Found

Requested resource or related entity not found

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 422 Unprocessable Entity

Validation error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 500 Internal Server Error

Internal Server Error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

POST /webAuthPageTemplates/query

Request:

Changed content type : application/json

Changed property fields (object)
The list of field names to include in the query response, allowing clients to request only specific fields.
Changed property page (object)
The page number for pagination, starting from 1, defaulting to 1.
Changed property pageSize (object)
The number of records to return per page, defaulting to 25.
Changed property sortField (object)
The field name to use for sorting the query results.
Changed property sortOrder (object)
The sort order direction for the query results, either ascending or descending, defaulting to ascending.

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

Changed property fields (object)
The list of field names to include in the query response, allowing clients to request only specific fields.
Changed property page (object)
The page number for pagination, starting from 1, defaulting to 1.
Changed property pageSize (object)
The number of records to return per page, defaulting to 25.
Changed property sortField (object)
The field name to use for sorting the query results.
Changed property sortOrder (object)
The sort order direction for the query results, either ascending or descending, defaulting to ascending.

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

Changed property fields (object)
The list of field names to include in the query response, allowing clients to request only specific fields.
Changed property page (object)
The page number for pagination, starting from 1, defaulting to 1.
Changed property pageSize (object)
The number of records to return per page, defaulting to 25.
Changed property sortField (object)
The field name to use for sorting the query results.
Changed property sortOrder (object)
The sort order direction for the query results, either ascending or descending, defaulting to ascending.

Return Type:

Changed response : 200 OK

OK

Changed content type : application/json
- Changed property data (object)
  The list of data records returned by the query, with each item representing a result object.
- Changed property fields (object)
  The list of field names included in the query response data.
- Changed property page (object)
  The current page number of the paginated results.
- Changed property totalCount (object)
  The total number of records matching the query criteria across all pages.
- Changed property totalPages (object)
  The total number of pages available based on the page size and total record count.
Changed content type : application/vnd.ruckus.v1+json
- Changed property data (object)
  The list of data records returned by the query, with each item representing a result object.
- Changed property fields (object)
  The list of field names included in the query response data.
- Changed property page (object)
  The current page number of the paginated results.
- Changed property totalCount (object)
  The total number of records matching the query criteria across all pages.
- Changed property totalPages (object)
  The total number of pages available based on the page size and total record count.
Changed content type : application/vnd.ruckus.v1.1+json
- Changed property data (object)
  The list of data records returned by the query, with each item representing a result object.
- Changed property fields (object)
  The list of field names included in the query response data.
- Changed property page (object)
  The current page number of the paginated results.
- Changed property totalCount (object)
  The total number of records matching the query criteria across all pages.
- Changed property totalPages (object)
  The total number of pages available based on the page size and total record count.

Changed response : 400 Bad Request

Bad/malformed request

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 401 Unauthorized

Unauthorized

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 403 Forbidden

Forbidden

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 404 Not Found

Requested resource or related entity not found

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 422 Unprocessable Entity

Validation error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 500 Internal Server Error

Internal Server Error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

GET /webAuthPageTemplates/{templateId}/switches

Get Template Switch Info

Return Type:

Changed response : 200 OK

OK

Changed content type : application/json
- Added property SwitchAndVenue_V1 (object)
  The list of switches and venues where this Web Authentication page template is deployed.
- Added property WebAuthPageTemplateList_V1 (object)
  The list of Web Authentication page template instances for batch operations or nested template management.
- Deleted property switchVenueInfos (object)
- Deleted property webAuthPageTemplateViewList (object)
- Changed property id (object)
  The unique identifier of the Web Authentication page template.
- Changed property name (object)
  The name of the Web Authentication page template for identification.
- Changed property switchCount (object)
  The number of switches where this Web Authentication page template is applied.
- Changed property tag (object)
  The tag or label used for categorizing and filtering the Web Authentication page template.
- Changed property venueCount (object)
  The number of venues where this Web Authentication page template is applied.
- Changed property webAuthCustomBottom (object)
  The custom HTML or text content displayed at the bottom section of the Web Authentication login page.
- Changed property webAuthCustomLoginButton (object)
  The custom text for the login button on the Web Authentication page.
- Changed property webAuthCustomTitle (object)
  The custom title text displayed at the top of the Web Authentication login page.
- Changed property webAuthCustomTop (object)
  The custom HTML or text content displayed at the top section of the Web Authentication login page.
- Changed property webAuthPasswordLabel (object)
  The custom label text for the password field on the Web Authentication login page.
- Changed property webAuthUserIdLabel (object)
  The custom label text for the username field on the Web Authentication login page.
Changed content type : application/vnd.ruckus.v1+json
- Added property SwitchAndVenue_V1 (object)
  The list of switches and venues where this Web Authentication page template is deployed.
- Added property WebAuthPageTemplateList_V1 (object)
  The list of Web Authentication page template instances for batch operations or nested template management.
- Deleted property switchVenueInfos (object)
- Deleted property webAuthPageTemplateViewList (object)
- Changed property id (object)
  The unique identifier of the Web Authentication page template.
- Changed property name (object)
  The name of the Web Authentication page template for identification.
- Changed property switchCount (object)
  The number of switches where this Web Authentication page template is applied.
- Changed property tag (object)
  The tag or label used for categorizing and filtering the Web Authentication page template.
- Changed property venueCount (object)
  The number of venues where this Web Authentication page template is applied.
- Changed property webAuthCustomBottom (object)
  The custom HTML or text content displayed at the bottom section of the Web Authentication login page.
- Changed property webAuthCustomLoginButton (object)
  The custom text for the login button on the Web Authentication page.
- Changed property webAuthCustomTitle (object)
  The custom title text displayed at the top of the Web Authentication login page.
- Changed property webAuthCustomTop (object)
  The custom HTML or text content displayed at the top section of the Web Authentication login page.
- Changed property webAuthPasswordLabel (object)
  The custom label text for the password field on the Web Authentication login page.
- Changed property webAuthUserIdLabel (object)
  The custom label text for the username field on the Web Authentication login page.

Changed response : 400 Bad Request

Bad/malformed request

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 401 Unauthorized

Unauthorized

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 403 Forbidden

Forbidden

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 404 Not Found

Requested resource or related entity not found

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 422 Unprocessable Entity

Validation error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 500 Internal Server Error

Internal Server Error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

GET /cliTemplates

Get Command Line Interface Templates

Return Type:

Changed response : 200 OK

OK

Changed content type : application/json
- Changed property applyLater (object)
  The flag indicating whether to apply this CLI template later rather than immediately.
- Changed property cli (object)
  The CLI command template content containing switch configuration commands and variable placeholders.
- Changed property id (object)
  The identifier
- Changed property name (object)
  The unique name identifier for this CLI template, limited to 64 characters.
- Changed property reload (object)
  The flag indicating whether the switch should be reloaded after applying this CLI template.
- Changed property variables (object)
  The set of variables defined in this CLI template for dynamic configuration value substitution.
- Changed property venueSwitches (object)
  The list of venue switch associations indicating which switches in each venue should receive this CLI template.
Changed content type : application/vnd.ruckus.v1+json
- Changed property applyLater (object)
  The flag indicating whether to apply this CLI template later rather than immediately.
- Changed property cli (object)
  The CLI command template content containing switch configuration commands and variable placeholders.
- Changed property id (object)
  The identifier
- Changed property name (object)
  The unique name identifier for this CLI template, limited to 64 characters.
- Changed property reload (object)
  The flag indicating whether the switch should be reloaded after applying this CLI template.
- Changed property variables (object)
  The set of variables defined in this CLI template for dynamic configuration value substitution.
- Changed property venueSwitches (object)
  The list of venue switch associations indicating which switches in each venue should receive this CLI template.

Changed response : 400 Bad Request

Bad/malformed request

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 401 Unauthorized

Unauthorized

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 403 Forbidden

Forbidden

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 404 Not Found

Requested resource or related entity not found

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 422 Unprocessable Entity

Validation error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 500 Internal Server Error

Internal Server Error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

POST /cliTemplates

Add Command Line Interface Template

Request:

Changed content type : application/json

Changed property applyLater (object)
Flag indicating whether to apply the CLI template later rather than immediately (default: false).
Changed property cli (object)
The CLI command template content with variable placeholders (e.g., {{variable_name}}).
Changed property id (object)
Unique identifier for the CLI template.
Changed property name (object)
Name of the CLI template (1-64 characters).
Changed property reload (object)
Flag indicating whether to reload the switch after applying the CLI commands (default: false).
Changed property variables (object)
Set of template variables that can be customized for each switch when applying the CLI template.
Changed property venueSwitches (object)
List of venue switches to which this CLI template will be applied.

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

Changed property applyLater (object)
Flag indicating whether to apply the CLI template later rather than immediately (default: false).
Changed property cli (object)
The CLI command template content with variable placeholders (e.g., {{variable_name}}).
Changed property id (object)
Unique identifier for the CLI template.
Changed property name (object)
Name of the CLI template (1-64 characters).
Changed property reload (object)
Flag indicating whether to reload the switch after applying the CLI commands (default: false).
Changed property variables (object)
Set of template variables that can be customized for each switch when applying the CLI template.
Changed property venueSwitches (object)
List of venue switches to which this CLI template will be applied.

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

Changed property applyLater (object)
Indicates whether the CLI template application should be scheduled for later execution instead of immediate application.
Changed property cli (object)
The CLI command template content containing the switch commands and variable placeholders to be executed.
Changed property name (object)
The unique name identifier for this CLI template, with a length between 1 and 64 characters.
Changed property reload (object)
Indicates whether the switch should be reloaded after applying this CLI template.
Changed property variables (object)
The set of variables used in this CLI template, defining dynamic values that can be substituted when the template is applied.

Return Type:

Changed response : 200 OK

OK

Changed content type : application/json
- Changed property applyLater (object)
  The flag indicating whether to apply this CLI template later rather than immediately.
- Changed property cli (object)
  The CLI command template content containing switch configuration commands and variable placeholders.
- Changed property id (object)
  The identifier
- Changed property name (object)
  The unique name identifier for this CLI template, limited to 64 characters.
- Changed property reload (object)
  The flag indicating whether the switch should be reloaded after applying this CLI template.
- Changed property variables (object)
  The set of variables defined in this CLI template for dynamic configuration value substitution.
- Changed property venueSwitches (object)
  The list of venue switch associations indicating which switches in each venue should receive this CLI template.
Changed content type : application/vnd.ruckus.v1+json
- Changed property applyLater (object)
  The flag indicating whether to apply this CLI template later rather than immediately.
- Changed property cli (object)
  The CLI command template content containing switch configuration commands and variable placeholders.
- Changed property id (object)
  The identifier
- Changed property name (object)
  The unique name identifier for this CLI template, limited to 64 characters.
- Changed property reload (object)
  The flag indicating whether the switch should be reloaded after applying this CLI template.
- Changed property variables (object)
  The set of variables defined in this CLI template for dynamic configuration value substitution.
- Changed property venueSwitches (object)
  The list of venue switch associations indicating which switches in each venue should receive this CLI template.

Changed response : 400 Bad Request

Bad/malformed request

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 401 Unauthorized

Unauthorized

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 403 Forbidden

Forbidden

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 404 Not Found

Requested resource or related entity not found

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 422 Unprocessable Entity

Validation error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 500 Internal Server Error

Internal Server Error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 202 Accepted

Accepted

Changed content type : application/vnd.ruckus.v1.1+json
- Changed property requestId (object)
  The unique identifier for tracking this API operation request.
- Changed property response (object)
  The empty view representing an API response with no data content, used for operations that return success status without additional information.

DELETE /cliTemplates

Delete Command Line Interface Templates

Return Type:

Changed response : 400 Bad Request

Bad/malformed request

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 401 Unauthorized

Unauthorized

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 403 Forbidden

Forbidden

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 404 Not Found

Requested resource or related entity not found

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 422 Unprocessable Entity

Validation error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 500 Internal Server Error

Internal Server Error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 200 OK

OK

Changed content type : application/json
- Changed property requestId (object)
  The unique identifier for tracking this API operation request.
- Changed property response (object)
  The empty view representing an API response with no data content, used for operations that return success status without additional information.
Changed content type : application/vnd.ruckus.v1+json
- Changed property requestId (object)
  The unique identifier for tracking this API operation request.
- Changed property response (object)
  The empty view representing an API response with no data content, used for operations that return success status without additional information.

Changed response : 202 Accepted

Accepted

Changed content type : application/vnd.ruckus.v1.1+json
- Changed property requestId (object)
  The unique identifier for tracking this API operation request.
- Changed property response (object)
  The empty view representing an API response with no data content, used for operations that return success status without additional information.

GET /cliTemplates/{cliTemplateId}

Get Command Line Interface Template

Return Type:

Changed response : 200 OK

OK

Changed content type : application/json
- Changed property applyLater (object)
  The flag indicating whether to apply this CLI template later rather than immediately.
- Changed property cli (object)
  The CLI command template content containing switch configuration commands and variable placeholders.
- Changed property id (object)
  The identifier
- Changed property name (object)
  The unique name identifier for this CLI template, limited to 64 characters.
- Changed property reload (object)
  The flag indicating whether the switch should be reloaded after applying this CLI template.
- Changed property variables (object)
  The set of variables defined in this CLI template for dynamic configuration value substitution.
- Changed property venueSwitches (object)
  The list of venue switch associations indicating which switches in each venue should receive this CLI template.
Changed content type : application/vnd.ruckus.v1+json
- Changed property applyLater (object)
  The flag indicating whether to apply this CLI template later rather than immediately.
- Changed property cli (object)
  The CLI command template content containing switch configuration commands and variable placeholders.
- Changed property id (object)
  The identifier
- Changed property name (object)
  The unique name identifier for this CLI template, limited to 64 characters.
- Changed property reload (object)
  The flag indicating whether the switch should be reloaded after applying this CLI template.
- Changed property variables (object)
  The set of variables defined in this CLI template for dynamic configuration value substitution.
- Changed property venueSwitches (object)
  The list of venue switch associations indicating which switches in each venue should receive this CLI template.
Changed content type : application/vnd.ruckus.v1.1+json
- Changed property applyLater (object)
  Indicates whether the CLI template application should be scheduled for later execution.
- Changed property cli (object)
  The CLI command template content containing the switch commands and variable placeholders.
- Changed property name (object)
  The unique name identifier for this CLI template, with a length between 1 and 64 characters.
- Changed property reload (object)
  Indicates whether the switch should be reloaded after applying this CLI template.
- Changed property variables (object)
  The set of variables defined in this CLI template for dynamic value substitution.
- Changed property venueSwitches (object)
  The list of venue switches associated with this CLI template, indicating which switches this template is assigned to.

Changed response : 400 Bad Request

Bad/malformed request

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 401 Unauthorized

Unauthorized

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 403 Forbidden

Forbidden

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 404 Not Found

Requested resource or related entity not found

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 422 Unprocessable Entity

Validation error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 500 Internal Server Error

Internal Server Error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

PUT /cliTemplates/{cliTemplateId}

Update Command Line Interface Template

Request:

Changed content type : application/json

Changed property applyLater (object)
Flag indicating whether to apply the CLI template later rather than immediately (default: false).
Changed property cli (object)
The CLI command template content with variable placeholders (e.g., {{variable_name}}).
Changed property id (object)
Unique identifier for the CLI template.
Changed property name (object)
Name of the CLI template (1-64 characters).
Changed property reload (object)
Flag indicating whether to reload the switch after applying the CLI commands (default: false).
Changed property variables (object)
Set of template variables that can be customized for each switch when applying the CLI template.
Changed property venueSwitches (object)
List of venue switches to which this CLI template will be applied.

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

Changed property applyLater (object)
Flag indicating whether to apply the CLI template later rather than immediately (default: false).
Changed property cli (object)
The CLI command template content with variable placeholders (e.g., {{variable_name}}).
Changed property id (object)
Unique identifier for the CLI template.
Changed property name (object)
Name of the CLI template (1-64 characters).
Changed property reload (object)
Flag indicating whether to reload the switch after applying the CLI commands (default: false).
Changed property variables (object)
Set of template variables that can be customized for each switch when applying the CLI template.
Changed property venueSwitches (object)
List of venue switches to which this CLI template will be applied.

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

Changed property applyLater (object)
Indicates whether the CLI template application should be scheduled for later execution instead of immediate application.
Changed property cli (object)
The CLI command template content containing the switch commands and variable placeholders to be executed.
Changed property name (object)
The unique name identifier for this CLI template, with a length between 1 and 64 characters.
Changed property reload (object)
Indicates whether the switch should be reloaded after applying this CLI template.
Changed property variables (object)
The set of variables used in this CLI template, defining dynamic values that can be substituted when the template is applied.

Return Type:

Changed response : 200 OK

OK

Changed content type : application/json
- Changed property applyLater (object)
  The flag indicating whether to apply this CLI template later rather than immediately.
- Changed property cli (object)
  The CLI command template content containing switch configuration commands and variable placeholders.
- Changed property id (object)
  The identifier
- Changed property name (object)
  The unique name identifier for this CLI template, limited to 64 characters.
- Changed property reload (object)
  The flag indicating whether the switch should be reloaded after applying this CLI template.
- Changed property variables (object)
  The set of variables defined in this CLI template for dynamic configuration value substitution.
- Changed property venueSwitches (object)
  The list of venue switch associations indicating which switches in each venue should receive this CLI template.
Changed content type : application/vnd.ruckus.v1+json
- Changed property applyLater (object)
  The flag indicating whether to apply this CLI template later rather than immediately.
- Changed property cli (object)
  The CLI command template content containing switch configuration commands and variable placeholders.
- Changed property id (object)
  The identifier
- Changed property name (object)
  The unique name identifier for this CLI template, limited to 64 characters.
- Changed property reload (object)
  The flag indicating whether the switch should be reloaded after applying this CLI template.
- Changed property variables (object)
  The set of variables defined in this CLI template for dynamic configuration value substitution.
- Changed property venueSwitches (object)
  The list of venue switch associations indicating which switches in each venue should receive this CLI template.

Changed response : 400 Bad Request

Bad/malformed request

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 401 Unauthorized

Unauthorized

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 403 Forbidden

Forbidden

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 404 Not Found

Requested resource or related entity not found

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 422 Unprocessable Entity

Validation error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 500 Internal Server Error

Internal Server Error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 202 Accepted

Accepted

Changed content type : application/vnd.ruckus.v1.1+json
- Changed property requestId (object)
  The unique identifier for tracking this API operation request.
- Changed property response (object)
  The empty view representing an API response with no data content, used for operations that return success status without additional information.

DELETE /cliTemplates/{cliTemplateId}

Delete Command Line Interface Template

Return Type:

Changed response : 400 Bad Request

Bad/malformed request

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 401 Unauthorized

Unauthorized

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 403 Forbidden

Forbidden

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 404 Not Found

Requested resource or related entity not found

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 422 Unprocessable Entity

Validation error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 500 Internal Server Error

Internal Server Error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 200 OK

OK

Changed content type : application/json
- Changed property requestId (object)
  The unique identifier for tracking this API operation request.
- Changed property response (object)
  The empty view representing an API response with no data content, used for operations that return success status without additional information.
Changed content type : application/vnd.ruckus.v1+json
- Changed property requestId (object)
  The unique identifier for tracking this API operation request.
- Changed property response (object)
  The empty view representing an API response with no data content, used for operations that return success status without additional information.

Changed response : 202 Accepted

Accepted

Changed content type : application/vnd.ruckus.v1.1+json
- Changed property requestId (object)
  The unique identifier for tracking this API operation request.
- Changed property response (object)
  The empty view representing an API response with no data content, used for operations that return success status without additional information.

DELETE /stacks/{stackSwitchSerialNumber}

Return Type:

Changed response : 400 Bad Request

Bad/malformed request

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 401 Unauthorized

Unauthorized

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 403 Forbidden

Forbidden

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 404 Not Found

Requested resource or related entity not found

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 422 Unprocessable Entity

Validation error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 500 Internal Server Error

Internal Server Error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 200 OK

OK

Changed content type : application/json
- Changed property requestId (object)
  The unique identifier for tracking this API operation request.
- Changed property response (object)
  The empty view representing an API response with no data content, used for operations that return success status without additional information.
Changed content type : application/vnd.ruckus.v1+json
- Changed property requestId (object)
  The unique identifier for tracking this API operation request.
- Changed property response (object)
  The empty view representing an API response with no data content, used for operations that return success status without additional information.

GET /switchProfiles

Return Type:

Changed response : 400 Bad Request

Bad/malformed request

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 401 Unauthorized

Unauthorized

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 403 Forbidden

Forbidden

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 404 Not Found

Requested resource or related entity not found

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 422 Unprocessable Entity

Validation error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 500 Internal Server Error

Internal Server Error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 200 OK

OK

Changed content type : application/json
- Changed property acls (object)
  The set of Access Control List configurations included in this profile for traffic filtering.
- Changed property applyOnboardOnly (object)
  The flag indicating whether this profile should only be applied during switch onboarding.
- Changed property description (object)
  The detailed description explaining the purpose and contents of this configuration profile.
- Changed property id (object)
  The identifier
- Changed property name (object)
  The name of the configuration profile for identification and reference.
- Changed property profileType (object)
  The type of profile indicating its scope: global, venue specific, or template based.
- Changed property templateId (object)
  The identifier of the profile template used as the basis for this profile configuration.
- Changed property templateVersion (object)
  The version number of the profile template.
- Changed property trustedPorts (object)
  The set of trusted port configurations for DHCP snooping and ARP inspection security features.
- Changed property venueCount (object)
  The total number of venues where this profile is currently deployed.
- Changed property venues (object)
  The set of venue identifiers where this profile is deployed or available for use.
- Changed property vlans (object)
  The ordered set of VLAN configurations included in this profile with layer 2 security features.
- Changed property voiceVlanConfigs (object)
  The set of voice VLAN configurations for VoIP traffic prioritization across different switch models.
- Changed property venueCliTemplate (object)
  The venue CLI template view, representing CLI templates configured at the venue level for managing switch configurations across multiple devices.
  - Changed property cli (object)
    The CLI command template content containing switch configuration commands and variable placeholders.
  - Changed property id (object)
    The identifier
  - Changed property name (object)
    The unique name identifier for this venue CLI template.
  - Changed property overwrite (object)
    Indicates whether this venue CLI template should overwrite existing configurations when applied to switches.
  - Changed property switchModels (object)
    The switch model identifiers that this venue CLI template supports, defining which hardware models are compatible.
  - Changed property variables (object)
    The set of variables defined in this venue CLI template for dynamic configuration value substitution.
Changed content type : application/vnd.ruckus.v1+json
- Changed property acls (object)
  The set of Access Control List configurations included in this profile for traffic filtering.
- Changed property applyOnboardOnly (object)
  The flag indicating whether this profile should only be applied during switch onboarding.
- Changed property description (object)
  The detailed description explaining the purpose and contents of this configuration profile.
- Changed property id (object)
  The identifier
- Changed property name (object)
  The name of the configuration profile for identification and reference.
- Changed property profileType (object)
  The type of profile indicating its scope: global, venue specific, or template based.
- Changed property templateId (object)
  The identifier of the profile template used as the basis for this profile configuration.
- Changed property templateVersion (object)
  The version number of the profile template.
- Changed property trustedPorts (object)
  The set of trusted port configurations for DHCP snooping and ARP inspection security features.
- Changed property venueCount (object)
  The total number of venues where this profile is currently deployed.
- Changed property venues (object)
  The set of venue identifiers where this profile is deployed or available for use.
- Changed property vlans (object)
  The ordered set of VLAN configurations included in this profile with layer 2 security features.
- Changed property voiceVlanConfigs (object)
  The set of voice VLAN configurations for VoIP traffic prioritization across different switch models.
- Changed property venueCliTemplate (object)
  The venue CLI template view, representing CLI templates configured at the venue level for managing switch configurations across multiple devices.
  - Changed property cli (object)
    The CLI command template content containing switch configuration commands and variable placeholders.
  - Changed property id (object)
    The identifier
  - Changed property name (object)
    The unique name identifier for this venue CLI template.
  - Changed property overwrite (object)
    Indicates whether this venue CLI template should overwrite existing configurations when applied to switches.
  - Changed property switchModels (object)
    The switch model identifiers that this venue CLI template supports, defining which hardware models are compatible.
  - Changed property variables (object)
    The set of variables defined in this venue CLI template for dynamic configuration value substitution.

POST /switchProfiles

Request:

Changed content type : application/json

Changed property acls (object)
Set of ACL (Access Control List) configurations included in this profile.
Changed property applyOnboardOnly (object)
Flag indicating whether this profile should only be applied during switch onboarding.
Changed property description (object)
Profile description providing additional details about the configuration purpose.
Changed property id (object)
Unique identifier for the profile.
Changed property isTemplate (object)
Flag indicating whether this profile is a template that can be used to create other profiles (default: false).
Changed property name (object)
Profile name (1-64 characters).
Changed property portProfileMappings (object)
Set of mappings between port profiles and this configuration profile.
Changed property profileType (object)
Profile type (Regular, CLI).
Changed property templateId (object)
Identifier of the template that this profile was created from (if applicable).
Changed property templateVersion (object)
Version number of the template being used.
Changed property trustedPorts (object)
Set of trusted port configurations for QoS and security settings.
Changed property venues (object)
List of venue identifiers where this profile is applied.
Changed property vlans (object)
Set of VLAN configurations included in this profile.
Changed property voiceVlanConfigs (object)
Set of voice VLAN configurations for IP phones and voice devices.
Changed property venueCliTemplate (object)
Venue level CLI template configuration for applying custom CLI commands across multiple switches in a venue. Deprecated, this version, application/vnd.ruckus.v1+json will be removed no sooner than 06/30/2026.
- Deleted property customizedSerialSet (object)
- Changed property cli (object)
  The CLI command template content with variable placeholders for venue wide configuration.
- Changed property id (object)
  Unique identifier for the venue CLI template.
- Changed property name (object)
  Name of the venue CLI template (1-64 characters).
- Changed property overwrite (object)
  Flag indicating whether to overwrite existing configuration when applying this template (default: false).
- Changed property switchModels (object)
  Comma separated list of switch models that this template is compatible with (e.g., ICX7150, ICX7250).
- Changed property variables (object)
  Set of template variables that can be customized for each switch when applying the CLI template.

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

Changed property acls (object)
Set of ACL (Access Control List) configurations included in this profile.
Changed property applyOnboardOnly (object)
Flag indicating whether this profile should only be applied during switch onboarding.
Changed property description (object)
Profile description providing additional details about the configuration purpose.
Changed property id (object)
Unique identifier for the profile.
Changed property isTemplate (object)
Flag indicating whether this profile is a template that can be used to create other profiles (default: false).
Changed property name (object)
Profile name (1-64 characters).
Changed property portProfileMappings (object)
Set of mappings between port profiles and this configuration profile.
Changed property profileType (object)
Profile type (Regular, CLI).
Changed property templateId (object)
Identifier of the template that this profile was created from (if applicable).
Changed property templateVersion (object)
Version number of the template being used.
Changed property trustedPorts (object)
Set of trusted port configurations for QoS and security settings.
Changed property venues (object)
List of venue identifiers where this profile is applied.
Changed property vlans (object)
Set of VLAN configurations included in this profile.
Changed property voiceVlanConfigs (object)
Set of voice VLAN configurations for IP phones and voice devices.
Changed property venueCliTemplate (object)
Venue level CLI template configuration for applying custom CLI commands across multiple switches in a venue. Deprecated, this version, application/vnd.ruckus.v1+json will be removed no sooner than 06/30/2026.
- Deleted property customizedSerialSet (object)
- Changed property cli (object)
  The CLI command template content with variable placeholders for venue wide configuration.
- Changed property id (object)
  Unique identifier for the venue CLI template.
- Changed property name (object)
  Name of the venue CLI template (1-64 characters).
- Changed property overwrite (object)
  Flag indicating whether to overwrite existing configuration when applying this template (default: false).
- Changed property switchModels (object)
  Comma separated list of switch models that this template is compatible with (e.g., ICX7150, ICX7250).
- Changed property variables (object)
  Set of template variables that can be customized for each switch when applying the CLI template.

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

Changed property acls (object)
The set of Access Control List configurations to be applied as part of this profile.
Changed property applyOnboardOnly (object)
The flag indicating whether this profile should only be applied during the initial switch onboarding process.
Changed property description (object)
The descriptive text providing details about the purpose and usage of this profile.
Changed property name (object)
The unique name identifier for this switch configuration profile.
Changed property profileType (object)
The profile type indicating whether this is a port profile, switch profile, or other profile type.
Changed property trustedPorts (object)
The set of trusted port configurations for DHCP snooping and ARP inspection security features.
Changed property vlans (object)
The set of VLAN configurations defining VLANs to be created or managed by this profile.
Changed property voiceVlanConfigs (object)
The set of voice VLAN configurations for VoIP traffic prioritization on switches using this profile.
Changed property venueCliTemplate (object)
The venue CLI template view, representing CLI templates configured at the venue level for deployment across multiple switches.
- Changed property cli (object)
  The CLI command template content to be deployed to switches within the venue.
- Changed property name (object)
  The unique name identifier for this venue CLI template, with a length between 1 and 64 characters.
- Changed property overwrite (object)
  Indicates whether this venue CLI template should overwrite existing configurations on the target switches.
- Changed property switchModels (object)
  The switch model identifiers that this venue CLI template is compatible with, specifying which hardware models can use this template.
- Changed property variables (object)
  The set of variables used in this venue CLI template for dynamic value substitution across multiple switches.

Return Type:

Changed response : 400 Bad Request

Bad/malformed request

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 401 Unauthorized

Unauthorized

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 403 Forbidden

Forbidden

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 404 Not Found

Requested resource or related entity not found

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 422 Unprocessable Entity

Validation error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 500 Internal Server Error

Internal Server Error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 200 OK

OK

Changed content type : application/json
- Changed property requestId (object)
  The unique identifier for tracking this API operation request.
- Changed property response (object)
  The empty view representing an API response with no data content, used for operations that return success status without additional information.
Changed content type : application/vnd.ruckus.v1+json
- Changed property requestId (object)
  The unique identifier for tracking this API operation request.
- Changed property response (object)
  The empty view representing an API response with no data content, used for operations that return success status without additional information.

Changed response : 202 Accepted

Accepted

Changed content type : application/vnd.ruckus.v1.1+json
- Changed property requestId (object)
  The unique identifier for tracking this API operation request.
- Changed property response (object)
  The empty view representing an API response with no data content, used for operations that return success status without additional information.

DELETE /switchProfiles

Return Type:

Changed response : 400 Bad Request

Bad/malformed request

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 401 Unauthorized

Unauthorized

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 403 Forbidden

Forbidden

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 404 Not Found

Requested resource or related entity not found

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 422 Unprocessable Entity

Validation error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 500 Internal Server Error

Internal Server Error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 200 OK

OK

Changed content type : application/json
- Changed property requestId (object)
  The unique identifier for tracking this API operation request.
- Changed property response (object)
  The empty view representing an API response with no data content, used for operations that return success status without additional information.
Changed content type : application/vnd.ruckus.v1+json
- Changed property requestId (object)
  The unique identifier for tracking this API operation request.
- Changed property response (object)
  The empty view representing an API response with no data content, used for operations that return success status without additional information.

GET /switchProfiles/{switchProfileId}

Return Type:

Changed response : 400 Bad Request

Bad/malformed request

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 401 Unauthorized

Unauthorized

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 403 Forbidden

Forbidden

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 404 Not Found

Requested resource or related entity not found

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 422 Unprocessable Entity

Validation error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 500 Internal Server Error

Internal Server Error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 200 OK

OK

Changed content type : application/json
- Changed property acls (object)
  The set of Access Control List configurations included in this profile for traffic filtering.
- Changed property applyOnboardOnly (object)
  The flag indicating whether this profile should only be applied during switch onboarding.
- Changed property description (object)
  The detailed description explaining the purpose and contents of this configuration profile.
- Changed property id (object)
  The identifier
- Changed property name (object)
  The name of the configuration profile for identification and reference.
- Changed property profileType (object)
  The type of profile indicating its scope: global, venue specific, or template based.
- Changed property templateId (object)
  The identifier of the profile template used as the basis for this profile configuration.
- Changed property templateVersion (object)
  The version number of the profile template.
- Changed property trustedPorts (object)
  The set of trusted port configurations for DHCP snooping and ARP inspection security features.
- Changed property venueCount (object)
  The total number of venues where this profile is currently deployed.
- Changed property venues (object)
  The set of venue identifiers where this profile is deployed or available for use.
- Changed property vlans (object)
  The ordered set of VLAN configurations included in this profile with layer 2 security features.
- Changed property voiceVlanConfigs (object)
  The set of voice VLAN configurations for VoIP traffic prioritization across different switch models.
- Changed property venueCliTemplate (object)
  The venue CLI template view, representing CLI templates configured at the venue level for managing switch configurations across multiple devices.
  - Changed property cli (object)
    The CLI command template content containing switch configuration commands and variable placeholders.
  - Changed property id (object)
    The identifier
  - Changed property name (object)
    The unique name identifier for this venue CLI template.
  - Changed property overwrite (object)
    Indicates whether this venue CLI template should overwrite existing configurations when applied to switches.
  - Changed property switchModels (object)
    The switch model identifiers that this venue CLI template supports, defining which hardware models are compatible.
  - Changed property variables (object)
    The set of variables defined in this venue CLI template for dynamic configuration value substitution.
Changed content type : application/vnd.ruckus.v1+json
- Changed property acls (object)
  The set of Access Control List configurations included in this profile for traffic filtering.
- Changed property applyOnboardOnly (object)
  The flag indicating whether this profile should only be applied during switch onboarding.
- Changed property description (object)
  The detailed description explaining the purpose and contents of this configuration profile.
- Changed property id (object)
  The identifier
- Changed property name (object)
  The name of the configuration profile for identification and reference.
- Changed property profileType (object)
  The type of profile indicating its scope: global, venue specific, or template based.
- Changed property templateId (object)
  The identifier of the profile template used as the basis for this profile configuration.
- Changed property templateVersion (object)
  The version number of the profile template.
- Changed property trustedPorts (object)
  The set of trusted port configurations for DHCP snooping and ARP inspection security features.
- Changed property venueCount (object)
  The total number of venues where this profile is currently deployed.
- Changed property venues (object)
  The set of venue identifiers where this profile is deployed or available for use.
- Changed property vlans (object)
  The ordered set of VLAN configurations included in this profile with layer 2 security features.
- Changed property voiceVlanConfigs (object)
  The set of voice VLAN configurations for VoIP traffic prioritization across different switch models.
- Changed property venueCliTemplate (object)
  The venue CLI template view, representing CLI templates configured at the venue level for managing switch configurations across multiple devices.
  - Changed property cli (object)
    The CLI command template content containing switch configuration commands and variable placeholders.
  - Changed property id (object)
    The identifier
  - Changed property name (object)
    The unique name identifier for this venue CLI template.
  - Changed property overwrite (object)
    Indicates whether this venue CLI template should overwrite existing configurations when applied to switches.
  - Changed property switchModels (object)
    The switch model identifiers that this venue CLI template supports, defining which hardware models are compatible.
  - Changed property variables (object)
    The set of variables defined in this venue CLI template for dynamic configuration value substitution.
Changed content type : application/vnd.ruckus.v1.1+json
- Deleted property applyOnboardOnly (object)
- Deleted property templateVersion (object)
- Changed property acls (object)
  The set of Access Control List configurations included in this profile for traffic filtering.
- Changed property description (object)
  The detailed description explaining the purpose and contents of this configuration profile.
- Changed property name (object)
  The name of the configuration profile for identification and reference.
- Changed property profileType (object)
  The type of profile indicating its scope: global, venue specific, or template based.
- Changed property templateId (object)
  The identifier of the profile template used as the basis for this profile configuration.
- Changed property trustedPorts (object)
  The set of trusted port configurations for DHCP snooping and ARP inspection security features.
- Changed property venueCount (object)
  The total number of venues where this profile is currently deployed.
- Changed property venues (object)
  The set of venue identifiers where this profile is deployed or available for use.
- Changed property vlans (object)
  The ordered set of VLAN configurations included in this profile with layer 2 security features.
- Changed property voiceVlanConfigs (object)
  The set of voice VLAN configurations for VoIP traffic prioritization across different switch models.
- Changed property venueCliTemplate (object)
  The venue CLI template view, representing CLI templates configured at the venue level for deployment across multiple switches.
  - Changed property cli (object)
    The CLI command template content to be deployed to switches within the venue.
  - Changed property name (object)
    The unique name identifier for this venue CLI template, with a length between 1 and 64 characters.
  - Changed property overwrite (object)
    Indicates whether this venue CLI template should overwrite existing configurations on the target switches.
  - Changed property switchModels (object)
    The switch model identifiers that this venue CLI template is compatible with, specifying which hardware models can use this template.
  - Changed property variables (object)
    The set of variables used in this venue CLI template for dynamic value substitution across multiple switches.

PUT /switchProfiles/{switchProfileId}

Request:

Changed content type : application/json

Changed property acls (object)
Set of ACL (Access Control List) configurations included in this profile.
Changed property applyOnboardOnly (object)
Flag indicating whether this profile should only be applied during switch onboarding.
Changed property description (object)
Profile description providing additional details about the configuration purpose.
Changed property id (object)
Unique identifier for the profile.
Changed property isTemplate (object)
Flag indicating whether this profile is a template that can be used to create other profiles (default: false).
Changed property name (object)
Profile name (1-64 characters).
Changed property portProfileMappings (object)
Set of mappings between port profiles and this configuration profile.
Changed property profileType (object)
Profile type (Regular, CLI).
Changed property templateId (object)
Identifier of the template that this profile was created from (if applicable).
Changed property templateVersion (object)
Version number of the template being used.
Changed property trustedPorts (object)
Set of trusted port configurations for QoS and security settings.
Changed property venues (object)
List of venue identifiers where this profile is applied.
Changed property vlans (object)
Set of VLAN configurations included in this profile.
Changed property voiceVlanConfigs (object)
Set of voice VLAN configurations for IP phones and voice devices.
Changed property venueCliTemplate (object)
Venue level CLI template configuration for applying custom CLI commands across multiple switches in a venue. Deprecated, this version, application/vnd.ruckus.v1+json will be removed no sooner than 06/30/2026.
- Deleted property customizedSerialSet (object)
- Changed property cli (object)
  The CLI command template content with variable placeholders for venue wide configuration.
- Changed property id (object)
  Unique identifier for the venue CLI template.
- Changed property name (object)
  Name of the venue CLI template (1-64 characters).
- Changed property overwrite (object)
  Flag indicating whether to overwrite existing configuration when applying this template (default: false).
- Changed property switchModels (object)
  Comma separated list of switch models that this template is compatible with (e.g., ICX7150, ICX7250).
- Changed property variables (object)
  Set of template variables that can be customized for each switch when applying the CLI template.

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

Changed property acls (object)
Set of ACL (Access Control List) configurations included in this profile.
Changed property applyOnboardOnly (object)
Flag indicating whether this profile should only be applied during switch onboarding.
Changed property description (object)
Profile description providing additional details about the configuration purpose.
Changed property id (object)
Unique identifier for the profile.
Changed property isTemplate (object)
Flag indicating whether this profile is a template that can be used to create other profiles (default: false).
Changed property name (object)
Profile name (1-64 characters).
Changed property portProfileMappings (object)
Set of mappings between port profiles and this configuration profile.
Changed property profileType (object)
Profile type (Regular, CLI).
Changed property templateId (object)
Identifier of the template that this profile was created from (if applicable).
Changed property templateVersion (object)
Version number of the template being used.
Changed property trustedPorts (object)
Set of trusted port configurations for QoS and security settings.
Changed property venues (object)
List of venue identifiers where this profile is applied.
Changed property vlans (object)
Set of VLAN configurations included in this profile.
Changed property voiceVlanConfigs (object)
Set of voice VLAN configurations for IP phones and voice devices.
Changed property venueCliTemplate (object)
Venue level CLI template configuration for applying custom CLI commands across multiple switches in a venue. Deprecated, this version, application/vnd.ruckus.v1+json will be removed no sooner than 06/30/2026.
- Deleted property customizedSerialSet (object)
- Changed property cli (object)
  The CLI command template content with variable placeholders for venue wide configuration.
- Changed property id (object)
  Unique identifier for the venue CLI template.
- Changed property name (object)
  Name of the venue CLI template (1-64 characters).
- Changed property overwrite (object)
  Flag indicating whether to overwrite existing configuration when applying this template (default: false).
- Changed property switchModels (object)
  Comma separated list of switch models that this template is compatible with (e.g., ICX7150, ICX7250).
- Changed property variables (object)
  Set of template variables that can be customized for each switch when applying the CLI template.

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

Changed property acls (object)
The set of Access Control List configurations to be applied as part of this profile.
Changed property applyOnboardOnly (object)
The flag indicating whether this profile should only be applied during the initial switch onboarding process.
Changed property description (object)
The descriptive text providing details about the purpose and usage of this profile.
Changed property name (object)
The unique name identifier for this switch configuration profile.
Changed property profileType (object)
The profile type indicating whether this is a port profile, switch profile, or other profile type.
Changed property trustedPorts (object)
The set of trusted port configurations for DHCP snooping and ARP inspection security features.
Changed property vlans (object)
The set of VLAN configurations defining VLANs to be created or managed by this profile.
Changed property voiceVlanConfigs (object)
The set of voice VLAN configurations for VoIP traffic prioritization on switches using this profile.
Changed property venueCliTemplate (object)
The venue CLI template view, representing CLI templates configured at the venue level for deployment across multiple switches.
- Changed property cli (object)
  The CLI command template content to be deployed to switches within the venue.
- Changed property name (object)
  The unique name identifier for this venue CLI template, with a length between 1 and 64 characters.
- Changed property overwrite (object)
  Indicates whether this venue CLI template should overwrite existing configurations on the target switches.
- Changed property switchModels (object)
  The switch model identifiers that this venue CLI template is compatible with, specifying which hardware models can use this template.
- Changed property variables (object)
  The set of variables used in this venue CLI template for dynamic value substitution across multiple switches.

Return Type:

Changed response : 400 Bad Request

Bad/malformed request

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 401 Unauthorized

Unauthorized

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 403 Forbidden

Forbidden

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 404 Not Found

Requested resource or related entity not found

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 422 Unprocessable Entity

Validation error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 500 Internal Server Error

Internal Server Error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 200 OK

OK

Changed content type : application/json
- Changed property requestId (object)
  The unique identifier for tracking this API operation request.
- Changed property response (object)
  The empty view representing an API response with no data content, used for operations that return success status without additional information.
Changed content type : application/vnd.ruckus.v1+json
- Changed property requestId (object)
  The unique identifier for tracking this API operation request.
- Changed property response (object)
  The empty view representing an API response with no data content, used for operations that return success status without additional information.

Changed response : 202 Accepted

Accepted

Changed content type : application/vnd.ruckus.v1.1+json
- Changed property requestId (object)
  The unique identifier for tracking this API operation request.
- Changed property response (object)
  The empty view representing an API response with no data content, used for operations that return success status without additional information.

DELETE /switchProfiles/{switchProfileId}

Return Type:

Changed response : 400 Bad Request

Bad/malformed request

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 401 Unauthorized

Unauthorized

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 403 Forbidden

Forbidden

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 404 Not Found

Requested resource or related entity not found

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 422 Unprocessable Entity

Validation error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 500 Internal Server Error

Internal Server Error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 200 OK

OK

Changed content type : application/json
- Changed property requestId (object)
  The unique identifier for tracking this API operation request.
- Changed property response (object)
  The empty view representing an API response with no data content, used for operations that return success status without additional information.
Changed content type : application/vnd.ruckus.v1+json
- Changed property requestId (object)
  The unique identifier for tracking this API operation request.
- Changed property response (object)
  The empty view representing an API response with no data content, used for operations that return success status without additional information.

Changed response : 202 Accepted

Accepted

Changed content type : application/vnd.ruckus.v1.1+json
- Changed property requestId (object)
  The unique identifier for tracking this API operation request.
- Changed property response (object)
  The empty view representing an API response with no data content, used for operations that return success status without additional information.

GET /switchProfiles/{switchProfileId}/acls

Return Type:

Changed response : 200 OK

OK

Changed content type : application/json
- Changed property aclRules (object)
  The set of rules associated with this ACL, defining the filtering criteria and actions to be taken.
- Changed property aclType (object)
  The type of access control list, specifying whether it filters based on IP addresses, MAC addresses, or other criteria.
- Changed property aclViewList (object)
  The list of ACL views, used for retrieving multiple ACL configurations in a single response.
- Changed property id (object)
  The identifier
- Changed property name (object)
  The unique name identifier for this access control list.
Changed content type : application/vnd.ruckus.v1+json
- Changed property aclRules (object)
  The set of rules associated with this ACL, defining the filtering criteria and actions to be taken.
- Changed property aclType (object)
  The type of access control list, specifying whether it filters based on IP addresses, MAC addresses, or other criteria.
- Changed property aclViewList (object)
  The list of ACL views, used for retrieving multiple ACL configurations in a single response.
- Changed property id (object)
  The identifier
- Changed property name (object)
  The unique name identifier for this access control list.

Changed response : 400 Bad Request

Bad/malformed request

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 401 Unauthorized

Unauthorized

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 403 Forbidden

Forbidden

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 404 Not Found

Requested resource or related entity not found

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 422 Unprocessable Entity

Validation error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 500 Internal Server Error

Internal Server Error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

POST /switchProfiles/{switchProfileId}/acls

Request:

Changed content type : application/json

Deleted property uniqueName (object)
Changed property aclRules (object)
Set of ACL rules defining the traffic filtering behavior.
Changed property aclType (object)
Type of ACL (STANDARD, EXTENDED, STANDARD_IPV6, or EXTENDED_IPV6).
Changed property id (object)
Unique identifier for the ACL.
Changed property name (object)
Name of the ACL (must be unique within the switch).
Changed property switchId (object)
Switch identifier (MAC address) where this ACL is applied.

Return Type:

Changed response : 200 OK

OK

Changed content type : application/json
- Changed property aclRules (object)
  The set of rules associated with this ACL, defining the filtering criteria and actions to be taken.
- Changed property aclType (object)
  The type of access control list, specifying whether it filters based on IP addresses, MAC addresses, or other criteria.
- Changed property aclViewList (object)
  The list of ACL views, used for retrieving multiple ACL configurations in a single response.
- Changed property id (object)
  The identifier
- Changed property name (object)
  The unique name identifier for this access control list.
Changed content type : application/vnd.ruckus.v1+json
- Changed property aclRules (object)
  The set of rules associated with this ACL, defining the filtering criteria and actions to be taken.
- Changed property aclType (object)
  The type of access control list, specifying whether it filters based on IP addresses, MAC addresses, or other criteria.
- Changed property aclViewList (object)
  The list of ACL views, used for retrieving multiple ACL configurations in a single response.
- Changed property id (object)
  The identifier
- Changed property name (object)
  The unique name identifier for this access control list.

Changed response : 400 Bad Request

Bad/malformed request

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 401 Unauthorized

Unauthorized

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 403 Forbidden

Forbidden

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 404 Not Found

Requested resource or related entity not found

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 422 Unprocessable Entity

Validation error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 500 Internal Server Error

Internal Server Error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

DELETE /switchProfiles/{switchProfileId}/acls

Return Type:

Changed response : 400 Bad Request

Bad/malformed request

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 401 Unauthorized

Unauthorized

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 403 Forbidden

Forbidden

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 404 Not Found

Requested resource or related entity not found

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 422 Unprocessable Entity

Validation error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 500 Internal Server Error

Internal Server Error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 200 OK

OK

Changed content type : application/json
- Changed property requestId (object)
  The unique identifier for tracking this API operation request.
- Changed property response (object)
  The empty view representing an API response with no data content, used for operations that return success status without additional information.
Changed content type : application/vnd.ruckus.v1+json
- Changed property requestId (object)
  The unique identifier for tracking this API operation request.
- Changed property response (object)
  The empty view representing an API response with no data content, used for operations that return success status without additional information.

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

Return Type:

Changed response : 200 OK

OK

Changed content type : application/json
- Changed property aclRules (object)
  The set of rules associated with this ACL, defining the filtering criteria and actions to be taken.
- Changed property aclType (object)
  The type of access control list, specifying whether it filters based on IP addresses, MAC addresses, or other criteria.
- Changed property aclViewList (object)
  The list of ACL views, used for retrieving multiple ACL configurations in a single response.
- Changed property id (object)
  The identifier
- Changed property name (object)
  The unique name identifier for this access control list.
Changed content type : application/vnd.ruckus.v1+json
- Changed property aclRules (object)
  The set of rules associated with this ACL, defining the filtering criteria and actions to be taken.
- Changed property aclType (object)
  The type of access control list, specifying whether it filters based on IP addresses, MAC addresses, or other criteria.
- Changed property aclViewList (object)
  The list of ACL views, used for retrieving multiple ACL configurations in a single response.
- Changed property id (object)
  The identifier
- Changed property name (object)
  The unique name identifier for this access control list.

Changed response : 400 Bad Request

Bad/malformed request

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 401 Unauthorized

Unauthorized

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 403 Forbidden

Forbidden

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 404 Not Found

Requested resource or related entity not found

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 422 Unprocessable Entity

Validation error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 500 Internal Server Error

Internal Server Error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

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

Request:

Changed content type : application/json

Deleted property uniqueName (object)
Changed property aclRules (object)
Set of ACL rules defining the traffic filtering behavior.
Changed property aclType (object)
Type of ACL (STANDARD, EXTENDED, STANDARD_IPV6, or EXTENDED_IPV6).
Changed property id (object)
Unique identifier for the ACL.
Changed property name (object)
Name of the ACL (must be unique within the switch).
Changed property switchId (object)
Switch identifier (MAC address) where this ACL is applied.

Return Type:

Changed response : 200 OK

OK

Changed content type : application/json
- Changed property aclRules (object)
  The set of rules associated with this ACL, defining the filtering criteria and actions to be taken.
- Changed property aclType (object)
  The type of access control list, specifying whether it filters based on IP addresses, MAC addresses, or other criteria.
- Changed property aclViewList (object)
  The list of ACL views, used for retrieving multiple ACL configurations in a single response.
- Changed property id (object)
  The identifier
- Changed property name (object)
  The unique name identifier for this access control list.
Changed content type : application/vnd.ruckus.v1+json
- Changed property aclRules (object)
  The set of rules associated with this ACL, defining the filtering criteria and actions to be taken.
- Changed property aclType (object)
  The type of access control list, specifying whether it filters based on IP addresses, MAC addresses, or other criteria.
- Changed property aclViewList (object)
  The list of ACL views, used for retrieving multiple ACL configurations in a single response.
- Changed property id (object)
  The identifier
- Changed property name (object)
  The unique name identifier for this access control list.

Changed response : 400 Bad Request

Bad/malformed request

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 401 Unauthorized

Unauthorized

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 403 Forbidden

Forbidden

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 404 Not Found

Requested resource or related entity not found

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 422 Unprocessable Entity

Validation error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 500 Internal Server Error

Internal Server Error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

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

Return Type:

Changed response : 400 Bad Request

Bad/malformed request

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 401 Unauthorized

Unauthorized

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 403 Forbidden

Forbidden

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 404 Not Found

Requested resource or related entity not found

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 422 Unprocessable Entity

Validation error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 500 Internal Server Error

Internal Server Error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 200 OK

OK

Changed content type : application/json
- Changed property requestId (object)
  The unique identifier for tracking this API operation request.
- Changed property response (object)
  The empty view representing an API response with no data content, used for operations that return success status without additional information.
Changed content type : application/vnd.ruckus.v1+json
- Changed property requestId (object)
  The unique identifier for tracking this API operation request.
- Changed property response (object)
  The empty view representing an API response with no data content, used for operations that return success status without additional information.

POST /switchProfiles/{switchProfileId}/trustedPorts

Request:

Changed content type : application/json

Changed property id (object)
Unique identifier for the trusted port configuration.
Changed property model (object)
ICX switch model type (e.g., ICX7150, ICX7250, ICX7450).
Added enum values:
- ICX8200-C08ZP-V
- ICX8200-24ZP-V
- ICX8200-48ZP2-V
- ICX8200-48P-V
- ICX8200-48PF-V
- ICX8200-48PF2-V
- ICX8100-C08PF-V
- ICX8100-24P-V
- ICX8100-48P-V
Changed property slots (object)
Set of slot configurations for modular switches with expansion slots.
Changed property tenantId (object)
The unique identifier of the tenant.
Changed property trustPorts (object)
List of port identifiers configured as trusted ports for QoS priority marking.
Changed property trustedPortType (object)
Trusted port type indicating what traffic priority marking to trust (DOT1P for 802.1p, DSCP for IP DSCP).
Added enum values:
- ipv6_dhcp
- ipv6_nd
Changed property vlanDemand (object)
Flag indicating whether VLAN demand is required (default: false).

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

Changed property id (object)
Unique identifier for the trusted port configuration.
Changed property model (object)
ICX switch model type (e.g., ICX7150, ICX7250, ICX7450).
Added enum values:
- ICX8200-C08ZP-V
- ICX8200-24ZP-V
- ICX8200-48ZP2-V
- ICX8200-48P-V
- ICX8200-48PF-V
- ICX8200-48PF2-V
- ICX8100-C08PF-V
- ICX8100-24P-V
- ICX8100-48P-V
Changed property slots (object)
Set of slot configurations for modular switches with expansion slots.
Changed property tenantId (object)
The unique identifier of the tenant.
Changed property trustPorts (object)
List of port identifiers configured as trusted ports for QoS priority marking.
Changed property trustedPortType (object)
Trusted port type indicating what traffic priority marking to trust (DOT1P for 802.1p, DSCP for IP DSCP).
Added enum values:
- ipv6_dhcp
- ipv6_nd
Changed property vlanDemand (object)
Flag indicating whether VLAN demand is required (default: false).

Return Type:

Changed response : 200 OK

OK

Changed content type : application/json
- Changed property id (object)
  The identifier
- Changed property model (object)
  The switch model to which this trusted port configuration applies.
  Added enum values:
  - ICX8200-C08ZP-V
  - ICX8200-24ZP-V
  - ICX8200-48ZP2-V
  - ICX8200-48P-V
  - ICX8200-48PF-V
  - ICX8200-48PF2-V
  - ICX8100-C08PF-V
  - ICX8100-24P-V
  - ICX8100-48P-V
- Changed property slots (object)
  The set of switch family model and slot configurations for trusted port assignment across different hardware types.
- Changed property trustPorts (object)
  The list of port identifiers configured as trusted ports for DHCP snooping or ARP inspection.
- Changed property trustedPortType (object)
  The type of trusted port configuration: DHCP snooping or ARP inspection.
  Added enum values:
  - ipv6_dhcp
  - ipv6_nd
- Changed property vlanDemand (object)
  The flag indicating whether trusted port configuration requires VLAN specification.
Changed content type : application/vnd.ruckus.v1+json
- Changed property id (object)
  The identifier
- Changed property model (object)
  The switch model to which this trusted port configuration applies.
  Added enum values:
  - ICX8200-C08ZP-V
  - ICX8200-24ZP-V
  - ICX8200-48ZP2-V
  - ICX8200-48P-V
  - ICX8200-48PF-V
  - ICX8200-48PF2-V
  - ICX8100-C08PF-V
  - ICX8100-24P-V
  - ICX8100-48P-V
- Changed property slots (object)
  The set of switch family model and slot configurations for trusted port assignment across different hardware types.
- Changed property trustPorts (object)
  The list of port identifiers configured as trusted ports for DHCP snooping or ARP inspection.
- Changed property trustedPortType (object)
  The type of trusted port configuration: DHCP snooping or ARP inspection.
  Added enum values:
  - ipv6_dhcp
  - ipv6_nd
- Changed property vlanDemand (object)
  The flag indicating whether trusted port configuration requires VLAN specification.

Changed response : 400 Bad Request

Bad/malformed request

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 401 Unauthorized

Unauthorized

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 403 Forbidden

Forbidden

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 404 Not Found

Requested resource or related entity not found

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 422 Unprocessable Entity

Validation error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 500 Internal Server Error

Internal Server Error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

DELETE /switchProfiles/{switchProfileId}/trustedPorts

Return Type:

Changed response : 400 Bad Request

Bad/malformed request

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 401 Unauthorized

Unauthorized

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 403 Forbidden

Forbidden

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 404 Not Found

Requested resource or related entity not found

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 422 Unprocessable Entity

Validation error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 500 Internal Server Error

Internal Server Error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 200 OK

OK

Changed content type : application/json
- Changed property requestId (object)
  The unique identifier for tracking this API operation request.
- Changed property response (object)
  The result of the operation.
  - Changed property id (object)
    The identifier

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

Return Type:

Changed response : 200 OK

OK

Changed content type : application/json
- Changed property id (object)
  The identifier
- Changed property model (object)
  The switch model to which this trusted port configuration applies.
  Added enum values:
  - ICX8200-C08ZP-V
  - ICX8200-24ZP-V
  - ICX8200-48ZP2-V
  - ICX8200-48P-V
  - ICX8200-48PF-V
  - ICX8200-48PF2-V
  - ICX8100-C08PF-V
  - ICX8100-24P-V
  - ICX8100-48P-V
- Changed property slots (object)
  The set of switch family model and slot configurations for trusted port assignment across different hardware types.
- Changed property trustPorts (object)
  The list of port identifiers configured as trusted ports for DHCP snooping or ARP inspection.
- Changed property trustedPortType (object)
  The type of trusted port configuration: DHCP snooping or ARP inspection.
  Added enum values:
  - ipv6_dhcp
  - ipv6_nd
- Changed property vlanDemand (object)
  The flag indicating whether trusted port configuration requires VLAN specification.
Changed content type : application/vnd.ruckus.v1+json
- Changed property id (object)
  The identifier
- Changed property model (object)
  The switch model to which this trusted port configuration applies.
  Added enum values:
  - ICX8200-C08ZP-V
  - ICX8200-24ZP-V
  - ICX8200-48ZP2-V
  - ICX8200-48P-V
  - ICX8200-48PF-V
  - ICX8200-48PF2-V
  - ICX8100-C08PF-V
  - ICX8100-24P-V
  - ICX8100-48P-V
- Changed property slots (object)
  The set of switch family model and slot configurations for trusted port assignment across different hardware types.
- Changed property trustPorts (object)
  The list of port identifiers configured as trusted ports for DHCP snooping or ARP inspection.
- Changed property trustedPortType (object)
  The type of trusted port configuration: DHCP snooping or ARP inspection.
  Added enum values:
  - ipv6_dhcp
  - ipv6_nd
- Changed property vlanDemand (object)
  The flag indicating whether trusted port configuration requires VLAN specification.

Changed response : 400 Bad Request

Bad/malformed request

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 401 Unauthorized

Unauthorized

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 403 Forbidden

Forbidden

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 404 Not Found

Requested resource or related entity not found

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 422 Unprocessable Entity

Validation error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 500 Internal Server Error

Internal Server Error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

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

Request:

Changed content type : application/json

Changed property id (object)
Unique identifier for the trusted port configuration.
Changed property model (object)
ICX switch model type (e.g., ICX7150, ICX7250, ICX7450).
Added enum values:
- ICX8200-C08ZP-V
- ICX8200-24ZP-V
- ICX8200-48ZP2-V
- ICX8200-48P-V
- ICX8200-48PF-V
- ICX8200-48PF2-V
- ICX8100-C08PF-V
- ICX8100-24P-V
- ICX8100-48P-V
Changed property slots (object)
Set of slot configurations for modular switches with expansion slots.
Changed property tenantId (object)
The unique identifier of the tenant.
Changed property trustPorts (object)
List of port identifiers configured as trusted ports for QoS priority marking.
Changed property trustedPortType (object)
Trusted port type indicating what traffic priority marking to trust (DOT1P for 802.1p, DSCP for IP DSCP).
Added enum values:
- ipv6_dhcp
- ipv6_nd
Changed property vlanDemand (object)
Flag indicating whether VLAN demand is required (default: false).

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

Changed property id (object)
Unique identifier for the trusted port configuration.
Changed property model (object)
ICX switch model type (e.g., ICX7150, ICX7250, ICX7450).
Added enum values:
- ICX8200-C08ZP-V
- ICX8200-24ZP-V
- ICX8200-48ZP2-V
- ICX8200-48P-V
- ICX8200-48PF-V
- ICX8200-48PF2-V
- ICX8100-C08PF-V
- ICX8100-24P-V
- ICX8100-48P-V
Changed property slots (object)
Set of slot configurations for modular switches with expansion slots.
Changed property tenantId (object)
The unique identifier of the tenant.
Changed property trustPorts (object)
List of port identifiers configured as trusted ports for QoS priority marking.
Changed property trustedPortType (object)
Trusted port type indicating what traffic priority marking to trust (DOT1P for 802.1p, DSCP for IP DSCP).
Added enum values:
- ipv6_dhcp
- ipv6_nd
Changed property vlanDemand (object)
Flag indicating whether VLAN demand is required (default: false).

Return Type:

Changed response : 200 OK

OK

Changed content type : application/json
- Changed property id (object)
  The identifier
- Changed property model (object)
  The switch model to which this trusted port configuration applies.
  Added enum values:
  - ICX8200-C08ZP-V
  - ICX8200-24ZP-V
  - ICX8200-48ZP2-V
  - ICX8200-48P-V
  - ICX8200-48PF-V
  - ICX8200-48PF2-V
  - ICX8100-C08PF-V
  - ICX8100-24P-V
  - ICX8100-48P-V
- Changed property slots (object)
  The set of switch family model and slot configurations for trusted port assignment across different hardware types.
- Changed property trustPorts (object)
  The list of port identifiers configured as trusted ports for DHCP snooping or ARP inspection.
- Changed property trustedPortType (object)
  The type of trusted port configuration: DHCP snooping or ARP inspection.
  Added enum values:
  - ipv6_dhcp
  - ipv6_nd
- Changed property vlanDemand (object)
  The flag indicating whether trusted port configuration requires VLAN specification.
Changed content type : application/vnd.ruckus.v1+json
- Changed property id (object)
  The identifier
- Changed property model (object)
  The switch model to which this trusted port configuration applies.
  Added enum values:
  - ICX8200-C08ZP-V
  - ICX8200-24ZP-V
  - ICX8200-48ZP2-V
  - ICX8200-48P-V
  - ICX8200-48PF-V
  - ICX8200-48PF2-V
  - ICX8100-C08PF-V
  - ICX8100-24P-V
  - ICX8100-48P-V
- Changed property slots (object)
  The set of switch family model and slot configurations for trusted port assignment across different hardware types.
- Changed property trustPorts (object)
  The list of port identifiers configured as trusted ports for DHCP snooping or ARP inspection.
- Changed property trustedPortType (object)
  The type of trusted port configuration: DHCP snooping or ARP inspection.
  Added enum values:
  - ipv6_dhcp
  - ipv6_nd
- Changed property vlanDemand (object)
  The flag indicating whether trusted port configuration requires VLAN specification.

Changed response : 400 Bad Request

Bad/malformed request

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 401 Unauthorized

Unauthorized

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 403 Forbidden

Forbidden

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 404 Not Found

Requested resource or related entity not found

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 422 Unprocessable Entity

Validation error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 500 Internal Server Error

Internal Server Error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

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

Return Type:

Changed response : 400 Bad Request

Bad/malformed request

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 401 Unauthorized

Unauthorized

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 403 Forbidden

Forbidden

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 404 Not Found

Requested resource or related entity not found

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 422 Unprocessable Entity

Validation error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 500 Internal Server Error

Internal Server Error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 200 OK

OK

Changed content type : application/json
- Changed property requestId (object)
  The unique identifier for tracking this API operation request.
- Changed property response (object)
  The empty view representing an API response with no data content, used for operations that return success status without additional information.
Changed content type : application/vnd.ruckus.v1+json
- Changed property requestId (object)
  The unique identifier for tracking this API operation request.
- Changed property response (object)
  The empty view representing an API response with no data content, used for operations that return success status without additional information.

GET /switchProfiles/{switchProfileId}/vlans

Return Type:

Changed response : 200 OK

OK

Changed content type : application/json
- Changed property arpInspection (object)
  The flag indicating whether ARP inspection is enabled for this VLAN to prevent ARP spoofing attacks.
- Changed property arpInspectionTrustPort (object)
  The comma separated list of port identifiers trusted for ARP inspection, bypassing ARP validation.
- Changed property id (object)
  The identifier
- Changed property igmpSnooping (object)
  The IGMP snooping mode for this VLAN to optimize multicast traffic delivery.
- Changed property ipv4DhcpSnooping (object)
  The flag indicating whether IPv4 DHCP snooping is enabled for this VLAN to prevent rogue DHCP servers.
- Changed property ipv4DhcpSnoopingTrustPort (object)
  The comma separated list of port identifiers trusted for DHCP snooping, allowing DHCP server responses.
- Changed property multicastVersion (object)
  The IGMP version number used for multicast group management in this VLAN.
- Changed property rootBridgeFamilyId (object)
  The switch family identifier for the root bridge in spanning tree topology.
- Changed property spanningTreePriority (object)
  The STP (Spanning Tree Protocol) bridge priority value for this VLAN, used in root bridge election.
- Changed property spanningTreeProtocol (object)
  The STP (Spanning Tree Protocol) variant enabled for this VLAN.
- Changed property switchFamilyModels (object)
  The set of switch family models with specific configurations for this VLAN across different hardware types.
- Changed property vlanId (object)
  The VLAN identifier, ranging from 1 to 4095, uniquely identifying this VLAN.
- Changed property vlanName (object)
  The descriptive name assigned to this VLAN for identification purposes.
Changed content type : application/vnd.ruckus.v1+json
- Changed property arpInspection (object)
  The flag indicating whether ARP inspection is enabled for this VLAN to prevent ARP spoofing attacks.
- Changed property arpInspectionTrustPort (object)
  The comma separated list of port identifiers trusted for ARP inspection, bypassing ARP validation.
- Changed property id (object)
  The identifier
- Changed property igmpSnooping (object)
  The IGMP snooping mode for this VLAN to optimize multicast traffic delivery.
- Changed property ipv4DhcpSnooping (object)
  The flag indicating whether IPv4 DHCP snooping is enabled for this VLAN to prevent rogue DHCP servers.
- Changed property ipv4DhcpSnoopingTrustPort (object)
  The comma separated list of port identifiers trusted for DHCP snooping, allowing DHCP server responses.
- Changed property multicastVersion (object)
  The IGMP version number used for multicast group management in this VLAN.
- Changed property rootBridgeFamilyId (object)
  The switch family identifier for the root bridge in spanning tree topology.
- Changed property spanningTreePriority (object)
  The STP (Spanning Tree Protocol) bridge priority value for this VLAN, used in root bridge election.
- Changed property spanningTreeProtocol (object)
  The STP (Spanning Tree Protocol) variant enabled for this VLAN.
- Changed property switchFamilyModels (object)
  The set of switch family models with specific configurations for this VLAN across different hardware types.
- Changed property vlanId (object)
  The VLAN identifier, ranging from 1 to 4095, uniquely identifying this VLAN.
- Changed property vlanName (object)
  The descriptive name assigned to this VLAN for identification purposes.

Changed response : 400 Bad Request

Bad/malformed request

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 401 Unauthorized

Unauthorized

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 403 Forbidden

Forbidden

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 404 Not Found

Requested resource or related entity not found

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 422 Unprocessable Entity

Validation error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 500 Internal Server Error

Internal Server Error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

POST /switchProfiles/{switchProfileId}/vlans

Request:

Changed content type : application/json

Added property ipv6DhcpSnooping (object)
Enable IPv6 DHCP snooping to prevent such attacks, DHCPv6 snooping helps to secure the IPv6 address configuration in the network (default: false).
Added property ipv6DhcpSnoopingTrustPort (object)
Comma separated list of trusted port identifiers for IPv6 DHCP snooping.
Added property ipv6DhcpSnoopingTrustPortList (object)
List of individual trusted port identifiers for IPv6 DHCP snooping parsed from ipv6DhcpSnoopingTrustPort.
Added property ipv6DhcpTrustPortsList (object)
List of IPv6 DHCP trusted ports for internal use.
Added property ipv6NdInspection (object)
Enable IPv6 ND (Neighbor Discovery) inspection to prevents IPv6 address spoofing at the switch level (default: false).
Added property ipv6NdInspectionTrustPort (object)
Comma separated list of trusted port identifiers for IPv6 ND (Neighbor Discovery) inspection.
Added property ipv6NdInspectionTrustPortList (object)
List of individual trusted port identifiers for IPv6 ND (Neighbor Discovery) inspection parsed from ipv6NdInspectionTrustPort.
Added property ipv6NdTrustPortsList (object)
List of IPv6 ND (Neighbor Discovery) trusted ports for internal use.
Deleted property defaultVlan (object)
Deleted property deleteVlanEnabled (object)
Deleted property dummyVlan (object)
Deleted property igmpSnoopingTypeChanged (object)
Deleted property notDummyVlan (object)
Deleted property rapidSpanningTreeProtocol (object)
Deleted property switchVlanPortModel (object)
Deleted property taggedPortsList (object)
Deleted property untaggedPortsList (object)
Changed property arpInspection (object)
Enable ARP inspection to prevent ARP spoofing attacks (default: false).
Changed property arpInspectionTrustPort (object)
Comma separated list of trusted port identifiers for ARP inspection.
Changed property arpInspectionTrustPortList (object)
List of individual trusted port identifiers for ARP inspection parsed from arpInspectionTrustPort.
Changed property arpTrustPortsList (object)
List of ARP trusted ports for internal use.
Changed property dhcpTrustPortsList (object)
List of DHCP trusted ports for internal use.
Changed property enableAsDefaultVlan (object)
Flag to enable this VLAN as the default VLAN for the switch (default: false).
Changed property id (object)
Unique identifier for the VLAN configuration.
Changed property igmpSnooping (object)
IGMP snooping mode for multicast traffic optimization.
Changed property ipv4DhcpSnooping (object)
Enable IPv4 DHCP snooping to prevent rogue DHCP servers (default: false).
Changed property ipv4DhcpSnoopingTrustPort (object)
Comma separated list of trusted port identifiers for DHCP snooping.
Changed property ipv4DhcpSnoopingTrustPortList (object)
List of individual trusted port identifiers for DHCP snooping parsed from ipv4DhcpSnoopingTrustPort.
Changed property managementVlan (object)
Flag indicating whether this is a management VLAN for switch management access (default: false).
Changed property multicastVersion (object)
IGMP multicast version (0-3).
Changed property rootBridgeFamilyId (object)
Root bridge family ID for spanning tree protocol.
Changed property spanningTreePriority (object)
Spanning tree priority value for root bridge election (0-65535, default: 32768, lower values have higher priority).
Changed property spanningTreeProtocol (object)
STP (Spanning Tree Protocol) mode for loop prevention.
Changed property switchFamilyModels (object)
Set of switch family model configurations for this VLAN.
Changed property switchId (object)
Switch identifier (serial number) where this VLAN is configured.
Changed property switchVlanPortModels (object)
Set of port model configurations defining which ports are assigned to this VLAN as tagged, untagged, or voice ports.
Changed property vlanId (object)
VLAN identifier number (1-4095).
Changed property vlanName (object)
VLAN name for identification and management purposes.

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

Added property ipv6DhcpSnooping (object)
Enable IPv6 DHCP snooping to prevent such attacks, DHCPv6 snooping helps to secure the IPv6 address configuration in the network (default: false).
Added property ipv6DhcpSnoopingTrustPort (object)
Comma separated list of trusted port identifiers for IPv6 DHCP snooping.
Added property ipv6DhcpSnoopingTrustPortList (object)
List of individual trusted port identifiers for IPv6 DHCP snooping parsed from ipv6DhcpSnoopingTrustPort.
Added property ipv6DhcpTrustPortsList (object)
List of IPv6 DHCP trusted ports for internal use.
Added property ipv6NdInspection (object)
Enable IPv6 ND (Neighbor Discovery) inspection to prevents IPv6 address spoofing at the switch level (default: false).
Added property ipv6NdInspectionTrustPort (object)
Comma separated list of trusted port identifiers for IPv6 ND (Neighbor Discovery) inspection.
Added property ipv6NdInspectionTrustPortList (object)
List of individual trusted port identifiers for IPv6 ND (Neighbor Discovery) inspection parsed from ipv6NdInspectionTrustPort.
Added property ipv6NdTrustPortsList (object)
List of IPv6 ND (Neighbor Discovery) trusted ports for internal use.
Deleted property defaultVlan (object)
Deleted property deleteVlanEnabled (object)
Deleted property dummyVlan (object)
Deleted property igmpSnoopingTypeChanged (object)
Deleted property notDummyVlan (object)
Deleted property rapidSpanningTreeProtocol (object)
Deleted property switchVlanPortModel (object)
Deleted property taggedPortsList (object)
Deleted property untaggedPortsList (object)
Changed property arpInspection (object)
Enable ARP inspection to prevent ARP spoofing attacks (default: false).
Changed property arpInspectionTrustPort (object)
Comma separated list of trusted port identifiers for ARP inspection.
Changed property arpInspectionTrustPortList (object)
List of individual trusted port identifiers for ARP inspection parsed from arpInspectionTrustPort.
Changed property arpTrustPortsList (object)
List of ARP trusted ports for internal use.
Changed property dhcpTrustPortsList (object)
List of DHCP trusted ports for internal use.
Changed property enableAsDefaultVlan (object)
Flag to enable this VLAN as the default VLAN for the switch (default: false).
Changed property id (object)
Unique identifier for the VLAN configuration.
Changed property igmpSnooping (object)
IGMP snooping mode for multicast traffic optimization.
Changed property ipv4DhcpSnooping (object)
Enable IPv4 DHCP snooping to prevent rogue DHCP servers (default: false).
Changed property ipv4DhcpSnoopingTrustPort (object)
Comma separated list of trusted port identifiers for DHCP snooping.
Changed property ipv4DhcpSnoopingTrustPortList (object)
List of individual trusted port identifiers for DHCP snooping parsed from ipv4DhcpSnoopingTrustPort.
Changed property managementVlan (object)
Flag indicating whether this is a management VLAN for switch management access (default: false).
Changed property multicastVersion (object)
IGMP multicast version (0-3).
Changed property rootBridgeFamilyId (object)
Root bridge family ID for spanning tree protocol.
Changed property spanningTreePriority (object)
Spanning tree priority value for root bridge election (0-65535, default: 32768, lower values have higher priority).
Changed property spanningTreeProtocol (object)
STP (Spanning Tree Protocol) mode for loop prevention.
Changed property switchFamilyModels (object)
Set of switch family model configurations for this VLAN.
Changed property switchId (object)
Switch identifier (serial number) where this VLAN is configured.
Changed property switchVlanPortModels (object)
Set of port model configurations defining which ports are assigned to this VLAN as tagged, untagged, or voice ports.
Changed property vlanId (object)
VLAN identifier number (1-4095).
Changed property vlanName (object)
VLAN name for identification and management purposes.

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

Changed property arpInspection (object)
The flag indicating whether ARP inspection is enabled for this VLAN to prevent ARP spoofing attacks.
Changed property igmpSnooping (object)
The IGMP snooping mode for this VLAN to optimize multicast traffic delivery.
Changed property ipv4DhcpSnooping (object)
The flag indicating whether IPv4 DHCP snooping is enabled for this VLAN to prevent rogue DHCP servers.
Changed property multicastVersion (object)
The IGMP version number used for multicast group management in this VLAN.
Changed property spanningTreePriority (object)
The STP (Spanning Tree Protocol) bridge priority value for this VLAN, used in root bridge election.
Changed property spanningTreeProtocol (object)
The STP (Spanning Tree Protocol) variant enabled for this VLAN.
Changed property switchFamilyModels (object)
The set of switch family models with specific port configurations for this VLAN across different hardware types.
Changed property vlanId (object)
The VLAN identifier, ranging from 1 to 4095, uniquely identifying this VLAN in the profile.
Changed property vlanName (object)
The descriptive name assigned to this VLAN for identification purposes.

Return Type:

Changed response : 200 OK

OK

Changed content type : application/json
- Changed property arpInspection (object)
  The flag indicating whether ARP inspection is enabled for this VLAN to prevent ARP spoofing attacks.
- Changed property arpInspectionTrustPort (object)
  The comma separated list of port identifiers trusted for ARP inspection, bypassing ARP validation.
- Changed property id (object)
  The identifier
- Changed property igmpSnooping (object)
  The IGMP snooping mode for this VLAN to optimize multicast traffic delivery.
- Changed property ipv4DhcpSnooping (object)
  The flag indicating whether IPv4 DHCP snooping is enabled for this VLAN to prevent rogue DHCP servers.
- Changed property ipv4DhcpSnoopingTrustPort (object)
  The comma separated list of port identifiers trusted for DHCP snooping, allowing DHCP server responses.
- Changed property multicastVersion (object)
  The IGMP version number used for multicast group management in this VLAN.
- Changed property rootBridgeFamilyId (object)
  The switch family identifier for the root bridge in spanning tree topology.
- Changed property spanningTreePriority (object)
  The STP (Spanning Tree Protocol) bridge priority value for this VLAN, used in root bridge election.
- Changed property spanningTreeProtocol (object)
  The STP (Spanning Tree Protocol) variant enabled for this VLAN.
- Changed property switchFamilyModels (object)
  The set of switch family models with specific configurations for this VLAN across different hardware types.
- Changed property vlanId (object)
  The VLAN identifier, ranging from 1 to 4095, uniquely identifying this VLAN.
- Changed property vlanName (object)
  The descriptive name assigned to this VLAN for identification purposes.
Changed content type : application/vnd.ruckus.v1+json
- Changed property arpInspection (object)
  The flag indicating whether ARP inspection is enabled for this VLAN to prevent ARP spoofing attacks.
- Changed property arpInspectionTrustPort (object)
  The comma separated list of port identifiers trusted for ARP inspection, bypassing ARP validation.
- Changed property id (object)
  The identifier
- Changed property igmpSnooping (object)
  The IGMP snooping mode for this VLAN to optimize multicast traffic delivery.
- Changed property ipv4DhcpSnooping (object)
  The flag indicating whether IPv4 DHCP snooping is enabled for this VLAN to prevent rogue DHCP servers.
- Changed property ipv4DhcpSnoopingTrustPort (object)
  The comma separated list of port identifiers trusted for DHCP snooping, allowing DHCP server responses.
- Changed property multicastVersion (object)
  The IGMP version number used for multicast group management in this VLAN.
- Changed property rootBridgeFamilyId (object)
  The switch family identifier for the root bridge in spanning tree topology.
- Changed property spanningTreePriority (object)
  The STP (Spanning Tree Protocol) bridge priority value for this VLAN, used in root bridge election.
- Changed property spanningTreeProtocol (object)
  The STP (Spanning Tree Protocol) variant enabled for this VLAN.
- Changed property switchFamilyModels (object)
  The set of switch family models with specific configurations for this VLAN across different hardware types.
- Changed property vlanId (object)
  The VLAN identifier, ranging from 1 to 4095, uniquely identifying this VLAN.
- Changed property vlanName (object)
  The descriptive name assigned to this VLAN for identification purposes.

Changed response : 400 Bad Request

Bad/malformed request

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 401 Unauthorized

Unauthorized

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 403 Forbidden

Forbidden

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 404 Not Found

Requested resource or related entity not found

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 422 Unprocessable Entity

Validation error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 500 Internal Server Error

Internal Server Error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 201 Created

Created

Changed content type : application/vnd.ruckus.v1.1+json
- Changed property requestId (object)
  The unique identifier for tracking this API operation request.
- Changed property response (object)
  The profile VLAN, representing a VLAN configuration at the profile level with layer 2 features including DHCP snooping, ARP inspection, IGMP snooping, and spanning tree settings.
  - Changed property arpInspection (object)
    The flag indicating whether ARP inspection is enabled for this VLAN to prevent ARP spoofing attacks.
  - Changed property igmpSnooping (object)
    The IGMP snooping mode for this VLAN to optimize multicast traffic delivery.
  - Changed property ipv4DhcpSnooping (object)
    The flag indicating whether IPv4 DHCP snooping is enabled for this VLAN to prevent rogue DHCP servers.
  - Changed property multicastVersion (object)
    The IGMP version number used for multicast group management in this VLAN.
  - Changed property spanningTreePriority (object)
    The STP (Spanning Tree Protocol) bridge priority value for this VLAN, used in root bridge election.
  - Changed property spanningTreeProtocol (object)
    The STP (Spanning Tree Protocol) variant enabled for this VLAN.
  - Changed property switchFamilyModels (object)
    The set of switch family models with specific port configurations for this VLAN across different hardware types.
  - Changed property vlanId (object)
    The VLAN identifier, ranging from 1 to 4095, uniquely identifying this VLAN in the profile.
  - Changed property vlanName (object)
    The descriptive name assigned to this VLAN for identification purposes.

DELETE /switchProfiles/{switchProfileId}/vlans

Return Type:

Changed response : 400 Bad Request

Bad/malformed request

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 401 Unauthorized

Unauthorized

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 403 Forbidden

Forbidden

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 404 Not Found

Requested resource or related entity not found

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 422 Unprocessable Entity

Validation error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 500 Internal Server Error

Internal Server Error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 200 OK

OK

Changed content type : application/json
- Changed property requestId (object)
  The unique identifier for tracking this API operation request.
- Changed property response (object)
  The empty view representing an API response with no data content, used for operations that return success status without additional information.
Changed content type : application/vnd.ruckus.v1+json
- Changed property requestId (object)
  The unique identifier for tracking this API operation request.
- Changed property response (object)
  The empty view representing an API response with no data content, used for operations that return success status without additional information.

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

Return Type:

Changed response : 200 OK

OK

Changed content type : application/json
- Changed property arpInspection (object)
  The flag indicating whether ARP inspection is enabled for this VLAN to prevent ARP spoofing attacks.
- Changed property arpInspectionTrustPort (object)
  The comma separated list of port identifiers trusted for ARP inspection, bypassing ARP validation.
- Changed property id (object)
  The identifier
- Changed property igmpSnooping (object)
  The IGMP snooping mode for this VLAN to optimize multicast traffic delivery.
- Changed property ipv4DhcpSnooping (object)
  The flag indicating whether IPv4 DHCP snooping is enabled for this VLAN to prevent rogue DHCP servers.
- Changed property ipv4DhcpSnoopingTrustPort (object)
  The comma separated list of port identifiers trusted for DHCP snooping, allowing DHCP server responses.
- Changed property multicastVersion (object)
  The IGMP version number used for multicast group management in this VLAN.
- Changed property rootBridgeFamilyId (object)
  The switch family identifier for the root bridge in spanning tree topology.
- Changed property spanningTreePriority (object)
  The STP (Spanning Tree Protocol) bridge priority value for this VLAN, used in root bridge election.
- Changed property spanningTreeProtocol (object)
  The STP (Spanning Tree Protocol) variant enabled for this VLAN.
- Changed property switchFamilyModels (object)
  The set of switch family models with specific configurations for this VLAN across different hardware types.
- Changed property vlanId (object)
  The VLAN identifier, ranging from 1 to 4095, uniquely identifying this VLAN.
- Changed property vlanName (object)
  The descriptive name assigned to this VLAN for identification purposes.
Changed content type : application/vnd.ruckus.v1+json
- Changed property arpInspection (object)
  The flag indicating whether ARP inspection is enabled for this VLAN to prevent ARP spoofing attacks.
- Changed property arpInspectionTrustPort (object)
  The comma separated list of port identifiers trusted for ARP inspection, bypassing ARP validation.
- Changed property id (object)
  The identifier
- Changed property igmpSnooping (object)
  The IGMP snooping mode for this VLAN to optimize multicast traffic delivery.
- Changed property ipv4DhcpSnooping (object)
  The flag indicating whether IPv4 DHCP snooping is enabled for this VLAN to prevent rogue DHCP servers.
- Changed property ipv4DhcpSnoopingTrustPort (object)
  The comma separated list of port identifiers trusted for DHCP snooping, allowing DHCP server responses.
- Changed property multicastVersion (object)
  The IGMP version number used for multicast group management in this VLAN.
- Changed property rootBridgeFamilyId (object)
  The switch family identifier for the root bridge in spanning tree topology.
- Changed property spanningTreePriority (object)
  The STP (Spanning Tree Protocol) bridge priority value for this VLAN, used in root bridge election.
- Changed property spanningTreeProtocol (object)
  The STP (Spanning Tree Protocol) variant enabled for this VLAN.
- Changed property switchFamilyModels (object)
  The set of switch family models with specific configurations for this VLAN across different hardware types.
- Changed property vlanId (object)
  The VLAN identifier, ranging from 1 to 4095, uniquely identifying this VLAN.
- Changed property vlanName (object)
  The descriptive name assigned to this VLAN for identification purposes.

Changed response : 400 Bad Request

Bad/malformed request

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 401 Unauthorized

Unauthorized

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 403 Forbidden

Forbidden

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 404 Not Found

Requested resource or related entity not found

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 422 Unprocessable Entity

Validation error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 500 Internal Server Error

Internal Server Error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

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

Request:

Changed content type : application/json

Added property ipv6DhcpSnooping (object)
Enable IPv6 DHCP snooping to prevent such attacks, DHCPv6 snooping helps to secure the IPv6 address configuration in the network (default: false).
Added property ipv6DhcpSnoopingTrustPort (object)
Comma separated list of trusted port identifiers for IPv6 DHCP snooping.
Added property ipv6DhcpSnoopingTrustPortList (object)
List of individual trusted port identifiers for IPv6 DHCP snooping parsed from ipv6DhcpSnoopingTrustPort.
Added property ipv6DhcpTrustPortsList (object)
List of IPv6 DHCP trusted ports for internal use.
Added property ipv6NdInspection (object)
Enable IPv6 ND (Neighbor Discovery) inspection to prevents IPv6 address spoofing at the switch level (default: false).
Added property ipv6NdInspectionTrustPort (object)
Comma separated list of trusted port identifiers for IPv6 ND (Neighbor Discovery) inspection.
Added property ipv6NdInspectionTrustPortList (object)
List of individual trusted port identifiers for IPv6 ND (Neighbor Discovery) inspection parsed from ipv6NdInspectionTrustPort.
Added property ipv6NdTrustPortsList (object)
List of IPv6 ND (Neighbor Discovery) trusted ports for internal use.
Deleted property defaultVlan (object)
Deleted property deleteVlanEnabled (object)
Deleted property dummyVlan (object)
Deleted property igmpSnoopingTypeChanged (object)
Deleted property notDummyVlan (object)
Deleted property rapidSpanningTreeProtocol (object)
Deleted property switchVlanPortModel (object)
Deleted property taggedPortsList (object)
Deleted property untaggedPortsList (object)
Changed property arpInspection (object)
Enable ARP inspection to prevent ARP spoofing attacks (default: false).
Changed property arpInspectionTrustPort (object)
Comma separated list of trusted port identifiers for ARP inspection.
Changed property arpInspectionTrustPortList (object)
List of individual trusted port identifiers for ARP inspection parsed from arpInspectionTrustPort.
Changed property arpTrustPortsList (object)
List of ARP trusted ports for internal use.
Changed property dhcpTrustPortsList (object)
List of DHCP trusted ports for internal use.
Changed property enableAsDefaultVlan (object)
Flag to enable this VLAN as the default VLAN for the switch (default: false).
Changed property id (object)
Unique identifier for the VLAN configuration.
Changed property igmpSnooping (object)
IGMP snooping mode for multicast traffic optimization.
Changed property ipv4DhcpSnooping (object)
Enable IPv4 DHCP snooping to prevent rogue DHCP servers (default: false).
Changed property ipv4DhcpSnoopingTrustPort (object)
Comma separated list of trusted port identifiers for DHCP snooping.
Changed property ipv4DhcpSnoopingTrustPortList (object)
List of individual trusted port identifiers for DHCP snooping parsed from ipv4DhcpSnoopingTrustPort.
Changed property managementVlan (object)
Flag indicating whether this is a management VLAN for switch management access (default: false).
Changed property multicastVersion (object)
IGMP multicast version (0-3).
Changed property rootBridgeFamilyId (object)
Root bridge family ID for spanning tree protocol.
Changed property spanningTreePriority (object)
Spanning tree priority value for root bridge election (0-65535, default: 32768, lower values have higher priority).
Changed property spanningTreeProtocol (object)
STP (Spanning Tree Protocol) mode for loop prevention.
Changed property switchFamilyModels (object)
Set of switch family model configurations for this VLAN.
Changed property switchId (object)
Switch identifier (serial number) where this VLAN is configured.
Changed property switchVlanPortModels (object)
Set of port model configurations defining which ports are assigned to this VLAN as tagged, untagged, or voice ports.
Changed property vlanId (object)
VLAN identifier number (1-4095).
Changed property vlanName (object)
VLAN name for identification and management purposes.

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

Added property ipv6DhcpSnooping (object)
Enable IPv6 DHCP snooping to prevent such attacks, DHCPv6 snooping helps to secure the IPv6 address configuration in the network (default: false).
Added property ipv6DhcpSnoopingTrustPort (object)
Comma separated list of trusted port identifiers for IPv6 DHCP snooping.
Added property ipv6DhcpSnoopingTrustPortList (object)
List of individual trusted port identifiers for IPv6 DHCP snooping parsed from ipv6DhcpSnoopingTrustPort.
Added property ipv6DhcpTrustPortsList (object)
List of IPv6 DHCP trusted ports for internal use.
Added property ipv6NdInspection (object)
Enable IPv6 ND (Neighbor Discovery) inspection to prevents IPv6 address spoofing at the switch level (default: false).
Added property ipv6NdInspectionTrustPort (object)
Comma separated list of trusted port identifiers for IPv6 ND (Neighbor Discovery) inspection.
Added property ipv6NdInspectionTrustPortList (object)
List of individual trusted port identifiers for IPv6 ND (Neighbor Discovery) inspection parsed from ipv6NdInspectionTrustPort.
Added property ipv6NdTrustPortsList (object)
List of IPv6 ND (Neighbor Discovery) trusted ports for internal use.
Deleted property defaultVlan (object)
Deleted property deleteVlanEnabled (object)
Deleted property dummyVlan (object)
Deleted property igmpSnoopingTypeChanged (object)
Deleted property notDummyVlan (object)
Deleted property rapidSpanningTreeProtocol (object)
Deleted property switchVlanPortModel (object)
Deleted property taggedPortsList (object)
Deleted property untaggedPortsList (object)
Changed property arpInspection (object)
Enable ARP inspection to prevent ARP spoofing attacks (default: false).
Changed property arpInspectionTrustPort (object)
Comma separated list of trusted port identifiers for ARP inspection.
Changed property arpInspectionTrustPortList (object)
List of individual trusted port identifiers for ARP inspection parsed from arpInspectionTrustPort.
Changed property arpTrustPortsList (object)
List of ARP trusted ports for internal use.
Changed property dhcpTrustPortsList (object)
List of DHCP trusted ports for internal use.
Changed property enableAsDefaultVlan (object)
Flag to enable this VLAN as the default VLAN for the switch (default: false).
Changed property id (object)
Unique identifier for the VLAN configuration.
Changed property igmpSnooping (object)
IGMP snooping mode for multicast traffic optimization.
Changed property ipv4DhcpSnooping (object)
Enable IPv4 DHCP snooping to prevent rogue DHCP servers (default: false).
Changed property ipv4DhcpSnoopingTrustPort (object)
Comma separated list of trusted port identifiers for DHCP snooping.
Changed property ipv4DhcpSnoopingTrustPortList (object)
List of individual trusted port identifiers for DHCP snooping parsed from ipv4DhcpSnoopingTrustPort.
Changed property managementVlan (object)
Flag indicating whether this is a management VLAN for switch management access (default: false).
Changed property multicastVersion (object)
IGMP multicast version (0-3).
Changed property rootBridgeFamilyId (object)
Root bridge family ID for spanning tree protocol.
Changed property spanningTreePriority (object)
Spanning tree priority value for root bridge election (0-65535, default: 32768, lower values have higher priority).
Changed property spanningTreeProtocol (object)
STP (Spanning Tree Protocol) mode for loop prevention.
Changed property switchFamilyModels (object)
Set of switch family model configurations for this VLAN.
Changed property switchId (object)
Switch identifier (serial number) where this VLAN is configured.
Changed property switchVlanPortModels (object)
Set of port model configurations defining which ports are assigned to this VLAN as tagged, untagged, or voice ports.
Changed property vlanId (object)
VLAN identifier number (1-4095).
Changed property vlanName (object)
VLAN name for identification and management purposes.

Return Type:

Changed response : 200 OK

OK

Changed content type : application/json
- Changed property arpInspection (object)
  The flag indicating whether ARP inspection is enabled for this VLAN to prevent ARP spoofing attacks.
- Changed property arpInspectionTrustPort (object)
  The comma separated list of port identifiers trusted for ARP inspection, bypassing ARP validation.
- Changed property id (object)
  The identifier
- Changed property igmpSnooping (object)
  The IGMP snooping mode for this VLAN to optimize multicast traffic delivery.
- Changed property ipv4DhcpSnooping (object)
  The flag indicating whether IPv4 DHCP snooping is enabled for this VLAN to prevent rogue DHCP servers.
- Changed property ipv4DhcpSnoopingTrustPort (object)
  The comma separated list of port identifiers trusted for DHCP snooping, allowing DHCP server responses.
- Changed property multicastVersion (object)
  The IGMP version number used for multicast group management in this VLAN.
- Changed property rootBridgeFamilyId (object)
  The switch family identifier for the root bridge in spanning tree topology.
- Changed property spanningTreePriority (object)
  The STP (Spanning Tree Protocol) bridge priority value for this VLAN, used in root bridge election.
- Changed property spanningTreeProtocol (object)
  The STP (Spanning Tree Protocol) variant enabled for this VLAN.
- Changed property switchFamilyModels (object)
  The set of switch family models with specific configurations for this VLAN across different hardware types.
- Changed property vlanId (object)
  The VLAN identifier, ranging from 1 to 4095, uniquely identifying this VLAN.
- Changed property vlanName (object)
  The descriptive name assigned to this VLAN for identification purposes.
Changed content type : application/vnd.ruckus.v1+json
- Changed property arpInspection (object)
  The flag indicating whether ARP inspection is enabled for this VLAN to prevent ARP spoofing attacks.
- Changed property arpInspectionTrustPort (object)
  The comma separated list of port identifiers trusted for ARP inspection, bypassing ARP validation.
- Changed property id (object)
  The identifier
- Changed property igmpSnooping (object)
  The IGMP snooping mode for this VLAN to optimize multicast traffic delivery.
- Changed property ipv4DhcpSnooping (object)
  The flag indicating whether IPv4 DHCP snooping is enabled for this VLAN to prevent rogue DHCP servers.
- Changed property ipv4DhcpSnoopingTrustPort (object)
  The comma separated list of port identifiers trusted for DHCP snooping, allowing DHCP server responses.
- Changed property multicastVersion (object)
  The IGMP version number used for multicast group management in this VLAN.
- Changed property rootBridgeFamilyId (object)
  The switch family identifier for the root bridge in spanning tree topology.
- Changed property spanningTreePriority (object)
  The STP (Spanning Tree Protocol) bridge priority value for this VLAN, used in root bridge election.
- Changed property spanningTreeProtocol (object)
  The STP (Spanning Tree Protocol) variant enabled for this VLAN.
- Changed property switchFamilyModels (object)
  The set of switch family models with specific configurations for this VLAN across different hardware types.
- Changed property vlanId (object)
  The VLAN identifier, ranging from 1 to 4095, uniquely identifying this VLAN.
- Changed property vlanName (object)
  The descriptive name assigned to this VLAN for identification purposes.

Changed response : 400 Bad Request

Bad/malformed request

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 401 Unauthorized

Unauthorized

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 403 Forbidden

Forbidden

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 404 Not Found

Requested resource or related entity not found

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 422 Unprocessable Entity

Validation error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 500 Internal Server Error

Internal Server Error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

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

Return Type:

Changed response : 400 Bad Request

Bad/malformed request

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 401 Unauthorized

Unauthorized

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 403 Forbidden

Forbidden

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 404 Not Found

Requested resource or related entity not found

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 422 Unprocessable Entity

Validation error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 500 Internal Server Error

Internal Server Error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 200 OK

OK

Changed content type : application/json
- Changed property requestId (object)
  The unique identifier for tracking this API operation request.
- Changed property response (object)
  The empty view representing an API response with no data content, used for operations that return success status without additional information.
Changed content type : application/vnd.ruckus.v1+json
- Changed property requestId (object)
  The unique identifier for tracking this API operation request.
- Changed property response (object)
  The empty view representing an API response with no data content, used for operations that return success status without additional information.

GET /switches

Return Type:

Changed response : 400 Bad Request

Bad/malformed request

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 401 Unauthorized

Unauthorized

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 403 Forbidden

Forbidden

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 404 Not Found

Requested resource or related entity not found

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 422 Unprocessable Entity

Validation error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 500 Internal Server Error

Internal Server Error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 200 OK

OK

Changed content type : application/json
- Changed property defaultGateway (object)
  The default gateway IP address for routing traffic from the switch management interface.
- Changed property description (object)
  The descriptive text providing additional information about the switch configuration or purpose.
- Changed property dhcpClientEnabled (object)
  The flag indicating whether the switch is configured as a DHCP client to obtain its management IP address.
- Changed property dhcpServerEnabled (object)
  The flag indicating whether the DHCP server feature is enabled on the switch.
- Changed property enableStack (object)
  The flag indicating whether switch stacking is enabled for combining multiple physical switches into a single logical unit.
- Changed property firmwareVersion (object)
  The current firmware version running on the switch.
- Changed property id (object)
  The identifier
- Changed property igmpSnooping (object)
  The IGMP snooping mode for multicast traffic optimization: enabled, disabled, or default.
- Changed property initialVlanId (object)
  The VLAN ID used for initial switch configuration and management access.
- Changed property ipAddress (object)
  The IPv4 address assigned to the switch management interface.
- Changed property ipAddressInterface (object)
  The specific interface identifier for the management IP address configuration.
- Changed property ipAddressInterfaceType (object)
  The interface type for the switch management IP address: VLAN interface or management port.
- Changed property ipAddressType (object)
  The IP address assignment method: static or DHCP.
- Changed property jumboMode (object)
  The flag indicating whether jumbo frame support is enabled, allowing frames larger than 1518 bytes.
- Changed property lastDataSyncTime (object)
  The timestamp in milliseconds when the last data synchronization completed for this switch.
- Changed property lastDataSyncTriggerTime (object)
  The timestamp in milliseconds when the last data synchronization was triggered for this switch.
- Changed property name (object)
  The name assigned to the ICX switch for identification in the network.
- Changed property previousMembers (object)
  The set of serial numbers for previous stack members that have been removed from the stack.
- Changed property rearModule (object)
  The model identifier of the rear expansion module installed on the switch, if applicable.
- Changed property softDeletedDate (object)
  The timestamp when the switch was soft deleted, allowing for recovery before permanent deletion.
- Changed property spanningTreePriority (object)
  The STP (Spanning Tree Protocol) bridge priority value, used in root bridge election (lower values have higher priority).
- Changed property specifiedType (object)
  The firmware image type specified for the switch: primary, secondary, or boot.
- Changed property stackConfigTimestamp (object)
  The timestamp indicating when the stack configuration was last modified.
- Changed property stackMembers (object)
  The list of member switches in a stack configuration, including their models and active status.
- Changed property subnetMask (object)
  The subnet mask for the switch management IP address.
- Changed property syncDataEndTime (object)
  The timestamp in milliseconds when the current data synchronization operation ended.
- Changed property syncDataId (object)
  The unique identifier for the current data synchronization operation.
- Changed property syncDataStartTime (object)
  The timestamp in milliseconds when the current data synchronization operation started.
- Changed property tags (object)
  The comma separated list of custom tags assigned to this switch for organization and filtering.
- Changed property trustPorts (object)
  The list of port identifiers configured as trusted ports for DHCP snooping and ARP inspection.
- Changed property venueId (object)
  The unique identifier of the venue where the switch is located.
- Changed property vlanCustomize (object)
  The flag indicating whether VLAN configurations have been customized from default settings.
- Changed property position (object)
  The switch position view, representing the physical location of a switch on a floor plan with x and y coordinates as percentages.
  - Added property xPercent (object)
    The horizontal position of the switch on the floor plan as a percentage of the total width.
  - Added property yPercent (object)
    The vertical position of the switch on the floor plan as a percentage of the total height.
  - Deleted property xpercent (object)
  - Deleted property ypercent (object)
  - Changed property floorplanId (object)
    The identifier of the floor plan where this switch is located.
  - Changed property id (object)
    The identifier
Changed content type : application/vnd.ruckus.v1+json
- Changed property defaultGateway (object)
  The default gateway IP address for routing traffic from the switch management interface.
- Changed property description (object)
  The descriptive text providing additional information about the switch configuration or purpose.
- Changed property dhcpClientEnabled (object)
  The flag indicating whether the switch is configured as a DHCP client to obtain its management IP address.
- Changed property dhcpServerEnabled (object)
  The flag indicating whether the DHCP server feature is enabled on the switch.
- Changed property enableStack (object)
  The flag indicating whether switch stacking is enabled for combining multiple physical switches into a single logical unit.
- Changed property firmwareVersion (object)
  The current firmware version running on the switch.
- Changed property id (object)
  The identifier
- Changed property igmpSnooping (object)
  The IGMP snooping mode for multicast traffic optimization: enabled, disabled, or default.
- Changed property initialVlanId (object)
  The VLAN ID used for initial switch configuration and management access.
- Changed property ipAddress (object)
  The IPv4 address assigned to the switch management interface.
- Changed property ipAddressInterface (object)
  The specific interface identifier for the management IP address configuration.
- Changed property ipAddressInterfaceType (object)
  The interface type for the switch management IP address: VLAN interface or management port.
- Changed property ipAddressType (object)
  The IP address assignment method: static or DHCP.
- Changed property jumboMode (object)
  The flag indicating whether jumbo frame support is enabled, allowing frames larger than 1518 bytes.
- Changed property lastDataSyncTime (object)
  The timestamp in milliseconds when the last data synchronization completed for this switch.
- Changed property lastDataSyncTriggerTime (object)
  The timestamp in milliseconds when the last data synchronization was triggered for this switch.
- Changed property name (object)
  The name assigned to the ICX switch for identification in the network.
- Changed property previousMembers (object)
  The set of serial numbers for previous stack members that have been removed from the stack.
- Changed property rearModule (object)
  The model identifier of the rear expansion module installed on the switch, if applicable.
- Changed property softDeletedDate (object)
  The timestamp when the switch was soft deleted, allowing for recovery before permanent deletion.
- Changed property spanningTreePriority (object)
  The STP (Spanning Tree Protocol) bridge priority value, used in root bridge election (lower values have higher priority).
- Changed property specifiedType (object)
  The firmware image type specified for the switch: primary, secondary, or boot.
- Changed property stackConfigTimestamp (object)
  The timestamp indicating when the stack configuration was last modified.
- Changed property stackMembers (object)
  The list of member switches in a stack configuration, including their models and active status.
- Changed property subnetMask (object)
  The subnet mask for the switch management IP address.
- Changed property syncDataEndTime (object)
  The timestamp in milliseconds when the current data synchronization operation ended.
- Changed property syncDataId (object)
  The unique identifier for the current data synchronization operation.
- Changed property syncDataStartTime (object)
  The timestamp in milliseconds when the current data synchronization operation started.
- Changed property tags (object)
  The comma separated list of custom tags assigned to this switch for organization and filtering.
- Changed property trustPorts (object)
  The list of port identifiers configured as trusted ports for DHCP snooping and ARP inspection.
- Changed property venueId (object)
  The unique identifier of the venue where the switch is located.
- Changed property vlanCustomize (object)
  The flag indicating whether VLAN configurations have been customized from default settings.
- Changed property position (object)
  The switch position view, representing the physical location of a switch on a floor plan with x and y coordinates as percentages.
  - Added property xPercent (object)
    The horizontal position of the switch on the floor plan as a percentage of the total width.
  - Added property yPercent (object)
    The vertical position of the switch on the floor plan as a percentage of the total height.
  - Deleted property xpercent (object)
  - Deleted property ypercent (object)
  - Changed property floorplanId (object)
    The identifier of the floor plan where this switch is located.
  - Changed property id (object)
    The identifier

POST /switches

Return Type:

Changed response : 400 Bad Request

Bad/malformed request

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 401 Unauthorized

Unauthorized

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 403 Forbidden

Forbidden

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 404 Not Found

Requested resource or related entity not found

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 422 Unprocessable Entity

Validation error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 500 Internal Server Error

Internal Server Error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 200 OK

OK

Changed content type : application/json
- Changed property requestId (object)
  The unique identifier for tracking this API operation request.
- Changed property response (object)
  The empty view representing an API response with no data content, used for operations that return success status without additional information.
Changed content type : application/vnd.ruckus.v1+json
- Changed property requestId (object)
  The unique identifier for tracking this API operation request.
- Changed property response (object)
  The empty view representing an API response with no data content, used for operations that return success status without additional information.

DELETE /switches

Return Type:

Changed response : 400 Bad Request

Bad/malformed request

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 401 Unauthorized

Unauthorized

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 403 Forbidden

Forbidden

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 404 Not Found

Requested resource or related entity not found

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 422 Unprocessable Entity

Validation error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 500 Internal Server Error

Internal Server Error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 200 OK

OK

Changed content type : application/json
- Changed property requestId (object)
  The unique identifier for tracking this API operation request.
- Changed property response (object)
  The empty view representing an API response with no data content, used for operations that return success status without additional information.
Changed content type : application/vnd.ruckus.v1+json
- Changed property requestId (object)
  The unique identifier for tracking this API operation request.
- Changed property response (object)
  The empty view representing an API response with no data content, used for operations that return success status without additional information.

DELETE /switches/configBackups

Return Type:

Changed response : 400 Bad Request

Bad/malformed request

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 401 Unauthorized

Unauthorized

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 403 Forbidden

Forbidden

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 404 Not Found

Requested resource or related entity not found

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 422 Unprocessable Entity

Validation error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 500 Internal Server Error

Internal Server Error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 200 OK

OK

Changed content type : application/json
- Changed property requestId (object)
  The unique identifier for tracking this API operation request.
- Changed property response (object)
  The empty view representing an API response with no data content, used for operations that return success status without additional information.
Changed content type : application/vnd.ruckus.v1+json
- Changed property requestId (object)
  The unique identifier for tracking this API operation request.
- Changed property response (object)
  The empty view representing an API response with no data content, used for operations that return success status without additional information.

GET /switches/configBackups/{configBackupId}

Return Type:

Changed response : 200 OK

OK

Changed content type : application/json
- Changed property backupId (object)
  The unique identifier for this configuration backup.
- Changed property backupName (object)
  The descriptive name assigned to this backup for easy identification.
- Changed property backupType (object)
  The type of configuration backup, indicating whether it is automatic, manual, or scheduled.
- Changed property config (object)
  The complete configuration content stored in this backup, containing all switch settings and commands.
- Changed property configBackupViewList (object)
  The list of configuration backup views, used for retrieving multiple backups in a single response.
- Changed property createdDate (object)
  The timestamp when this configuration backup was created.
- Changed property failureReason (object)
  The reason for backup or restore failure, providing details when the operation does not complete successfully.
- Changed property id (object)
  The identifier
- Changed property name (object)
  The name identifier for this configuration backup.
- Changed property restoreStatus (object)
  The status of the last restore operation performed using this backup.
- Changed property restoreTimestamp (object)
  The timestamp when this configuration was last restored to a switch.
- Changed property status (object)
  The current status of this backup, such as completed, in progress, or failed.
- Changed property switchId (object)
  The identifier of the switch that this configuration backup is associated with.
Changed content type : application/vnd.ruckus.v1+json
- Changed property backupId (object)
  The unique identifier for this configuration backup.
- Changed property backupName (object)
  The descriptive name assigned to this backup for easy identification.
- Changed property backupType (object)
  The type of configuration backup, indicating whether it is automatic, manual, or scheduled.
- Changed property config (object)
  The complete configuration content stored in this backup, containing all switch settings and commands.
- Changed property configBackupViewList (object)
  The list of configuration backup views, used for retrieving multiple backups in a single response.
- Changed property createdDate (object)
  The timestamp when this configuration backup was created.
- Changed property failureReason (object)
  The reason for backup or restore failure, providing details when the operation does not complete successfully.
- Changed property id (object)
  The identifier
- Changed property name (object)
  The name identifier for this configuration backup.
- Changed property restoreStatus (object)
  The status of the last restore operation performed using this backup.
- Changed property restoreTimestamp (object)
  The timestamp when this configuration was last restored to a switch.
- Changed property status (object)
  The current status of this backup, such as completed, in progress, or failed.
- Changed property switchId (object)
  The identifier of the switch that this configuration backup is associated with.

Changed response : 400 Bad Request

Bad/malformed request

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 401 Unauthorized

Unauthorized

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 403 Forbidden

Forbidden

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 404 Not Found

Requested resource or related entity not found

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 422 Unprocessable Entity

Validation error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 500 Internal Server Error

Internal Server Error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

PUT /switches/configBackups/{configBackupId}

Return Type:

Changed response : 400 Bad Request

Bad/malformed request

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 401 Unauthorized

Unauthorized

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 403 Forbidden

Forbidden

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 404 Not Found

Requested resource or related entity not found

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 422 Unprocessable Entity

Validation error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 500 Internal Server Error

Internal Server Error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 200 OK

OK

Changed content type : application/json
- Changed property requestId (object)
  The unique identifier for tracking this API operation request.
- Changed property response (object)
  The empty view representing an API response with no data content, used for operations that return success status without additional information.
Changed content type : application/vnd.ruckus.v1+json
- Changed property requestId (object)
  The unique identifier for tracking this API operation request.
- Changed property response (object)
  The empty view representing an API response with no data content, used for operations that return success status without additional information.

DELETE /switches/configBackups/{configBackupId}

Return Type:

Changed response : 400 Bad Request

Bad/malformed request

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 401 Unauthorized

Unauthorized

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 403 Forbidden

Forbidden

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 404 Not Found

Requested resource or related entity not found

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 422 Unprocessable Entity

Validation error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 500 Internal Server Error

Internal Server Error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 200 OK

OK

Changed content type : application/json
- Changed property requestId (object)
  The unique identifier for tracking this API operation request.
- Changed property response (object)
  The empty view representing an API response with no data content, used for operations that return success status without additional information.
Changed content type : application/vnd.ruckus.v1+json
- Changed property requestId (object)
  The unique identifier for tracking this API operation request.
- Changed property response (object)
  The empty view representing an API response with no data content, used for operations that return success status without additional information.

DELETE /switches/lags

Return Type:

Changed response : 400 Bad Request

Bad/malformed request

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 401 Unauthorized

Unauthorized

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 403 Forbidden

Forbidden

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 404 Not Found

Requested resource or related entity not found

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 422 Unprocessable Entity

Validation error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 500 Internal Server Error

Internal Server Error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 200 OK

OK

Changed content type : application/json
- Changed property requestId (object)
  The unique identifier for tracking this API operation request.
- Changed property response (object)
  The empty view representing an API response with no data content, used for operations that return success status without additional information.
Changed content type : application/vnd.ruckus.v1+json
- Changed property requestId (object)
  The unique identifier for tracking this API operation request.
- Changed property response (object)
  The empty view representing an API response with no data content, used for operations that return success status without additional information.

GET /switches/lags/{lagId}

Return Type:

Changed response : 200 OK

OK

Changed content type : application/json
- Changed property addPorts (object)
  The list of port identifiers to be added to this LAG.
- Changed property defaultVlanId (object)
  The default VLAN identifier for the LAG interface.
- Changed property id (object)
  The identifier
- Changed property lagId (object)
  The unique identifier of the LAG interface.
- Changed property lagViewList (object)
  The list of LAG view objects for batch operations.
- Changed property lastName (object)
  The previous name of the LAG interface, used when renaming.
- Changed property name (object)
  The name of the LAG interface, limited to 64 characters without quotes.
- Changed property originalUntaggedVlan (object)
  The original untagged VLAN identifier before modification.
- Changed property portAddVlans (object)
  The list of port VLAN associations to be added for LAG member ports.
- Changed property portVlans (object)
  The list of port VLAN associations for LAG member ports.
- Changed property ports (object)
  The set of physical port identifiers that are members of this LAG.
- Changed property realRemove (object)
  Whether to perform a real removal operation when deleting the LAG.
- Changed property removePorts (object)
  The list of port identifiers to be removed from this LAG.
- Changed property switchId (object)
  The unique identifier of the switch where this LAG is configured.
- Changed property taggedVlans (object)
  The set of VLAN identifiers that are tagged on this LAG interface.
- Changed property tenantId (object)
  The unique identifier of the tenant.
- Changed property type (object)
  The type of LAG protocol, such as static or LACP (Link Aggregation Control Protocol).
- Changed property untaggedVlan (object)
  The VLAN identifier for untagged traffic on this LAG interface.
Changed content type : application/vnd.ruckus.v1+json
- Changed property addPorts (object)
  The list of port identifiers to be added to this LAG.
- Changed property defaultVlanId (object)
  The default VLAN identifier for the LAG interface.
- Changed property id (object)
  The identifier
- Changed property lagId (object)
  The unique identifier of the LAG interface.
- Changed property lagViewList (object)
  The list of LAG view objects for batch operations.
- Changed property lastName (object)
  The previous name of the LAG interface, used when renaming.
- Changed property name (object)
  The name of the LAG interface, limited to 64 characters without quotes.
- Changed property originalUntaggedVlan (object)
  The original untagged VLAN identifier before modification.
- Changed property portAddVlans (object)
  The list of port VLAN associations to be added for LAG member ports.
- Changed property portVlans (object)
  The list of port VLAN associations for LAG member ports.
- Changed property ports (object)
  The set of physical port identifiers that are members of this LAG.
- Changed property realRemove (object)
  Whether to perform a real removal operation when deleting the LAG.
- Changed property removePorts (object)
  The list of port identifiers to be removed from this LAG.
- Changed property switchId (object)
  The unique identifier of the switch where this LAG is configured.
- Changed property taggedVlans (object)
  The set of VLAN identifiers that are tagged on this LAG interface.
- Changed property tenantId (object)
  The unique identifier of the tenant.
- Changed property type (object)
  The type of LAG protocol, such as static or LACP (Link Aggregation Control Protocol).
- Changed property untaggedVlan (object)
  The VLAN identifier for untagged traffic on this LAG interface.

Changed response : 400 Bad Request

Bad/malformed request

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 401 Unauthorized

Unauthorized

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 403 Forbidden

Forbidden

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 404 Not Found

Requested resource or related entity not found

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 422 Unprocessable Entity

Validation error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 500 Internal Server Error

Internal Server Error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

PUT /switches/lags/{lagId}

Request:

Changed content type : application/json

Deleted property dynamicLag (object)
Changed property addPorts (object)
List of port identifiers to be added to this LAG.
Changed property defaultVlanId (object)
Default VLAN ID of the switch (typically '1').
Changed property forceUpPort (object)
Port identifier that is forced to be in 'up' state to keep the LAG operational.
Changed property id (object)
Unique identifier for the LAG.
Changed property lagId (object)
LAG identifier number (1-255, must be unique on the switch).
Changed property lastName (object)
Previous name of the LAG before renaming.
Changed property name (object)
Name of the LAG (1-64 characters, cannot contain quotes).
Changed property originalUntaggedVlan (object)
Original untagged VLAN ID before any modifications.
Changed property portAddVlans (object)
List of port VLAN configurations to be added for LAG member ports.
Changed property portVlans (object)
List of port VLAN configurations for LAG member ports.
Changed property ports (object)
Set of physical port identifiers that are members of this LAG (e.g., ['1/1/1', '1/1/2']).
Changed property removePorts (object)
List of port identifiers to be removed from this LAG.
Changed property switchId (object)
Switch identifier (serial number) where this LAG is configured.
Changed property taggedVlans (object)
Set of tagged VLAN IDs assigned to this LAG interface.
Changed property type (object)
IP address type for the LAG interface (static or dynamic).
Changed property untaggedVlan (object)
Untagged VLAN ID (native VLAN) for this LAG interface.

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

Deleted property dynamicLag (object)
Changed property addPorts (object)
List of port identifiers to be added to this LAG.
Changed property defaultVlanId (object)
Default VLAN ID of the switch (typically '1').
Changed property forceUpPort (object)
Port identifier that is forced to be in 'up' state to keep the LAG operational.
Changed property id (object)
Unique identifier for the LAG.
Changed property lagId (object)
LAG identifier number (1-255, must be unique on the switch).
Changed property lastName (object)
Previous name of the LAG before renaming.
Changed property name (object)
Name of the LAG (1-64 characters, cannot contain quotes).
Changed property originalUntaggedVlan (object)
Original untagged VLAN ID before any modifications.
Changed property portAddVlans (object)
List of port VLAN configurations to be added for LAG member ports.
Changed property portVlans (object)
List of port VLAN configurations for LAG member ports.
Changed property ports (object)
Set of physical port identifiers that are members of this LAG (e.g., ['1/1/1', '1/1/2']).
Changed property removePorts (object)
List of port identifiers to be removed from this LAG.
Changed property switchId (object)
Switch identifier (serial number) where this LAG is configured.
Changed property taggedVlans (object)
Set of tagged VLAN IDs assigned to this LAG interface.
Changed property type (object)
IP address type for the LAG interface (static or dynamic).
Changed property untaggedVlan (object)
Untagged VLAN ID (native VLAN) for this LAG interface.

Return Type:

Changed response : 200 OK

OK

Changed content type : application/json
- Changed property addPorts (object)
  The list of port identifiers to be added to this LAG.
- Changed property defaultVlanId (object)
  The default VLAN identifier for the LAG interface.
- Changed property id (object)
  The identifier
- Changed property lagId (object)
  The unique identifier of the LAG interface.
- Changed property lagViewList (object)
  The list of LAG view objects for batch operations.
- Changed property lastName (object)
  The previous name of the LAG interface, used when renaming.
- Changed property name (object)
  The name of the LAG interface, limited to 64 characters without quotes.
- Changed property originalUntaggedVlan (object)
  The original untagged VLAN identifier before modification.
- Changed property portAddVlans (object)
  The list of port VLAN associations to be added for LAG member ports.
- Changed property portVlans (object)
  The list of port VLAN associations for LAG member ports.
- Changed property ports (object)
  The set of physical port identifiers that are members of this LAG.
- Changed property realRemove (object)
  Whether to perform a real removal operation when deleting the LAG.
- Changed property removePorts (object)
  The list of port identifiers to be removed from this LAG.
- Changed property switchId (object)
  The unique identifier of the switch where this LAG is configured.
- Changed property taggedVlans (object)
  The set of VLAN identifiers that are tagged on this LAG interface.
- Changed property tenantId (object)
  The unique identifier of the tenant.
- Changed property type (object)
  The type of LAG protocol, such as static or LACP (Link Aggregation Control Protocol).
- Changed property untaggedVlan (object)
  The VLAN identifier for untagged traffic on this LAG interface.
Changed content type : application/vnd.ruckus.v1+json
- Changed property addPorts (object)
  The list of port identifiers to be added to this LAG.
- Changed property defaultVlanId (object)
  The default VLAN identifier for the LAG interface.
- Changed property id (object)
  The identifier
- Changed property lagId (object)
  The unique identifier of the LAG interface.
- Changed property lagViewList (object)
  The list of LAG view objects for batch operations.
- Changed property lastName (object)
  The previous name of the LAG interface, used when renaming.
- Changed property name (object)
  The name of the LAG interface, limited to 64 characters without quotes.
- Changed property originalUntaggedVlan (object)
  The original untagged VLAN identifier before modification.
- Changed property portAddVlans (object)
  The list of port VLAN associations to be added for LAG member ports.
- Changed property portVlans (object)
  The list of port VLAN associations for LAG member ports.
- Changed property ports (object)
  The set of physical port identifiers that are members of this LAG.
- Changed property realRemove (object)
  Whether to perform a real removal operation when deleting the LAG.
- Changed property removePorts (object)
  The list of port identifiers to be removed from this LAG.
- Changed property switchId (object)
  The unique identifier of the switch where this LAG is configured.
- Changed property taggedVlans (object)
  The set of VLAN identifiers that are tagged on this LAG interface.
- Changed property tenantId (object)
  The unique identifier of the tenant.
- Changed property type (object)
  The type of LAG protocol, such as static or LACP (Link Aggregation Control Protocol).
- Changed property untaggedVlan (object)
  The VLAN identifier for untagged traffic on this LAG interface.

Changed response : 400 Bad Request

Bad/malformed request

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 401 Unauthorized

Unauthorized

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 403 Forbidden

Forbidden

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 404 Not Found

Requested resource or related entity not found

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 422 Unprocessable Entity

Validation error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 500 Internal Server Error

Internal Server Error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

DELETE /switches/lags/{lagId}

Return Type:

Changed response : 400 Bad Request

Bad/malformed request

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 401 Unauthorized

Unauthorized

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 403 Forbidden

Forbidden

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 404 Not Found

Requested resource or related entity not found

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 422 Unprocessable Entity

Validation error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 500 Internal Server Error

Internal Server Error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 200 OK

OK

Changed content type : application/json
- Changed property requestId (object)
  The unique identifier for tracking this API operation request.
- Changed property response (object)
  The empty view representing an API response with no data content, used for operations that return success status without additional information.
Changed content type : application/vnd.ruckus.v1+json
- Changed property requestId (object)
  The unique identifier for tracking this API operation request.
- Changed property response (object)
  The empty view representing an API response with no data content, used for operations that return success status without additional information.

PUT /switches/portSettings

Return Type:

Changed response : 400 Bad Request

Bad/malformed request

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 401 Unauthorized

Unauthorized

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 403 Forbidden

Forbidden

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 404 Not Found

Requested resource or related entity not found

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 422 Unprocessable Entity

Validation error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 500 Internal Server Error

Internal Server Error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 200 OK

OK

Changed content type : application/json
- Added property ipv6DhcpSnoopingTrust (object)
  The flag indicating whether this port is trusted for IPv6 DHCP snooping, bypassing DHCP validation.
- Added property ipv6NdInspectionTrust (object)
  The flag indicating whether this port is trusted for IPv6 ND (Neighbor Discovery) inspection, bypassing ND validation.
- Changed property adminPtToPt (object)
  The RSTP (Rapid Spanning Tree Protocol) point-to-point MAC mode.
- Changed property arpInspectionTrust (object)
  The flag indicating whether this port is trusted for ARP inspection, bypassing ARP validation.
- Changed property dhcpSnoopingTrust (object)
  The flag indicating whether this port is trusted for DHCP snooping, allowing DHCP server responses.
- Changed property egressAcl (object)
  The name of the Access Control List applied to egress (outgoing) traffic on this port.
- Changed property id (object)
  The identifier
- Changed property ignoreFields (object)
  The comma separated list of field names to ignore during update operations.
- Changed property ingressAcl (object)
  The name of the Access Control List applied to ingress (incoming) traffic on this port.
- Changed property ipsg (object)
  The flag indicating whether IP source guard is enabled for additional layer 2 security.
- Changed property lldpEnable (object)
  The flag indicating whether LLDP (Link Layer Discovery Protocol) is enabled on this port.
- Changed property lldpQos (object)
  The set of LLDP (Link Layer Discovery Protocol) QoS (Quality of Service) configurations for network priority advertising.
- Changed property name (object)
  The descriptive name or label assigned to the port for identification purposes.
- Changed property poeBudget (object)
  The PoE power budget allocated to this port in watts.
- Changed property poeCapability (object)
  The flag indicating whether this port has PoE (Power over Ethernet) hardware capability.
- Changed property poeClass (object)
  The PoE (Power over Ethernet) class indicating the maximum power level supported by the connected device.
- Changed property poeEnable (object)
  The flag indicating whether PoE (Power over Ethernet) is enabled on this port.
- Changed property poePriority (object)
  The PoE priority level for power allocation, with lower values indicating higher priority.
- Changed property portEnable (object)
  The flag indicating whether the port is administratively enabled for traffic forwarding.
- Changed property portProtected (object)
  The flag indicating whether the port is configured as a protected port, preventing communication with other protected ports.
- Changed property portSpeed (object)
  The configured speed setting for the port, such as auto negotiation or specific speed values.
- Changed property ports (object)
  The set of port identifiers when performing batch operations on multiple ports.
- Changed property profileName (object)
  The name of the profile applied to this port, displayed in the UI for reference.
- Changed property revert (object)
  The flag indicating whether to revert port configuration to profile defaults.
- Changed property rstpAdminEdgePort (object)
  The flag indicating whether this port is configured as an edge port in RSTP (Rapid Spanning Tree Protocol).
- Changed property stpBpduGuard (object)
  Indicates whether STP (Spanning Tree Protocol) BPDU (Bridge Protocol Data Unit) guard is enabled. When enabled, the port is disabled if BPDU frames are received.
- Changed property stpRootGuard (object)
  The flag indicating whether STP (Spanning Tree Protocol) root guard is enabled to prevent the port from becoming a root port.
- Changed property switchId (object)
  The unique identifier of the switch where this port is located.
- Changed property switchMac (object)
  The MAC address of the switch to which this port belongs, used for UI identification.
- Changed property taggedVlans (object)
  The ordered set of VLAN IDs configured as tagged VLANs on this port for 802.1Q trunking.
- Changed property tags (object)
  The comma separated list of custom tags assigned to this port for organization and filtering.
- Changed property untaggedVlan (object)
  The VLAN ID configured as the untagged (native) VLAN for this port.
- Changed property voiceVlan (object)
  The VLAN ID designated for voice traffic, typically used for VoIP devices.
- Changed property vsixEgressAcl (object)
  The name of the IPV6 ACL applied to egress traffic for virtual switch integration.
- Changed property vsixIngressAcl (object)
  The name of the IPv6 ACL applied to ingress traffic for virtual switch integration.
- Changed property lag (object)
  The LAG (Link Aggregation Group) view, representing a logical interface that bundles multiple physical ports for increased bandwidth and redundancy.
  - Changed property addPorts (object)
    The list of port identifiers to be added to this LAG.
  - Changed property defaultVlanId (object)
    The default VLAN identifier for the LAG interface.
  - Changed property id (object)
    The identifier
  - Changed property lagId (object)
    The unique identifier of the LAG interface.
  - Changed property lagViewList (object)
    The list of LAG view objects for batch operations.
  - Changed property lastName (object)
    The previous name of the LAG interface, used when renaming.
  - Changed property name (object)
    The name of the LAG interface, limited to 64 characters without quotes.
  - Changed property originalUntaggedVlan (object)
    The original untagged VLAN identifier before modification.
  - Changed property portAddVlans (object)
    The list of port VLAN associations to be added for LAG member ports.
  - Changed property portVlans (object)
    The list of port VLAN associations for LAG member ports.
  - Changed property ports (object)
    The set of physical port identifiers that are members of this LAG.
  - Changed property realRemove (object)
    Whether to perform a real removal operation when deleting the LAG.
  - Changed property removePorts (object)
    The list of port identifiers to be removed from this LAG.
  - Changed property switchId (object)
    The unique identifier of the switch where this LAG is configured.
  - Changed property taggedVlans (object)
    The set of VLAN identifiers that are tagged on this LAG interface.
  - Changed property tenantId (object)
    The unique identifier of the tenant.
  - Changed property type (object)
    The type of LAG protocol, such as static or LACP (Link Aggregation Control Protocol).
  - Changed property untaggedVlan (object)
    The VLAN identifier for untagged traffic on this LAG interface.
Changed content type : application/vnd.ruckus.v1+json
- Added property ipv6DhcpSnoopingTrust (object)
  The flag indicating whether this port is trusted for IPv6 DHCP snooping, bypassing DHCP validation.
- Added property ipv6NdInspectionTrust (object)
  The flag indicating whether this port is trusted for IPv6 ND (Neighbor Discovery) inspection, bypassing ND validation.
- Changed property adminPtToPt (object)
  The RSTP (Rapid Spanning Tree Protocol) point-to-point MAC mode.
- Changed property arpInspectionTrust (object)
  The flag indicating whether this port is trusted for ARP inspection, bypassing ARP validation.
- Changed property dhcpSnoopingTrust (object)
  The flag indicating whether this port is trusted for DHCP snooping, allowing DHCP server responses.
- Changed property egressAcl (object)
  The name of the Access Control List applied to egress (outgoing) traffic on this port.
- Changed property id (object)
  The identifier
- Changed property ignoreFields (object)
  The comma separated list of field names to ignore during update operations.
- Changed property ingressAcl (object)
  The name of the Access Control List applied to ingress (incoming) traffic on this port.
- Changed property ipsg (object)
  The flag indicating whether IP source guard is enabled for additional layer 2 security.
- Changed property lldpEnable (object)
  The flag indicating whether LLDP (Link Layer Discovery Protocol) is enabled on this port.
- Changed property lldpQos (object)
  The set of LLDP (Link Layer Discovery Protocol) QoS (Quality of Service) configurations for network priority advertising.
- Changed property name (object)
  The descriptive name or label assigned to the port for identification purposes.
- Changed property poeBudget (object)
  The PoE power budget allocated to this port in watts.
- Changed property poeCapability (object)
  The flag indicating whether this port has PoE (Power over Ethernet) hardware capability.
- Changed property poeClass (object)
  The PoE (Power over Ethernet) class indicating the maximum power level supported by the connected device.
- Changed property poeEnable (object)
  The flag indicating whether PoE (Power over Ethernet) is enabled on this port.
- Changed property poePriority (object)
  The PoE priority level for power allocation, with lower values indicating higher priority.
- Changed property portEnable (object)
  The flag indicating whether the port is administratively enabled for traffic forwarding.
- Changed property portProtected (object)
  The flag indicating whether the port is configured as a protected port, preventing communication with other protected ports.
- Changed property portSpeed (object)
  The configured speed setting for the port, such as auto negotiation or specific speed values.
- Changed property ports (object)
  The set of port identifiers when performing batch operations on multiple ports.
- Changed property profileName (object)
  The name of the profile applied to this port, displayed in the UI for reference.
- Changed property revert (object)
  The flag indicating whether to revert port configuration to profile defaults.
- Changed property rstpAdminEdgePort (object)
  The flag indicating whether this port is configured as an edge port in RSTP (Rapid Spanning Tree Protocol).
- Changed property stpBpduGuard (object)
  Indicates whether STP (Spanning Tree Protocol) BPDU (Bridge Protocol Data Unit) guard is enabled. When enabled, the port is disabled if BPDU frames are received.
- Changed property stpRootGuard (object)
  The flag indicating whether STP (Spanning Tree Protocol) root guard is enabled to prevent the port from becoming a root port.
- Changed property switchId (object)
  The unique identifier of the switch where this port is located.
- Changed property switchMac (object)
  The MAC address of the switch to which this port belongs, used for UI identification.
- Changed property taggedVlans (object)
  The ordered set of VLAN IDs configured as tagged VLANs on this port for 802.1Q trunking.
- Changed property tags (object)
  The comma separated list of custom tags assigned to this port for organization and filtering.
- Changed property untaggedVlan (object)
  The VLAN ID configured as the untagged (native) VLAN for this port.
- Changed property voiceVlan (object)
  The VLAN ID designated for voice traffic, typically used for VoIP devices.
- Changed property vsixEgressAcl (object)
  The name of the IPV6 ACL applied to egress traffic for virtual switch integration.
- Changed property vsixIngressAcl (object)
  The name of the IPv6 ACL applied to ingress traffic for virtual switch integration.
- Changed property lag (object)
  The LAG (Link Aggregation Group) view, representing a logical interface that bundles multiple physical ports for increased bandwidth and redundancy.
  - Changed property addPorts (object)
    The list of port identifiers to be added to this LAG.
  - Changed property defaultVlanId (object)
    The default VLAN identifier for the LAG interface.
  - Changed property id (object)
    The identifier
  - Changed property lagId (object)
    The unique identifier of the LAG interface.
  - Changed property lagViewList (object)
    The list of LAG view objects for batch operations.
  - Changed property lastName (object)
    The previous name of the LAG interface, used when renaming.
  - Changed property name (object)
    The name of the LAG interface, limited to 64 characters without quotes.
  - Changed property originalUntaggedVlan (object)
    The original untagged VLAN identifier before modification.
  - Changed property portAddVlans (object)
    The list of port VLAN associations to be added for LAG member ports.
  - Changed property portVlans (object)
    The list of port VLAN associations for LAG member ports.
  - Changed property ports (object)
    The set of physical port identifiers that are members of this LAG.
  - Changed property realRemove (object)
    Whether to perform a real removal operation when deleting the LAG.
  - Changed property removePorts (object)
    The list of port identifiers to be removed from this LAG.
  - Changed property switchId (object)
    The unique identifier of the switch where this LAG is configured.
  - Changed property taggedVlans (object)
    The set of VLAN identifiers that are tagged on this LAG interface.
  - Changed property tenantId (object)
    The unique identifier of the tenant.
  - Changed property type (object)
    The type of LAG protocol, such as static or LACP (Link Aggregation Control Protocol).
  - Changed property untaggedVlan (object)
    The VLAN identifier for untagged traffic on this LAG interface.

POST /switches/portSettings

Return Type:

Changed response : 400 Bad Request

Bad/malformed request

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 401 Unauthorized

Unauthorized

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 403 Forbidden

Forbidden

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 404 Not Found

Requested resource or related entity not found

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 422 Unprocessable Entity

Validation error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 500 Internal Server Error

Internal Server Error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 200 OK

OK

Changed content type : application/json
- Added property ipv6DhcpSnoopingTrust (object)
  The flag indicating whether this port is trusted for IPv6 DHCP snooping, bypassing DHCP validation.
- Added property ipv6NdInspectionTrust (object)
  The flag indicating whether this port is trusted for IPv6 ND (Neighbor Discovery) inspection, bypassing ND validation.
- Changed property adminPtToPt (object)
  The RSTP (Rapid Spanning Tree Protocol) point-to-point MAC mode.
- Changed property arpInspectionTrust (object)
  The flag indicating whether this port is trusted for ARP inspection, bypassing ARP validation.
- Changed property dhcpSnoopingTrust (object)
  The flag indicating whether this port is trusted for DHCP snooping, allowing DHCP server responses.
- Changed property egressAcl (object)
  The name of the Access Control List applied to egress (outgoing) traffic on this port.
- Changed property id (object)
  The identifier
- Changed property ignoreFields (object)
  The comma separated list of field names to ignore during update operations.
- Changed property ingressAcl (object)
  The name of the Access Control List applied to ingress (incoming) traffic on this port.
- Changed property ipsg (object)
  The flag indicating whether IP source guard is enabled for additional layer 2 security.
- Changed property lldpEnable (object)
  The flag indicating whether LLDP (Link Layer Discovery Protocol) is enabled on this port.
- Changed property lldpQos (object)
  The set of LLDP (Link Layer Discovery Protocol) QoS (Quality of Service) configurations for network priority advertising.
- Changed property name (object)
  The descriptive name or label assigned to the port for identification purposes.
- Changed property poeBudget (object)
  The PoE power budget allocated to this port in watts.
- Changed property poeCapability (object)
  The flag indicating whether this port has PoE (Power over Ethernet) hardware capability.
- Changed property poeClass (object)
  The PoE (Power over Ethernet) class indicating the maximum power level supported by the connected device.
- Changed property poeEnable (object)
  The flag indicating whether PoE (Power over Ethernet) is enabled on this port.
- Changed property poePriority (object)
  The PoE priority level for power allocation, with lower values indicating higher priority.
- Changed property portEnable (object)
  The flag indicating whether the port is administratively enabled for traffic forwarding.
- Changed property portProtected (object)
  The flag indicating whether the port is configured as a protected port, preventing communication with other protected ports.
- Changed property portSpeed (object)
  The configured speed setting for the port, such as auto negotiation or specific speed values.
- Changed property ports (object)
  The set of port identifiers when performing batch operations on multiple ports.
- Changed property profileName (object)
  The name of the profile applied to this port, displayed in the UI for reference.
- Changed property revert (object)
  The flag indicating whether to revert port configuration to profile defaults.
- Changed property rstpAdminEdgePort (object)
  The flag indicating whether this port is configured as an edge port in RSTP (Rapid Spanning Tree Protocol).
- Changed property stpBpduGuard (object)
  Indicates whether STP (Spanning Tree Protocol) BPDU (Bridge Protocol Data Unit) guard is enabled. When enabled, the port is disabled if BPDU frames are received.
- Changed property stpRootGuard (object)
  The flag indicating whether STP (Spanning Tree Protocol) root guard is enabled to prevent the port from becoming a root port.
- Changed property switchId (object)
  The unique identifier of the switch where this port is located.
- Changed property switchMac (object)
  The MAC address of the switch to which this port belongs, used for UI identification.
- Changed property taggedVlans (object)
  The ordered set of VLAN IDs configured as tagged VLANs on this port for 802.1Q trunking.
- Changed property tags (object)
  The comma separated list of custom tags assigned to this port for organization and filtering.
- Changed property untaggedVlan (object)
  The VLAN ID configured as the untagged (native) VLAN for this port.
- Changed property voiceVlan (object)
  The VLAN ID designated for voice traffic, typically used for VoIP devices.
- Changed property vsixEgressAcl (object)
  The name of the IPV6 ACL applied to egress traffic for virtual switch integration.
- Changed property vsixIngressAcl (object)
  The name of the IPv6 ACL applied to ingress traffic for virtual switch integration.
- Changed property lag (object)
  The LAG (Link Aggregation Group) view, representing a logical interface that bundles multiple physical ports for increased bandwidth and redundancy.
  - Changed property addPorts (object)
    The list of port identifiers to be added to this LAG.
  - Changed property defaultVlanId (object)
    The default VLAN identifier for the LAG interface.
  - Changed property id (object)
    The identifier
  - Changed property lagId (object)
    The unique identifier of the LAG interface.
  - Changed property lagViewList (object)
    The list of LAG view objects for batch operations.
  - Changed property lastName (object)
    The previous name of the LAG interface, used when renaming.
  - Changed property name (object)
    The name of the LAG interface, limited to 64 characters without quotes.
  - Changed property originalUntaggedVlan (object)
    The original untagged VLAN identifier before modification.
  - Changed property portAddVlans (object)
    The list of port VLAN associations to be added for LAG member ports.
  - Changed property portVlans (object)
    The list of port VLAN associations for LAG member ports.
  - Changed property ports (object)
    The set of physical port identifiers that are members of this LAG.
  - Changed property realRemove (object)
    Whether to perform a real removal operation when deleting the LAG.
  - Changed property removePorts (object)
    The list of port identifiers to be removed from this LAG.
  - Changed property switchId (object)
    The unique identifier of the switch where this LAG is configured.
  - Changed property taggedVlans (object)
    The set of VLAN identifiers that are tagged on this LAG interface.
  - Changed property tenantId (object)
    The unique identifier of the tenant.
  - Changed property type (object)
    The type of LAG protocol, such as static or LACP (Link Aggregation Control Protocol).
  - Changed property untaggedVlan (object)
    The VLAN identifier for untagged traffic on this LAG interface.
Changed content type : application/vnd.ruckus.v1+json
- Added property ipv6DhcpSnoopingTrust (object)
  The flag indicating whether this port is trusted for IPv6 DHCP snooping, bypassing DHCP validation.
- Added property ipv6NdInspectionTrust (object)
  The flag indicating whether this port is trusted for IPv6 ND (Neighbor Discovery) inspection, bypassing ND validation.
- Changed property adminPtToPt (object)
  The RSTP (Rapid Spanning Tree Protocol) point-to-point MAC mode.
- Changed property arpInspectionTrust (object)
  The flag indicating whether this port is trusted for ARP inspection, bypassing ARP validation.
- Changed property dhcpSnoopingTrust (object)
  The flag indicating whether this port is trusted for DHCP snooping, allowing DHCP server responses.
- Changed property egressAcl (object)
  The name of the Access Control List applied to egress (outgoing) traffic on this port.
- Changed property id (object)
  The identifier
- Changed property ignoreFields (object)
  The comma separated list of field names to ignore during update operations.
- Changed property ingressAcl (object)
  The name of the Access Control List applied to ingress (incoming) traffic on this port.
- Changed property ipsg (object)
  The flag indicating whether IP source guard is enabled for additional layer 2 security.
- Changed property lldpEnable (object)
  The flag indicating whether LLDP (Link Layer Discovery Protocol) is enabled on this port.
- Changed property lldpQos (object)
  The set of LLDP (Link Layer Discovery Protocol) QoS (Quality of Service) configurations for network priority advertising.
- Changed property name (object)
  The descriptive name or label assigned to the port for identification purposes.
- Changed property poeBudget (object)
  The PoE power budget allocated to this port in watts.
- Changed property poeCapability (object)
  The flag indicating whether this port has PoE (Power over Ethernet) hardware capability.
- Changed property poeClass (object)
  The PoE (Power over Ethernet) class indicating the maximum power level supported by the connected device.
- Changed property poeEnable (object)
  The flag indicating whether PoE (Power over Ethernet) is enabled on this port.
- Changed property poePriority (object)
  The PoE priority level for power allocation, with lower values indicating higher priority.
- Changed property portEnable (object)
  The flag indicating whether the port is administratively enabled for traffic forwarding.
- Changed property portProtected (object)
  The flag indicating whether the port is configured as a protected port, preventing communication with other protected ports.
- Changed property portSpeed (object)
  The configured speed setting for the port, such as auto negotiation or specific speed values.
- Changed property ports (object)
  The set of port identifiers when performing batch operations on multiple ports.
- Changed property profileName (object)
  The name of the profile applied to this port, displayed in the UI for reference.
- Changed property revert (object)
  The flag indicating whether to revert port configuration to profile defaults.
- Changed property rstpAdminEdgePort (object)
  The flag indicating whether this port is configured as an edge port in RSTP (Rapid Spanning Tree Protocol).
- Changed property stpBpduGuard (object)
  Indicates whether STP (Spanning Tree Protocol) BPDU (Bridge Protocol Data Unit) guard is enabled. When enabled, the port is disabled if BPDU frames are received.
- Changed property stpRootGuard (object)
  The flag indicating whether STP (Spanning Tree Protocol) root guard is enabled to prevent the port from becoming a root port.
- Changed property switchId (object)
  The unique identifier of the switch where this port is located.
- Changed property switchMac (object)
  The MAC address of the switch to which this port belongs, used for UI identification.
- Changed property taggedVlans (object)
  The ordered set of VLAN IDs configured as tagged VLANs on this port for 802.1Q trunking.
- Changed property tags (object)
  The comma separated list of custom tags assigned to this port for organization and filtering.
- Changed property untaggedVlan (object)
  The VLAN ID configured as the untagged (native) VLAN for this port.
- Changed property voiceVlan (object)
  The VLAN ID designated for voice traffic, typically used for VoIP devices.
- Changed property vsixEgressAcl (object)
  The name of the IPV6 ACL applied to egress traffic for virtual switch integration.
- Changed property vsixIngressAcl (object)
  The name of the IPv6 ACL applied to ingress traffic for virtual switch integration.
- Changed property lag (object)
  The LAG (Link Aggregation Group) view, representing a logical interface that bundles multiple physical ports for increased bandwidth and redundancy.
  - Changed property addPorts (object)
    The list of port identifiers to be added to this LAG.
  - Changed property defaultVlanId (object)
    The default VLAN identifier for the LAG interface.
  - Changed property id (object)
    The identifier
  - Changed property lagId (object)
    The unique identifier of the LAG interface.
  - Changed property lagViewList (object)
    The list of LAG view objects for batch operations.
  - Changed property lastName (object)
    The previous name of the LAG interface, used when renaming.
  - Changed property name (object)
    The name of the LAG interface, limited to 64 characters without quotes.
  - Changed property originalUntaggedVlan (object)
    The original untagged VLAN identifier before modification.
  - Changed property portAddVlans (object)
    The list of port VLAN associations to be added for LAG member ports.
  - Changed property portVlans (object)
    The list of port VLAN associations for LAG member ports.
  - Changed property ports (object)
    The set of physical port identifiers that are members of this LAG.
  - Changed property realRemove (object)
    Whether to perform a real removal operation when deleting the LAG.
  - Changed property removePorts (object)
    The list of port identifiers to be removed from this LAG.
  - Changed property switchId (object)
    The unique identifier of the switch where this LAG is configured.
  - Changed property taggedVlans (object)
    The set of VLAN identifiers that are tagged on this LAG interface.
  - Changed property tenantId (object)
    The unique identifier of the tenant.
  - Changed property type (object)
    The type of LAG protocol, such as static or LACP (Link Aggregation Control Protocol).
  - Changed property untaggedVlan (object)
    The VLAN identifier for untagged traffic on this LAG interface.

DELETE /switches/staticRoutes

Return Type:

Changed response : 400 Bad Request

Bad/malformed request

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 401 Unauthorized

Unauthorized

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 403 Forbidden

Forbidden

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 404 Not Found

Requested resource or related entity not found

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 422 Unprocessable Entity

Validation error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 500 Internal Server Error

Internal Server Error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 200 OK

OK

Changed content type : application/json
- Changed property requestId (object)
  The unique identifier for tracking this API operation request.
- Changed property response (object)
  The empty view representing an API response with no data content, used for operations that return success status without additional information.
Changed content type : application/vnd.ruckus.v1+json
- Changed property requestId (object)
  The unique identifier for tracking this API operation request.
- Changed property response (object)
  The empty view representing an API response with no data content, used for operations that return success status without additional information.

GET /switches/staticRoutes/{staticRouteId}

Return Type:

Changed response : 200 OK

OK

Changed content type : application/json
New required properties:
- destinationIp
- nextHop
- Changed property adminDistance (object)
  The administrative distance value for route preference, with lower values having higher priority.
- Changed property destinationIp (object)
  The destination IP address in CIDR notation. For IPv4: '192.168.10.0/24', For IPv6: '2001:db8::/32'.
- Changed property id (object)
  The unique identifier of the static route configuration.
- Changed property nextHop (object)
  The IP address of the next hop gateway to route traffic. For IPv4: '192.168.1.1', For IPv6: '2001:db8::1'.
- Changed property staticRouteViewList (object)
  The list of static route configurations for batch operations or nested route management.
Changed content type : application/vnd.ruckus.v1+json
New required properties:
- destinationIp
- nextHop
- Changed property adminDistance (object)
  The administrative distance value for route preference, with lower values having higher priority.
- Changed property destinationIp (object)
  The destination IP address in CIDR notation. For IPv4: '192.168.10.0/24', For IPv6: '2001:db8::/32'.
- Changed property id (object)
  The unique identifier of the static route configuration.
- Changed property nextHop (object)
  The IP address of the next hop gateway to route traffic. For IPv4: '192.168.1.1', For IPv6: '2001:db8::1'.
- Changed property staticRouteViewList (object)
  The list of static route configurations for batch operations or nested route management.

Changed response : 400 Bad Request

Bad/malformed request

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 401 Unauthorized

Unauthorized

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 403 Forbidden

Forbidden

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 404 Not Found

Requested resource or related entity not found

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 422 Unprocessable Entity

Validation error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 500 Internal Server Error

Internal Server Error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

PUT /switches/staticRoutes/{staticRouteId}

Request:

Changed content type : application/json

New required properties:

destinationIp
nextHop

Deleted property uniqueValue (object)
Changed property adminDistance (object)
Administrative distance for route priority (1-255, lower values have higher priority).
Changed property destinationIp (object)
Destination IP address in CIDR notation. For IPv4: '192.168.10.0/24', For IPv6: '2001:db8::/32'.
Changed property id (object)
Unique identifier for the static route.
Changed property nextHop (object)
Next hop IP address where packets matching the destination will be forwarded. For IPv4: '192.168.1.1', For IPv6: '2001:db8::1'.

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

New required properties:

destinationIp
nextHop

Deleted property uniqueValue (object)
Changed property adminDistance (object)
Administrative distance for route priority (1-255, lower values have higher priority).
Changed property destinationIp (object)
Destination IP address in CIDR notation. For IPv4: '192.168.10.0/24', For IPv6: '2001:db8::/32'.
Changed property id (object)
Unique identifier for the static route.
Changed property nextHop (object)
Next hop IP address where packets matching the destination will be forwarded. For IPv4: '192.168.1.1', For IPv6: '2001:db8::1'.

Return Type:

Changed response : 200 OK

OK

Changed content type : application/json
New required properties:
- destinationIp
- nextHop
- Changed property adminDistance (object)
  The administrative distance value for route preference, with lower values having higher priority.
- Changed property destinationIp (object)
  The destination IP address in CIDR notation. For IPv4: '192.168.10.0/24', For IPv6: '2001:db8::/32'.
- Changed property id (object)
  The unique identifier of the static route configuration.
- Changed property nextHop (object)
  The IP address of the next hop gateway to route traffic. For IPv4: '192.168.1.1', For IPv6: '2001:db8::1'.
- Changed property staticRouteViewList (object)
  The list of static route configurations for batch operations or nested route management.
Changed content type : application/vnd.ruckus.v1+json
New required properties:
- destinationIp
- nextHop
- Changed property adminDistance (object)
  The administrative distance value for route preference, with lower values having higher priority.
- Changed property destinationIp (object)
  The destination IP address in CIDR notation. For IPv4: '192.168.10.0/24', For IPv6: '2001:db8::/32'.
- Changed property id (object)
  The unique identifier of the static route configuration.
- Changed property nextHop (object)
  The IP address of the next hop gateway to route traffic. For IPv4: '192.168.1.1', For IPv6: '2001:db8::1'.
- Changed property staticRouteViewList (object)
  The list of static route configurations for batch operations or nested route management.

Changed response : 400 Bad Request

Bad/malformed request

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 401 Unauthorized

Unauthorized

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 403 Forbidden

Forbidden

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 404 Not Found

Requested resource or related entity not found

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 422 Unprocessable Entity

Validation error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 500 Internal Server Error

Internal Server Error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

DELETE /switches/staticRoutes/{staticRouteId}

Return Type:

Changed response : 400 Bad Request

Bad/malformed request

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 401 Unauthorized

Unauthorized

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 403 Forbidden

Forbidden

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 404 Not Found

Requested resource or related entity not found

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 422 Unprocessable Entity

Validation error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 500 Internal Server Error

Internal Server Error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 200 OK

OK

Changed content type : application/json
- Changed property requestId (object)
  The unique identifier for tracking this API operation request.
- Changed property response (object)
  The empty view representing an API response with no data content, used for operations that return success status without additional information.
Changed content type : application/vnd.ruckus.v1+json
- Changed property requestId (object)
  The unique identifier for tracking this API operation request.
- Changed property response (object)
  The empty view representing an API response with no data content, used for operations that return success status without additional information.

DELETE /switches/vePorts

Return Type:

Changed response : 400 Bad Request

Bad/malformed request

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 401 Unauthorized

Unauthorized

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 403 Forbidden

Forbidden

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 404 Not Found

Requested resource or related entity not found

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 422 Unprocessable Entity

Validation error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 500 Internal Server Error

Internal Server Error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 200 OK

OK

Changed content type : application/json
- Changed property requestId (object)
  The unique identifier for tracking this API operation request.
- Changed property response (object)
  The empty view representing an API response with no data content, used for operations that return success status without additional information.
Changed content type : application/vnd.ruckus.v1+json
- Changed property requestId (object)
  The unique identifier for tracking this API operation request.
- Changed property response (object)
  The empty view representing an API response with no data content, used for operations that return success status without additional information.

GET /switches/vePorts/{vePortId}

Return Type:

Changed response : 200 OK

OK

Changed content type : application/json
- Added property ipRouterId (object)
  The router ID for the switch.
- Added property ipv6Address (object)
  IPv6 address assigned to the VE interface (e.g., '2001:b030:2516:101:1:1:1:242').
- Added property ipv6AddressType (object)
  IPv6 address type for the VE interface (static or dynamic).
  Enum values:
  - __NULL
  - static
  - dynamic
- Added property ipv6DhcpRelayAgent (object)
  Enable the DHCPv6 relay agent function and specify the relay destination (the DHCP server) address on a VE interface.
- Added property ipv6OspfArea (object)
  Enables OSPFv3 on a VE interface.
- Added property ipv6Prefix (object)
  IPv6 address prefix to the VE interface (e.g., '64').
- Changed property defaultVlan (object)
  Flag indicating whether this VE port is associated with the default VLAN (default: false).
- Changed property dhcpRelayAgent (object)
  DHCP relay agent IP address for forwarding DHCP requests.
- Changed property egressAcl (object)
  Egress ACL name or ID applied to outgoing traffic on this VE port.
- Changed property id (object)
  Unique identifier for the VE port.
- Changed property ingressAcl (object)
  Ingress ACL name or ID applied to incoming traffic on this VE port.
- Changed property ipAddress (object)
  IPv4 address assigned to the VE interface (e.g., '192.168.1.1').
- Changed property ipAddressType (object)
  IP address type for the VE interface (static or dynamic).
- Changed property ipSubnetMask (object)
  IP subnet mask for the VE interface (e.g., '255.255.255.0').
- Changed property name (object)
  Name of the VE port for identification.
- Changed property ospfArea (object)
  OSPF area ID for routing configuration (e.g., '0.0.0.0' for backbone area).
- Changed property switchId (object)
  Switch identifier where this VE port is configured.
- Changed property veId (object)
  VE port identifier number (1-4096).
- Changed property vlanId (object)
  VLAN ID associated with this VE port (1-4095).
- Changed property vsixEgressAcl (object)
  IPv6 egress ACL configuration.
- Changed property vsixIngressAcl (object)
  IPv6 ingress ACL configuration.
Changed content type : application/vnd.ruckus.v1+json
- Added property ipRouterId (object)
  The router ID for the switch.
- Added property ipv6Address (object)
  IPv6 address assigned to the VE interface (e.g., '2001:b030:2516:101:1:1:1:242').
- Added property ipv6AddressType (object)
  IPv6 address type for the VE interface (static or dynamic).
- Added property ipv6DhcpRelayAgent (object)
  Enable the DHCPv6 relay agent function and specify the relay destination (the DHCP server) address on a VE interface.
- Added property ipv6OspfArea (object)
  Enables OSPFv3 on a VE interface.
- Added property ipv6Prefix (object)
  IPv6 address prefix to the VE interface (e.g., '64').
- Changed property defaultVlan (object)
  Flag indicating whether this VE port is associated with the default VLAN (default: false).
- Changed property dhcpRelayAgent (object)
  DHCP relay agent IP address for forwarding DHCP requests.
- Changed property egressAcl (object)
  Egress ACL name or ID applied to outgoing traffic on this VE port.
- Changed property id (object)
  Unique identifier for the VE port.
- Changed property ingressAcl (object)
  Ingress ACL name or ID applied to incoming traffic on this VE port.
- Changed property ipAddress (object)
  IPv4 address assigned to the VE interface (e.g., '192.168.1.1').
- Changed property ipAddressType (object)
  IP address type for the VE interface (static or dynamic).
- Changed property ipSubnetMask (object)
  IP subnet mask for the VE interface (e.g., '255.255.255.0').
- Changed property name (object)
  Name of the VE port for identification.
- Changed property ospfArea (object)
  OSPF area ID for routing configuration (e.g., '0.0.0.0' for backbone area).
- Changed property switchId (object)
  Switch identifier where this VE port is configured.
- Changed property veId (object)
  VE port identifier number (1-4096).
- Changed property vlanId (object)
  VLAN ID associated with this VE port (1-4095).
- Changed property vsixEgressAcl (object)
  IPv6 egress ACL configuration.
- Changed property vsixIngressAcl (object)
  IPv6 ingress ACL configuration.

Changed response : 400 Bad Request

Bad/malformed request

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 401 Unauthorized

Unauthorized

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 403 Forbidden

Forbidden

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 404 Not Found

Requested resource or related entity not found

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 422 Unprocessable Entity

Validation error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 500 Internal Server Error

Internal Server Error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

PUT /switches/vePorts/{vePortId}

Request:

Changed content type : application/json

Added property ipRouterId (object)
The router ID for the switch.
Added property ipv6Address (object)
IPv6 address assigned to the VE interface (e.g., '2001:b030:2516:101:1:1:1:242').
Added property ipv6AddressType (object)
IPv6 address type for the VE interface (static or dynamic).
Added property ipv6DhcpRelayAgent (object)
Enable the DHCPv6 relay agent function and specify the relay destination (the DHCP server) address on a VE interface.
Added property ipv6OspfArea (object)
Enables OSPFv3 on a VE interface.
Added property ipv6Prefix (object)
IPv6 address prefix to the VE interface (e.g., '64').
Deleted property ifIsDhcpVEDefaultCase (object)
Changed property defaultVlan (object)
Flag indicating whether this VE port is associated with the default VLAN (default: false).
Changed property dhcpRelayAgent (object)
DHCP relay agent IP address for forwarding DHCP requests.
Changed property egressAcl (object)
Egress ACL name or ID applied to outgoing traffic on this VE port.
Changed property id (object)
Unique identifier for the VE port.
Changed property ingressAcl (object)
Ingress ACL name or ID applied to incoming traffic on this VE port.
Changed property ipAddress (object)
IPv4 address assigned to the VE interface (e.g., '192.168.1.1').
Changed property ipAddressType (object)
IP address type for the VE interface (static or dynamic).
Changed property ipSubnetMask (object)
IP subnet mask for the VE interface (e.g., '255.255.255.0').
Changed property name (object)
Name of the VE port for identification.
Changed property ospfArea (object)
OSPF area ID for routing configuration (e.g., '0.0.0.0' for backbone area).
Changed property switchId (object)
Switch identifier where this VE port is configured.
Changed property veId (object)
VE port identifier number (1-4096).
Changed property vlanId (object)
VLAN ID associated with this VE port (1-4095).
Changed property vsixEgressAcl (object)
IPv6 egress ACL configuration.
Changed property vsixIngressAcl (object)
IPv6 ingress ACL configuration.

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

Added property ipRouterId (object)
The router ID for the switch.
Added property ipv6Address (object)
IPv6 address assigned to the VE interface (e.g., '2001:b030:2516:101:1:1:1:242').
Added property ipv6AddressType (object)
IPv6 address type for the VE interface (static or dynamic).
Added property ipv6DhcpRelayAgent (object)
Enable the DHCPv6 relay agent function and specify the relay destination (the DHCP server) address on a VE interface.
Added property ipv6OspfArea (object)
Enables OSPFv3 on a VE interface.
Added property ipv6Prefix (object)
IPv6 address prefix to the VE interface (e.g., '64').
Deleted property ifIsDhcpVEDefaultCase (object)
Changed property defaultVlan (object)
Flag indicating whether this VE port is associated with the default VLAN (default: false).
Changed property dhcpRelayAgent (object)
DHCP relay agent IP address for forwarding DHCP requests.
Changed property egressAcl (object)
Egress ACL name or ID applied to outgoing traffic on this VE port.
Changed property id (object)
Unique identifier for the VE port.
Changed property ingressAcl (object)
Ingress ACL name or ID applied to incoming traffic on this VE port.
Changed property ipAddress (object)
IPv4 address assigned to the VE interface (e.g., '192.168.1.1').
Changed property ipAddressType (object)
IP address type for the VE interface (static or dynamic).
Changed property ipSubnetMask (object)
IP subnet mask for the VE interface (e.g., '255.255.255.0').
Changed property name (object)
Name of the VE port for identification.
Changed property ospfArea (object)
OSPF area ID for routing configuration (e.g., '0.0.0.0' for backbone area).
Changed property switchId (object)
Switch identifier where this VE port is configured.
Changed property veId (object)
VE port identifier number (1-4096).
Changed property vlanId (object)
VLAN ID associated with this VE port (1-4095).
Changed property vsixEgressAcl (object)
IPv6 egress ACL configuration.
Changed property vsixIngressAcl (object)
IPv6 ingress ACL configuration.

Return Type:

Changed response : 200 OK

OK

Changed content type : application/json
- Changed property connectedVe (object)
  The flag indicating whether this VE interface is connected and operational.
- Changed property defaultVlan (object)
  The flag indicating whether this is the default VLAN for the switch (deprecated, use connectedVe instead).
- Changed property deviceStatus (object)
  The operational status of the device associated with this VE interface.
- Changed property dhcpRelayAgent (object)
  The IP address of the DHCP relay agent for forwarding DHCP requests across subnets.
- Changed property egressAclName (object)
  The name of the Access Control List applied to egress (outgoing) traffic on this VE interface.
- Changed property id (object)
  The identifier
- Changed property ingressAclName (object)
  The name of the Access Control List applied to ingress (incoming) traffic on this VE interface.
- Changed property ipAddress (object)
  The IPv4 address assigned to this virtual ethernet interface.
- Changed property ipAddressType (object)
  The IP address assignment method for this VE interface: static or dynamic.
- Changed property ipSubnetMask (object)
  The subnet mask for the IP address of this virtual ethernet interface.
- Changed property name (object)
  The descriptive name assigned to the virtual ethernet interface.
- Changed property ospfArea (object)
  The OSPF area identifier for routing protocol configuration on this VE interface.
- Changed property portType (object)
  The type of port associated with this VE interface.
- Changed property stack (object)
  The flag indicating whether the switch is configured in a stack.
- Changed property switchId (object)
  The identifier of the switch where this VE interface is configured.
- Changed property switchName (object)
  The name of the switch where this VE interface is configured.
- Changed property syncedSwitchConfig (object)
  The flag indicating whether the VE interface configuration has been synchronized with the switch.
- Changed property tenantId (object)
  The unique identifier of the tenant.
- Changed property veId (object)
  The virtual ethernet interface identifier, used as the VE interface number.
- Changed property vePortViewList (object)
  The list of VE port configurations for batch operations or nested VE management.
- Changed property vlanId (object)
  The VLAN ID associated with this virtual ethernet interface for layer 3 routing.
- Changed property vsixEgressAclName (object)
  The name of the VSIX ACL applied to egress traffic for virtual switch integration.
- Changed property vsixIngressAclName (object)
  The name of the VSIX ACL applied to ingress traffic for virtual switch integration.
Changed content type : application/vnd.ruckus.v1+json
- Changed property connectedVe (object)
  The flag indicating whether this VE interface is connected and operational.
- Changed property defaultVlan (object)
  The flag indicating whether this is the default VLAN for the switch (deprecated, use connectedVe instead).
- Changed property deviceStatus (object)
  The operational status of the device associated with this VE interface.
- Changed property dhcpRelayAgent (object)
  The IP address of the DHCP relay agent for forwarding DHCP requests across subnets.
- Changed property egressAclName (object)
  The name of the Access Control List applied to egress (outgoing) traffic on this VE interface.
- Changed property id (object)
  The identifier
- Changed property ingressAclName (object)
  The name of the Access Control List applied to ingress (incoming) traffic on this VE interface.
- Changed property ipAddress (object)
  The IPv4 address assigned to this virtual ethernet interface.
- Changed property ipAddressType (object)
  The IP address assignment method for this VE interface: static or dynamic.
- Changed property ipSubnetMask (object)
  The subnet mask for the IP address of this virtual ethernet interface.
- Changed property name (object)
  The descriptive name assigned to the virtual ethernet interface.
- Changed property ospfArea (object)
  The OSPF area identifier for routing protocol configuration on this VE interface.
- Changed property portType (object)
  The type of port associated with this VE interface.
- Changed property stack (object)
  The flag indicating whether the switch is configured in a stack.
- Changed property switchId (object)
  The identifier of the switch where this VE interface is configured.
- Changed property switchName (object)
  The name of the switch where this VE interface is configured.
- Changed property syncedSwitchConfig (object)
  The flag indicating whether the VE interface configuration has been synchronized with the switch.
- Changed property tenantId (object)
  The unique identifier of the tenant.
- Changed property veId (object)
  The virtual ethernet interface identifier, used as the VE interface number.
- Changed property vePortViewList (object)
  The list of VE port configurations for batch operations or nested VE management.
- Changed property vlanId (object)
  The VLAN ID associated with this virtual ethernet interface for layer 3 routing.
- Changed property vsixEgressAclName (object)
  The name of the VSIX ACL applied to egress traffic for virtual switch integration.
- Changed property vsixIngressAclName (object)
  The name of the VSIX ACL applied to ingress traffic for virtual switch integration.

Changed response : 400 Bad Request

Bad/malformed request

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 401 Unauthorized

Unauthorized

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 403 Forbidden

Forbidden

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 404 Not Found

Requested resource or related entity not found

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 422 Unprocessable Entity

Validation error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 500 Internal Server Error

Internal Server Error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

DELETE /switches/vePorts/{vePortId}

Return Type:

Changed response : 400 Bad Request

Bad/malformed request

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 401 Unauthorized

Unauthorized

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 403 Forbidden

Forbidden

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 404 Not Found

Requested resource or related entity not found

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 422 Unprocessable Entity

Validation error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 500 Internal Server Error

Internal Server Error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 200 OK

OK

Changed content type : application/json
- Changed property requestId (object)
  The unique identifier for tracking this API operation request.
- Changed property response (object)
  The empty view representing an API response with no data content, used for operations that return success status without additional information.
Changed content type : application/vnd.ruckus.v1+json
- Changed property requestId (object)
  The unique identifier for tracking this API operation request.
- Changed property response (object)
  The empty view representing an API response with no data content, used for operations that return success status without additional information.

POST /switches/vlans

Return Type:

Changed response : 400 Bad Request

Bad/malformed request

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 401 Unauthorized

Unauthorized

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 403 Forbidden

Forbidden

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 404 Not Found

Requested resource or related entity not found

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 422 Unprocessable Entity

Validation error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 500 Internal Server Error

Internal Server Error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 200 OK

OK

Changed content type : application/json
- Changed property requestId (object)
  The unique identifier for tracking this API operation request.
- Changed property response (object)
  The empty view representing an API response with no data content, used for operations that return success status without additional information.
Changed content type : application/vnd.ruckus.v1+json
- Changed property requestId (object)
  The unique identifier for tracking this API operation request.
- Changed property response (object)
  The empty view representing an API response with no data content, used for operations that return success status without additional information.

DELETE /switches/vlans

Return Type:

Changed response : 400 Bad Request

Bad/malformed request

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 401 Unauthorized

Unauthorized

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 403 Forbidden

Forbidden

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 404 Not Found

Requested resource or related entity not found

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 422 Unprocessable Entity

Validation error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 500 Internal Server Error

Internal Server Error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 200 OK

OK

Changed content type : application/json
- Changed property requestId (object)
  The unique identifier for tracking this API operation request.
- Changed property response (object)
  The empty view representing an API response with no data content, used for operations that return success status without additional information.
Changed content type : application/vnd.ruckus.v1+json
- Changed property requestId (object)
  The unique identifier for tracking this API operation request.
- Changed property response (object)
  The empty view representing an API response with no data content, used for operations that return success status without additional information.

GET /switches/vlans/{vlanId}

Return Type:

Changed response : 400 Bad Request

Bad/malformed request

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 401 Unauthorized

Unauthorized

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 403 Forbidden

Forbidden

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 404 Not Found

Requested resource or related entity not found

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 422 Unprocessable Entity

Validation error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 500 Internal Server Error

Internal Server Error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 200 OK

OK

Changed content type : application/json
- Changed property arpInspection (object)
  The flag indicating whether ARP inspection is enabled for this VLAN to prevent ARP spoofing attacks.
- Changed property enableAsDefaultVlan (object)
  The flag indicating whether this VLAN is configured as the default VLAN for the switch.
- Changed property id (object)
  The identifier
- Changed property igmpSnooping (object)
  The IGMP snooping mode for this VLAN to optimize multicast traffic delivery.
- Changed property ipv4DhcpSnooping (object)
  The flag indicating whether IPv4 DHCP snooping is enabled for this VLAN to prevent rogue DHCP servers.
- Changed property multicastVersion (object)
  The IGMP version number used for multicast group management in this VLAN.
- Changed property spanningTreeProtocol (object)
  The STP (Spanning Tree Protocol) variant enabled for this VLAN.
- Changed property switchVlanPortModels (object)
  The set of port model configurations specific to this VLAN on different switch models in a stack.
- Changed property taggedPorts (object)
  The comma separated list of port identifiers configured as tagged (trunk) ports for this VLAN.
- Changed property untaggedPorts (object)
  The comma separated list of port identifiers configured as untagged (access) ports for this VLAN.
- Changed property vlanId (object)
  The VLAN identifier, ranging from 1 to 4095, uniquely identifying this VLAN on the switch.
- Changed property vlanName (object)
  The descriptive name assigned to this VLAN for identification purposes.
- Changed property vePort (object)
  The virtual ethernet port view, representing a layer 3 virtual interface configuration with IP addressing, routing capabilities, and ACL assignments.
  - Changed property connectedVe (object)
    The flag indicating whether this VE interface is connected and operational.
  - Changed property defaultVlan (object)
    The flag indicating whether this is the default VLAN for the switch (deprecated, use connectedVe instead).
  - Changed property deviceStatus (object)
    The operational status of the device associated with this VE interface.
  - Changed property dhcpRelayAgent (object)
    The IP address of the DHCP relay agent for forwarding DHCP requests across subnets.
  - Changed property egressAclName (object)
    The name of the Access Control List applied to egress (outgoing) traffic on this VE interface.
  - Changed property id (object)
    The identifier
  - Changed property ingressAclName (object)
    The name of the Access Control List applied to ingress (incoming) traffic on this VE interface.
  - Changed property ipAddress (object)
    The IPv4 address assigned to this virtual ethernet interface.
  - Changed property ipAddressType (object)
    The IP address assignment method for this VE interface: static or dynamic.
  - Changed property ipSubnetMask (object)
    The subnet mask for the IP address of this virtual ethernet interface.
  - Changed property name (object)
    The descriptive name assigned to the virtual ethernet interface.
  - Changed property ospfArea (object)
    The OSPF area identifier for routing protocol configuration on this VE interface.
  - Changed property portType (object)
    The type of port associated with this VE interface.
  - Changed property stack (object)
    The flag indicating whether the switch is configured in a stack.
  - Changed property switchId (object)
    The identifier of the switch where this VE interface is configured.
  - Changed property switchName (object)
    The name of the switch where this VE interface is configured.
  - Changed property syncedSwitchConfig (object)
    The flag indicating whether the VE interface configuration has been synchronized with the switch.
  - Changed property tenantId (object)
    The unique identifier of the tenant.
  - Changed property veId (object)
    The virtual ethernet interface identifier, used as the VE interface number.
  - Changed property vePortViewList (object)
    The list of VE port configurations for batch operations or nested VE management.
  - Changed property vlanId (object)
    The VLAN ID associated with this virtual ethernet interface for layer 3 routing.
  - Changed property vsixEgressAclName (object)
    The name of the VSIX ACL applied to egress traffic for virtual switch integration.
  - Changed property vsixIngressAclName (object)
    The name of the VSIX ACL applied to ingress traffic for virtual switch integration.
Changed content type : application/vnd.ruckus.v1+json
- Changed property arpInspection (object)
  The flag indicating whether ARP inspection is enabled for this VLAN to prevent ARP spoofing attacks.
- Changed property enableAsDefaultVlan (object)
  The flag indicating whether this VLAN is configured as the default VLAN for the switch.
- Changed property id (object)
  The identifier
- Changed property igmpSnooping (object)
  The IGMP snooping mode for this VLAN to optimize multicast traffic delivery.
- Changed property ipv4DhcpSnooping (object)
  The flag indicating whether IPv4 DHCP snooping is enabled for this VLAN to prevent rogue DHCP servers.
- Changed property multicastVersion (object)
  The IGMP version number used for multicast group management in this VLAN.
- Changed property spanningTreeProtocol (object)
  The STP (Spanning Tree Protocol) variant enabled for this VLAN.
- Changed property switchVlanPortModels (object)
  The set of port model configurations specific to this VLAN on different switch models in a stack.
- Changed property taggedPorts (object)
  The comma separated list of port identifiers configured as tagged (trunk) ports for this VLAN.
- Changed property untaggedPorts (object)
  The comma separated list of port identifiers configured as untagged (access) ports for this VLAN.
- Changed property vlanId (object)
  The VLAN identifier, ranging from 1 to 4095, uniquely identifying this VLAN on the switch.
- Changed property vlanName (object)
  The descriptive name assigned to this VLAN for identification purposes.
- Changed property vePort (object)
  The virtual ethernet port view, representing a layer 3 virtual interface configuration with IP addressing, routing capabilities, and ACL assignments.
  - Changed property connectedVe (object)
    The flag indicating whether this VE interface is connected and operational.
  - Changed property defaultVlan (object)
    The flag indicating whether this is the default VLAN for the switch (deprecated, use connectedVe instead).
  - Changed property deviceStatus (object)
    The operational status of the device associated with this VE interface.
  - Changed property dhcpRelayAgent (object)
    The IP address of the DHCP relay agent for forwarding DHCP requests across subnets.
  - Changed property egressAclName (object)
    The name of the Access Control List applied to egress (outgoing) traffic on this VE interface.
  - Changed property id (object)
    The identifier
  - Changed property ingressAclName (object)
    The name of the Access Control List applied to ingress (incoming) traffic on this VE interface.
  - Changed property ipAddress (object)
    The IPv4 address assigned to this virtual ethernet interface.
  - Changed property ipAddressType (object)
    The IP address assignment method for this VE interface: static or dynamic.
  - Changed property ipSubnetMask (object)
    The subnet mask for the IP address of this virtual ethernet interface.
  - Changed property name (object)
    The descriptive name assigned to the virtual ethernet interface.
  - Changed property ospfArea (object)
    The OSPF area identifier for routing protocol configuration on this VE interface.
  - Changed property portType (object)
    The type of port associated with this VE interface.
  - Changed property stack (object)
    The flag indicating whether the switch is configured in a stack.
  - Changed property switchId (object)
    The identifier of the switch where this VE interface is configured.
  - Changed property switchName (object)
    The name of the switch where this VE interface is configured.
  - Changed property syncedSwitchConfig (object)
    The flag indicating whether the VE interface configuration has been synchronized with the switch.
  - Changed property tenantId (object)
    The unique identifier of the tenant.
  - Changed property veId (object)
    The virtual ethernet interface identifier, used as the VE interface number.
  - Changed property vePortViewList (object)
    The list of VE port configurations for batch operations or nested VE management.
  - Changed property vlanId (object)
    The VLAN ID associated with this virtual ethernet interface for layer 3 routing.
  - Changed property vsixEgressAclName (object)
    The name of the VSIX ACL applied to egress traffic for virtual switch integration.
  - Changed property vsixIngressAclName (object)
    The name of the VSIX ACL applied to ingress traffic for virtual switch integration.

PUT /switches/vlans/{vlanId}

Request:

Changed content type : application/json

Added property ipv6DhcpSnooping (object)
Enable IPv6 DHCP snooping to prevent such attacks, DHCPv6 snooping helps to secure the IPv6 address configuration in the network (default: false).
Added property ipv6DhcpSnoopingTrustPort (object)
Comma separated list of trusted port identifiers for IPv6 DHCP snooping.
Added property ipv6DhcpSnoopingTrustPortList (object)
List of individual trusted port identifiers for IPv6 DHCP snooping parsed from ipv6DhcpSnoopingTrustPort.
Added property ipv6DhcpTrustPortsList (object)
List of IPv6 DHCP trusted ports for internal use.
Added property ipv6NdInspection (object)
Enable IPv6 ND (Neighbor Discovery) inspection to prevents IPv6 address spoofing at the switch level (default: false).
Added property ipv6NdInspectionTrustPort (object)
Comma separated list of trusted port identifiers for IPv6 ND (Neighbor Discovery) inspection.
Added property ipv6NdInspectionTrustPortList (object)
List of individual trusted port identifiers for IPv6 ND (Neighbor Discovery) inspection parsed from ipv6NdInspectionTrustPort.
Added property ipv6NdTrustPortsList (object)
List of IPv6 ND (Neighbor Discovery) trusted ports for internal use.
Deleted property defaultVlan (object)
Deleted property deleteVlanEnabled (object)
Deleted property dummyVlan (object)
Deleted property igmpSnoopingTypeChanged (object)
Deleted property notDummyVlan (object)
Deleted property rapidSpanningTreeProtocol (object)
Deleted property switchVlanPortModel (object)
Deleted property taggedPortsList (object)
Deleted property untaggedPortsList (object)
Changed property arpInspection (object)
Enable ARP inspection to prevent ARP spoofing attacks (default: false).
Changed property arpInspectionTrustPort (object)
Comma separated list of trusted port identifiers for ARP inspection.
Changed property arpInspectionTrustPortList (object)
List of individual trusted port identifiers for ARP inspection parsed from arpInspectionTrustPort.
Changed property arpTrustPortsList (object)
List of ARP trusted ports for internal use.
Changed property dhcpTrustPortsList (object)
List of DHCP trusted ports for internal use.
Changed property enableAsDefaultVlan (object)
Flag to enable this VLAN as the default VLAN for the switch (default: false).
Changed property id (object)
Unique identifier for the VLAN configuration.
Changed property igmpSnooping (object)
IGMP snooping mode for multicast traffic optimization.
Changed property ipv4DhcpSnooping (object)
Enable IPv4 DHCP snooping to prevent rogue DHCP servers (default: false).
Changed property ipv4DhcpSnoopingTrustPort (object)
Comma separated list of trusted port identifiers for DHCP snooping.
Changed property ipv4DhcpSnoopingTrustPortList (object)
List of individual trusted port identifiers for DHCP snooping parsed from ipv4DhcpSnoopingTrustPort.
Changed property managementVlan (object)
Flag indicating whether this is a management VLAN for switch management access (default: false).
Changed property multicastVersion (object)
IGMP multicast version (0-3).
Changed property rootBridgeFamilyId (object)
Root bridge family ID for spanning tree protocol.
Changed property spanningTreePriority (object)
Spanning tree priority value for root bridge election (0-65535, default: 32768, lower values have higher priority).
Changed property spanningTreeProtocol (object)
STP (Spanning Tree Protocol) mode for loop prevention.
Changed property switchFamilyModels (object)
Set of switch family model configurations for this VLAN.
Changed property switchId (object)
Switch identifier (serial number) where this VLAN is configured.
Changed property switchVlanPortModels (object)
Set of port model configurations defining which ports are assigned to this VLAN as tagged, untagged, or voice ports.
Changed property vlanId (object)
VLAN identifier number (1-4095).
Changed property vlanName (object)
VLAN name for identification and management purposes.

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

Added property ipv6DhcpSnooping (object)
Enable IPv6 DHCP snooping to prevent such attacks, DHCPv6 snooping helps to secure the IPv6 address configuration in the network (default: false).
Added property ipv6DhcpSnoopingTrustPort (object)
Comma separated list of trusted port identifiers for IPv6 DHCP snooping.
Added property ipv6DhcpSnoopingTrustPortList (object)
List of individual trusted port identifiers for IPv6 DHCP snooping parsed from ipv6DhcpSnoopingTrustPort.
Added property ipv6DhcpTrustPortsList (object)
List of IPv6 DHCP trusted ports for internal use.
Added property ipv6NdInspection (object)
Enable IPv6 ND (Neighbor Discovery) inspection to prevents IPv6 address spoofing at the switch level (default: false).
Added property ipv6NdInspectionTrustPort (object)
Comma separated list of trusted port identifiers for IPv6 ND (Neighbor Discovery) inspection.
Added property ipv6NdInspectionTrustPortList (object)
List of individual trusted port identifiers for IPv6 ND (Neighbor Discovery) inspection parsed from ipv6NdInspectionTrustPort.
Added property ipv6NdTrustPortsList (object)
List of IPv6 ND (Neighbor Discovery) trusted ports for internal use.
Deleted property defaultVlan (object)
Deleted property deleteVlanEnabled (object)
Deleted property dummyVlan (object)
Deleted property igmpSnoopingTypeChanged (object)
Deleted property notDummyVlan (object)
Deleted property rapidSpanningTreeProtocol (object)
Deleted property switchVlanPortModel (object)
Deleted property taggedPortsList (object)
Deleted property untaggedPortsList (object)
Changed property arpInspection (object)
Enable ARP inspection to prevent ARP spoofing attacks (default: false).
Changed property arpInspectionTrustPort (object)
Comma separated list of trusted port identifiers for ARP inspection.
Changed property arpInspectionTrustPortList (object)
List of individual trusted port identifiers for ARP inspection parsed from arpInspectionTrustPort.
Changed property arpTrustPortsList (object)
List of ARP trusted ports for internal use.
Changed property dhcpTrustPortsList (object)
List of DHCP trusted ports for internal use.
Changed property enableAsDefaultVlan (object)
Flag to enable this VLAN as the default VLAN for the switch (default: false).
Changed property id (object)
Unique identifier for the VLAN configuration.
Changed property igmpSnooping (object)
IGMP snooping mode for multicast traffic optimization.
Changed property ipv4DhcpSnooping (object)
Enable IPv4 DHCP snooping to prevent rogue DHCP servers (default: false).
Changed property ipv4DhcpSnoopingTrustPort (object)
Comma separated list of trusted port identifiers for DHCP snooping.
Changed property ipv4DhcpSnoopingTrustPortList (object)
List of individual trusted port identifiers for DHCP snooping parsed from ipv4DhcpSnoopingTrustPort.
Changed property managementVlan (object)
Flag indicating whether this is a management VLAN for switch management access (default: false).
Changed property multicastVersion (object)
IGMP multicast version (0-3).
Changed property rootBridgeFamilyId (object)
Root bridge family ID for spanning tree protocol.
Changed property spanningTreePriority (object)
Spanning tree priority value for root bridge election (0-65535, default: 32768, lower values have higher priority).
Changed property spanningTreeProtocol (object)
STP (Spanning Tree Protocol) mode for loop prevention.
Changed property switchFamilyModels (object)
Set of switch family model configurations for this VLAN.
Changed property switchId (object)
Switch identifier (serial number) where this VLAN is configured.
Changed property switchVlanPortModels (object)
Set of port model configurations defining which ports are assigned to this VLAN as tagged, untagged, or voice ports.
Changed property vlanId (object)
VLAN identifier number (1-4095).
Changed property vlanName (object)
VLAN name for identification and management purposes.

Return Type:

Changed response : 400 Bad Request

Bad/malformed request

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 401 Unauthorized

Unauthorized

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 403 Forbidden

Forbidden

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 404 Not Found

Requested resource or related entity not found

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 422 Unprocessable Entity

Validation error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 500 Internal Server Error

Internal Server Error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 200 OK

OK

Changed content type : application/json
- Changed property arpInspection (object)
  The flag indicating whether ARP inspection is enabled for this VLAN to prevent ARP spoofing attacks.
- Changed property enableAsDefaultVlan (object)
  The flag indicating whether this VLAN is configured as the default VLAN for the switch.
- Changed property id (object)
  The identifier
- Changed property igmpSnooping (object)
  The IGMP snooping mode for this VLAN to optimize multicast traffic delivery.
- Changed property ipv4DhcpSnooping (object)
  The flag indicating whether IPv4 DHCP snooping is enabled for this VLAN to prevent rogue DHCP servers.
- Changed property multicastVersion (object)
  The IGMP version number used for multicast group management in this VLAN.
- Changed property spanningTreeProtocol (object)
  The STP (Spanning Tree Protocol) variant enabled for this VLAN.
- Changed property switchVlanPortModels (object)
  The set of port model configurations specific to this VLAN on different switch models in a stack.
- Changed property taggedPorts (object)
  The comma separated list of port identifiers configured as tagged (trunk) ports for this VLAN.
- Changed property untaggedPorts (object)
  The comma separated list of port identifiers configured as untagged (access) ports for this VLAN.
- Changed property vlanId (object)
  The VLAN identifier, ranging from 1 to 4095, uniquely identifying this VLAN on the switch.
- Changed property vlanName (object)
  The descriptive name assigned to this VLAN for identification purposes.
- Changed property vePort (object)
  The virtual ethernet port view, representing a layer 3 virtual interface configuration with IP addressing, routing capabilities, and ACL assignments.
  - Changed property connectedVe (object)
    The flag indicating whether this VE interface is connected and operational.
  - Changed property defaultVlan (object)
    The flag indicating whether this is the default VLAN for the switch (deprecated, use connectedVe instead).
  - Changed property deviceStatus (object)
    The operational status of the device associated with this VE interface.
  - Changed property dhcpRelayAgent (object)
    The IP address of the DHCP relay agent for forwarding DHCP requests across subnets.
  - Changed property egressAclName (object)
    The name of the Access Control List applied to egress (outgoing) traffic on this VE interface.
  - Changed property id (object)
    The identifier
  - Changed property ingressAclName (object)
    The name of the Access Control List applied to ingress (incoming) traffic on this VE interface.
  - Changed property ipAddress (object)
    The IPv4 address assigned to this virtual ethernet interface.
  - Changed property ipAddressType (object)
    The IP address assignment method for this VE interface: static or dynamic.
  - Changed property ipSubnetMask (object)
    The subnet mask for the IP address of this virtual ethernet interface.
  - Changed property name (object)
    The descriptive name assigned to the virtual ethernet interface.
  - Changed property ospfArea (object)
    The OSPF area identifier for routing protocol configuration on this VE interface.
  - Changed property portType (object)
    The type of port associated with this VE interface.
  - Changed property stack (object)
    The flag indicating whether the switch is configured in a stack.
  - Changed property switchId (object)
    The identifier of the switch where this VE interface is configured.
  - Changed property switchName (object)
    The name of the switch where this VE interface is configured.
  - Changed property syncedSwitchConfig (object)
    The flag indicating whether the VE interface configuration has been synchronized with the switch.
  - Changed property tenantId (object)
    The unique identifier of the tenant.
  - Changed property veId (object)
    The virtual ethernet interface identifier, used as the VE interface number.
  - Changed property vePortViewList (object)
    The list of VE port configurations for batch operations or nested VE management.
  - Changed property vlanId (object)
    The VLAN ID associated with this virtual ethernet interface for layer 3 routing.
  - Changed property vsixEgressAclName (object)
    The name of the VSIX ACL applied to egress traffic for virtual switch integration.
  - Changed property vsixIngressAclName (object)
    The name of the VSIX ACL applied to ingress traffic for virtual switch integration.
Changed content type : application/vnd.ruckus.v1+json
- Changed property arpInspection (object)
  The flag indicating whether ARP inspection is enabled for this VLAN to prevent ARP spoofing attacks.
- Changed property enableAsDefaultVlan (object)
  The flag indicating whether this VLAN is configured as the default VLAN for the switch.
- Changed property id (object)
  The identifier
- Changed property igmpSnooping (object)
  The IGMP snooping mode for this VLAN to optimize multicast traffic delivery.
- Changed property ipv4DhcpSnooping (object)
  The flag indicating whether IPv4 DHCP snooping is enabled for this VLAN to prevent rogue DHCP servers.
- Changed property multicastVersion (object)
  The IGMP version number used for multicast group management in this VLAN.
- Changed property spanningTreeProtocol (object)
  The STP (Spanning Tree Protocol) variant enabled for this VLAN.
- Changed property switchVlanPortModels (object)
  The set of port model configurations specific to this VLAN on different switch models in a stack.
- Changed property taggedPorts (object)
  The comma separated list of port identifiers configured as tagged (trunk) ports for this VLAN.
- Changed property untaggedPorts (object)
  The comma separated list of port identifiers configured as untagged (access) ports for this VLAN.
- Changed property vlanId (object)
  The VLAN identifier, ranging from 1 to 4095, uniquely identifying this VLAN on the switch.
- Changed property vlanName (object)
  The descriptive name assigned to this VLAN for identification purposes.
- Changed property vePort (object)
  The virtual ethernet port view, representing a layer 3 virtual interface configuration with IP addressing, routing capabilities, and ACL assignments.
  - Changed property connectedVe (object)
    The flag indicating whether this VE interface is connected and operational.
  - Changed property defaultVlan (object)
    The flag indicating whether this is the default VLAN for the switch (deprecated, use connectedVe instead).
  - Changed property deviceStatus (object)
    The operational status of the device associated with this VE interface.
  - Changed property dhcpRelayAgent (object)
    The IP address of the DHCP relay agent for forwarding DHCP requests across subnets.
  - Changed property egressAclName (object)
    The name of the Access Control List applied to egress (outgoing) traffic on this VE interface.
  - Changed property id (object)
    The identifier
  - Changed property ingressAclName (object)
    The name of the Access Control List applied to ingress (incoming) traffic on this VE interface.
  - Changed property ipAddress (object)
    The IPv4 address assigned to this virtual ethernet interface.
  - Changed property ipAddressType (object)
    The IP address assignment method for this VE interface: static or dynamic.
  - Changed property ipSubnetMask (object)
    The subnet mask for the IP address of this virtual ethernet interface.
  - Changed property name (object)
    The descriptive name assigned to the virtual ethernet interface.
  - Changed property ospfArea (object)
    The OSPF area identifier for routing protocol configuration on this VE interface.
  - Changed property portType (object)
    The type of port associated with this VE interface.
  - Changed property stack (object)
    The flag indicating whether the switch is configured in a stack.
  - Changed property switchId (object)
    The identifier of the switch where this VE interface is configured.
  - Changed property switchName (object)
    The name of the switch where this VE interface is configured.
  - Changed property syncedSwitchConfig (object)
    The flag indicating whether the VE interface configuration has been synchronized with the switch.
  - Changed property tenantId (object)
    The unique identifier of the tenant.
  - Changed property veId (object)
    The virtual ethernet interface identifier, used as the VE interface number.
  - Changed property vePortViewList (object)
    The list of VE port configurations for batch operations or nested VE management.
  - Changed property vlanId (object)
    The VLAN ID associated with this virtual ethernet interface for layer 3 routing.
  - Changed property vsixEgressAclName (object)
    The name of the VSIX ACL applied to egress traffic for virtual switch integration.
  - Changed property vsixIngressAclName (object)
    The name of the VSIX ACL applied to ingress traffic for virtual switch integration.

DELETE /switches/vlans/{vlanId}

Return Type:

Changed response : 400 Bad Request

Bad/malformed request

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 401 Unauthorized

Unauthorized

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 403 Forbidden

Forbidden

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 404 Not Found

Requested resource or related entity not found

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 422 Unprocessable Entity

Validation error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 500 Internal Server Error

Internal Server Error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 200 OK

OK

Changed content type : application/json
- Changed property requestId (object)
  The unique identifier for tracking this API operation request.
- Changed property response (object)
  The empty view representing an API response with no data content, used for operations that return success status without additional information.
Changed content type : application/vnd.ruckus.v1+json
- Changed property requestId (object)
  The unique identifier for tracking this API operation request.
- Changed property response (object)
  The empty view representing an API response with no data content, used for operations that return success status without additional information.

GET /switches/{switchId}

Return Type:

Changed response : 400 Bad Request

Bad/malformed request

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 401 Unauthorized

Unauthorized

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 403 Forbidden

Forbidden

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 404 Not Found

Requested resource or related entity not found

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 422 Unprocessable Entity

Validation error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 500 Internal Server Error

Internal Server Error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 200 OK

OK

Changed content type : application/json
- Changed property defaultGateway (object)
  The default gateway IP address for routing traffic from the switch management interface.
- Changed property description (object)
  The descriptive text providing additional information about the switch configuration or purpose.
- Changed property dhcpClientEnabled (object)
  The flag indicating whether the switch is configured as a DHCP client to obtain its management IP address.
- Changed property dhcpServerEnabled (object)
  The flag indicating whether the DHCP server feature is enabled on the switch.
- Changed property enableStack (object)
  The flag indicating whether switch stacking is enabled for combining multiple physical switches into a single logical unit.
- Changed property firmwareVersion (object)
  The current firmware version running on the switch.
- Changed property id (object)
  The identifier
- Changed property igmpSnooping (object)
  The IGMP snooping mode for multicast traffic optimization: enabled, disabled, or default.
- Changed property initialVlanId (object)
  The VLAN ID used for initial switch configuration and management access.
- Changed property ipAddress (object)
  The IPv4 address assigned to the switch management interface.
- Changed property ipAddressInterface (object)
  The specific interface identifier for the management IP address configuration.
- Changed property ipAddressInterfaceType (object)
  The interface type for the switch management IP address: VLAN interface or management port.
- Changed property ipAddressType (object)
  The IP address assignment method: static or DHCP.
- Changed property jumboMode (object)
  The flag indicating whether jumbo frame support is enabled, allowing frames larger than 1518 bytes.
- Changed property lastDataSyncTime (object)
  The timestamp in milliseconds when the last data synchronization completed for this switch.
- Changed property lastDataSyncTriggerTime (object)
  The timestamp in milliseconds when the last data synchronization was triggered for this switch.
- Changed property name (object)
  The name assigned to the ICX switch for identification in the network.
- Changed property previousMembers (object)
  The set of serial numbers for previous stack members that have been removed from the stack.
- Changed property rearModule (object)
  The model identifier of the rear expansion module installed on the switch, if applicable.
- Changed property softDeletedDate (object)
  The timestamp when the switch was soft deleted, allowing for recovery before permanent deletion.
- Changed property spanningTreePriority (object)
  The STP (Spanning Tree Protocol) bridge priority value, used in root bridge election (lower values have higher priority).
- Changed property specifiedType (object)
  The firmware image type specified for the switch: primary, secondary, or boot.
- Changed property stackConfigTimestamp (object)
  The timestamp indicating when the stack configuration was last modified.
- Changed property stackMembers (object)
  The list of member switches in a stack configuration, including their models and active status.
- Changed property subnetMask (object)
  The subnet mask for the switch management IP address.
- Changed property syncDataEndTime (object)
  The timestamp in milliseconds when the current data synchronization operation ended.
- Changed property syncDataId (object)
  The unique identifier for the current data synchronization operation.
- Changed property syncDataStartTime (object)
  The timestamp in milliseconds when the current data synchronization operation started.
- Changed property tags (object)
  The comma separated list of custom tags assigned to this switch for organization and filtering.
- Changed property trustPorts (object)
  The list of port identifiers configured as trusted ports for DHCP snooping and ARP inspection.
- Changed property venueId (object)
  The unique identifier of the venue where the switch is located.
- Changed property vlanCustomize (object)
  The flag indicating whether VLAN configurations have been customized from default settings.
- Changed property position (object)
  The switch position view, representing the physical location of a switch on a floor plan with x and y coordinates as percentages.
  - Added property xPercent (object)
    The horizontal position of the switch on the floor plan as a percentage of the total width.
  - Added property yPercent (object)
    The vertical position of the switch on the floor plan as a percentage of the total height.
  - Deleted property xpercent (object)
  - Deleted property ypercent (object)
  - Changed property floorplanId (object)
    The identifier of the floor plan where this switch is located.
  - Changed property id (object)
    The identifier
Changed content type : application/vnd.ruckus.v1+json
- Changed property defaultGateway (object)
  The default gateway IP address for routing traffic from the switch management interface.
- Changed property description (object)
  The descriptive text providing additional information about the switch configuration or purpose.
- Changed property dhcpClientEnabled (object)
  The flag indicating whether the switch is configured as a DHCP client to obtain its management IP address.
- Changed property dhcpServerEnabled (object)
  The flag indicating whether the DHCP server feature is enabled on the switch.
- Changed property enableStack (object)
  The flag indicating whether switch stacking is enabled for combining multiple physical switches into a single logical unit.
- Changed property firmwareVersion (object)
  The current firmware version running on the switch.
- Changed property id (object)
  The identifier
- Changed property igmpSnooping (object)
  The IGMP snooping mode for multicast traffic optimization: enabled, disabled, or default.
- Changed property initialVlanId (object)
  The VLAN ID used for initial switch configuration and management access.
- Changed property ipAddress (object)
  The IPv4 address assigned to the switch management interface.
- Changed property ipAddressInterface (object)
  The specific interface identifier for the management IP address configuration.
- Changed property ipAddressInterfaceType (object)
  The interface type for the switch management IP address: VLAN interface or management port.
- Changed property ipAddressType (object)
  The IP address assignment method: static or DHCP.
- Changed property jumboMode (object)
  The flag indicating whether jumbo frame support is enabled, allowing frames larger than 1518 bytes.
- Changed property lastDataSyncTime (object)
  The timestamp in milliseconds when the last data synchronization completed for this switch.
- Changed property lastDataSyncTriggerTime (object)
  The timestamp in milliseconds when the last data synchronization was triggered for this switch.
- Changed property name (object)
  The name assigned to the ICX switch for identification in the network.
- Changed property previousMembers (object)
  The set of serial numbers for previous stack members that have been removed from the stack.
- Changed property rearModule (object)
  The model identifier of the rear expansion module installed on the switch, if applicable.
- Changed property softDeletedDate (object)
  The timestamp when the switch was soft deleted, allowing for recovery before permanent deletion.
- Changed property spanningTreePriority (object)
  The STP (Spanning Tree Protocol) bridge priority value, used in root bridge election (lower values have higher priority).
- Changed property specifiedType (object)
  The firmware image type specified for the switch: primary, secondary, or boot.
- Changed property stackConfigTimestamp (object)
  The timestamp indicating when the stack configuration was last modified.
- Changed property stackMembers (object)
  The list of member switches in a stack configuration, including their models and active status.
- Changed property subnetMask (object)
  The subnet mask for the switch management IP address.
- Changed property syncDataEndTime (object)
  The timestamp in milliseconds when the current data synchronization operation ended.
- Changed property syncDataId (object)
  The unique identifier for the current data synchronization operation.
- Changed property syncDataStartTime (object)
  The timestamp in milliseconds when the current data synchronization operation started.
- Changed property tags (object)
  The comma separated list of custom tags assigned to this switch for organization and filtering.
- Changed property trustPorts (object)
  The list of port identifiers configured as trusted ports for DHCP snooping and ARP inspection.
- Changed property venueId (object)
  The unique identifier of the venue where the switch is located.
- Changed property vlanCustomize (object)
  The flag indicating whether VLAN configurations have been customized from default settings.
- Changed property position (object)
  The switch position view, representing the physical location of a switch on a floor plan with x and y coordinates as percentages.
  - Added property xPercent (object)
    The horizontal position of the switch on the floor plan as a percentage of the total width.
  - Added property yPercent (object)
    The vertical position of the switch on the floor plan as a percentage of the total height.
  - Deleted property xpercent (object)
  - Deleted property ypercent (object)
  - Changed property floorplanId (object)
    The identifier of the floor plan where this switch is located.
  - Changed property id (object)
    The identifier

PUT /switches/{switchId}

Request:

Changed content type : application/json

Deleted property stackMembersAndFilterActiveId (object)
Changed property defaultGateway (object)
Default gateway IP address for the switch management interface.
Changed property description (object)
Description or notes for the switch.
Changed property dhcpClientEnabled (object)
Flag indicating whether DHCP client is enabled for obtaining IP address (default: true).
Changed property dhcpServerEnabled (object)
Flag indicating whether DHCP server is enabled on the switch (default: false).
Changed property displayOfStack (object)
Display string representing the stack configuration.
Changed property enableStack (object)
Flag indicating whether stacking is enabled on this switch.
Changed property firmwareVersion (object)
Current firmware version installed on the switch.
Changed property id (object)
Unique identifier for the switch (typically the serial number).
Changed property igmpSnooping (object)
IGMP snooping configuration status (e.g., enabled, disabled).
Changed property initialVlanId (object)
Initial VLAN ID for the switch management interface.
Changed property ipAddress (object)
Static IP address assigned to the switch management interface.
Changed property ipAddressInterface (object)
Interface name or number for the IP address assignment (e.g., ve1, ethernet1/1/1).
Changed property ipAddressInterfaceType (object)
Type of interface for IP address assignment (e.g., VE, ETHERNET).
Changed property ipAddressType (object)
IP address assignment type (static or dynamic).
Changed property jumboMode (object)
Flag indicating whether jumbo frame mode is enabled (default: false).
Changed property lastDataSyncTime (object)
Timestamp of the last successful data synchronization from the switch.
Changed property lastDataSyncTriggerTime (object)
Timestamp when the last data synchronization was triggered.
Changed property model (object)
Switch model (e.g., ICX7150, ICX7250, ICX7450).
Added enum values:
- ICX8200-C08ZP-V
- ICX8200-24ZP-V
- ICX8200-48ZP2-V
- ICX8200-48P-V
- ICX8200-48PF-V
- ICX8200-48PF2-V
- ICX8100-C08PF-V
- ICX8100-24P-V
- ICX8100-48P-V
Changed property name (object)
Name or hostname for the switch.
Changed property position (object)
Physical position or location description of the switch.
Changed property previousMembers (object)
Set of serial numbers of previous stack members.
Changed property rearModule (object)
Rear module configuration for the switch (e.g., 'none', 'stack-40g' for ICX7650).
Changed property softDeletedDate (object)
Timestamp when the switch was soft deleted (marked for deletion).
Changed property spanningTreePriority (object)
STP (Spanning Tree Protocol) priority value for this switch (0-61440, in increments of 4096).
Changed property specifiedType (object)
Specified firmware image type for the switch (e.g., ROUTER, SWITCH).
Changed property stackConfigTimestamp (object)
Timestamp of the last stack configuration change.
Changed property stackMembers (object)
List of stack member information if this is a stacked switch.
Changed property subnetMask (object)
Subnet mask for the switch management interface.
Changed property syncDataEndTime (object)
End time of the data synchronization process.
Changed property syncDataId (object)
Unique identifier for the data synchronization session.
Changed property syncDataStartTime (object)
Start time of the data synchronization process.
Changed property tags (object)
Comma separated tags for categorizing or labeling the switch.
Changed property trustPorts (object)
List of trusted ports for DHCP snooping (e.g., ['1/1/1', '1/1/2']).
Changed property venueId (object)
Venue identifier where the switch will be registered.
Changed property vlanCustomize (object)
Flag indicating whether VLAN configuration is customized (non default).

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

Deleted property stackMembersAndFilterActiveId (object)
Changed property defaultGateway (object)
Default gateway IP address for the switch management interface.
Changed property description (object)
Description or notes for the switch.
Changed property dhcpClientEnabled (object)
Flag indicating whether DHCP client is enabled for obtaining IP address (default: true).
Changed property dhcpServerEnabled (object)
Flag indicating whether DHCP server is enabled on the switch (default: false).
Changed property displayOfStack (object)
Display string representing the stack configuration.
Changed property enableStack (object)
Flag indicating whether stacking is enabled on this switch.
Changed property firmwareVersion (object)
Current firmware version installed on the switch.
Changed property id (object)
Unique identifier for the switch (typically the serial number).
Changed property igmpSnooping (object)
IGMP snooping configuration status (e.g., enabled, disabled).
Changed property initialVlanId (object)
Initial VLAN ID for the switch management interface.
Changed property ipAddress (object)
Static IP address assigned to the switch management interface.
Changed property ipAddressInterface (object)
Interface name or number for the IP address assignment (e.g., ve1, ethernet1/1/1).
Changed property ipAddressInterfaceType (object)
Type of interface for IP address assignment (e.g., VE, ETHERNET).
Changed property ipAddressType (object)
IP address assignment type (static or dynamic).
Changed property jumboMode (object)
Flag indicating whether jumbo frame mode is enabled (default: false).
Changed property lastDataSyncTime (object)
Timestamp of the last successful data synchronization from the switch.
Changed property lastDataSyncTriggerTime (object)
Timestamp when the last data synchronization was triggered.
Changed property model (object)
Switch model (e.g., ICX7150, ICX7250, ICX7450).
Added enum values:
- ICX8200-C08ZP-V
- ICX8200-24ZP-V
- ICX8200-48ZP2-V
- ICX8200-48P-V
- ICX8200-48PF-V
- ICX8200-48PF2-V
- ICX8100-C08PF-V
- ICX8100-24P-V
- ICX8100-48P-V
Changed property name (object)
Name or hostname for the switch.
Changed property position (object)
Physical position or location description of the switch.
Changed property previousMembers (object)
Set of serial numbers of previous stack members.
Changed property rearModule (object)
Rear module configuration for the switch (e.g., 'none', 'stack-40g' for ICX7650).
Changed property softDeletedDate (object)
Timestamp when the switch was soft deleted (marked for deletion).
Changed property spanningTreePriority (object)
STP (Spanning Tree Protocol) priority value for this switch (0-61440, in increments of 4096).
Changed property specifiedType (object)
Specified firmware image type for the switch (e.g., ROUTER, SWITCH).
Changed property stackConfigTimestamp (object)
Timestamp of the last stack configuration change.
Changed property stackMembers (object)
List of stack member information if this is a stacked switch.
Changed property subnetMask (object)
Subnet mask for the switch management interface.
Changed property syncDataEndTime (object)
End time of the data synchronization process.
Changed property syncDataId (object)
Unique identifier for the data synchronization session.
Changed property syncDataStartTime (object)
Start time of the data synchronization process.
Changed property tags (object)
Comma separated tags for categorizing or labeling the switch.
Changed property trustPorts (object)
List of trusted ports for DHCP snooping (e.g., ['1/1/1', '1/1/2']).
Changed property venueId (object)
Venue identifier where the switch will be registered.
Changed property vlanCustomize (object)
Flag indicating whether VLAN configuration is customized (non default).

Return Type:

Changed response : 400 Bad Request

Bad/malformed request

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 401 Unauthorized

Unauthorized

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 403 Forbidden

Forbidden

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 404 Not Found

Requested resource or related entity not found

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 422 Unprocessable Entity

Validation error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 500 Internal Server Error

Internal Server Error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 200 OK

OK

Changed content type : application/json
- Changed property defaultGateway (object)
  The default gateway IP address for routing traffic from the switch management interface.
- Changed property description (object)
  The descriptive text providing additional information about the switch configuration or purpose.
- Changed property dhcpClientEnabled (object)
  The flag indicating whether the switch is configured as a DHCP client to obtain its management IP address.
- Changed property dhcpServerEnabled (object)
  The flag indicating whether the DHCP server feature is enabled on the switch.
- Changed property enableStack (object)
  The flag indicating whether switch stacking is enabled for combining multiple physical switches into a single logical unit.
- Changed property firmwareVersion (object)
  The current firmware version running on the switch.
- Changed property id (object)
  The identifier
- Changed property igmpSnooping (object)
  The IGMP snooping mode for multicast traffic optimization: enabled, disabled, or default.
- Changed property initialVlanId (object)
  The VLAN ID used for initial switch configuration and management access.
- Changed property ipAddress (object)
  The IPv4 address assigned to the switch management interface.
- Changed property ipAddressInterface (object)
  The specific interface identifier for the management IP address configuration.
- Changed property ipAddressInterfaceType (object)
  The interface type for the switch management IP address: VLAN interface or management port.
- Changed property ipAddressType (object)
  The IP address assignment method: static or DHCP.
- Changed property jumboMode (object)
  The flag indicating whether jumbo frame support is enabled, allowing frames larger than 1518 bytes.
- Changed property lastDataSyncTime (object)
  The timestamp in milliseconds when the last data synchronization completed for this switch.
- Changed property lastDataSyncTriggerTime (object)
  The timestamp in milliseconds when the last data synchronization was triggered for this switch.
- Changed property name (object)
  The name assigned to the ICX switch for identification in the network.
- Changed property previousMembers (object)
  The set of serial numbers for previous stack members that have been removed from the stack.
- Changed property rearModule (object)
  The model identifier of the rear expansion module installed on the switch, if applicable.
- Changed property softDeletedDate (object)
  The timestamp when the switch was soft deleted, allowing for recovery before permanent deletion.
- Changed property spanningTreePriority (object)
  The STP (Spanning Tree Protocol) bridge priority value, used in root bridge election (lower values have higher priority).
- Changed property specifiedType (object)
  The firmware image type specified for the switch: primary, secondary, or boot.
- Changed property stackConfigTimestamp (object)
  The timestamp indicating when the stack configuration was last modified.
- Changed property stackMembers (object)
  The list of member switches in a stack configuration, including their models and active status.
- Changed property subnetMask (object)
  The subnet mask for the switch management IP address.
- Changed property syncDataEndTime (object)
  The timestamp in milliseconds when the current data synchronization operation ended.
- Changed property syncDataId (object)
  The unique identifier for the current data synchronization operation.
- Changed property syncDataStartTime (object)
  The timestamp in milliseconds when the current data synchronization operation started.
- Changed property tags (object)
  The comma separated list of custom tags assigned to this switch for organization and filtering.
- Changed property trustPorts (object)
  The list of port identifiers configured as trusted ports for DHCP snooping and ARP inspection.
- Changed property venueId (object)
  The unique identifier of the venue where the switch is located.
- Changed property vlanCustomize (object)
  The flag indicating whether VLAN configurations have been customized from default settings.
- Changed property position (object)
  The switch position view, representing the physical location of a switch on a floor plan with x and y coordinates as percentages.
  - Added property xPercent (object)
    The horizontal position of the switch on the floor plan as a percentage of the total width.
  - Added property yPercent (object)
    The vertical position of the switch on the floor plan as a percentage of the total height.
  - Deleted property xpercent (object)
  - Deleted property ypercent (object)
  - Changed property floorplanId (object)
    The identifier of the floor plan where this switch is located.
  - Changed property id (object)
    The identifier
Changed content type : application/vnd.ruckus.v1+json
- Changed property defaultGateway (object)
  The default gateway IP address for routing traffic from the switch management interface.
- Changed property description (object)
  The descriptive text providing additional information about the switch configuration or purpose.
- Changed property dhcpClientEnabled (object)
  The flag indicating whether the switch is configured as a DHCP client to obtain its management IP address.
- Changed property dhcpServerEnabled (object)
  The flag indicating whether the DHCP server feature is enabled on the switch.
- Changed property enableStack (object)
  The flag indicating whether switch stacking is enabled for combining multiple physical switches into a single logical unit.
- Changed property firmwareVersion (object)
  The current firmware version running on the switch.
- Changed property id (object)
  The identifier
- Changed property igmpSnooping (object)
  The IGMP snooping mode for multicast traffic optimization: enabled, disabled, or default.
- Changed property initialVlanId (object)
  The VLAN ID used for initial switch configuration and management access.
- Changed property ipAddress (object)
  The IPv4 address assigned to the switch management interface.
- Changed property ipAddressInterface (object)
  The specific interface identifier for the management IP address configuration.
- Changed property ipAddressInterfaceType (object)
  The interface type for the switch management IP address: VLAN interface or management port.
- Changed property ipAddressType (object)
  The IP address assignment method: static or DHCP.
- Changed property jumboMode (object)
  The flag indicating whether jumbo frame support is enabled, allowing frames larger than 1518 bytes.
- Changed property lastDataSyncTime (object)
  The timestamp in milliseconds when the last data synchronization completed for this switch.
- Changed property lastDataSyncTriggerTime (object)
  The timestamp in milliseconds when the last data synchronization was triggered for this switch.
- Changed property name (object)
  The name assigned to the ICX switch for identification in the network.
- Changed property previousMembers (object)
  The set of serial numbers for previous stack members that have been removed from the stack.
- Changed property rearModule (object)
  The model identifier of the rear expansion module installed on the switch, if applicable.
- Changed property softDeletedDate (object)
  The timestamp when the switch was soft deleted, allowing for recovery before permanent deletion.
- Changed property spanningTreePriority (object)
  The STP (Spanning Tree Protocol) bridge priority value, used in root bridge election (lower values have higher priority).
- Changed property specifiedType (object)
  The firmware image type specified for the switch: primary, secondary, or boot.
- Changed property stackConfigTimestamp (object)
  The timestamp indicating when the stack configuration was last modified.
- Changed property stackMembers (object)
  The list of member switches in a stack configuration, including their models and active status.
- Changed property subnetMask (object)
  The subnet mask for the switch management IP address.
- Changed property syncDataEndTime (object)
  The timestamp in milliseconds when the current data synchronization operation ended.
- Changed property syncDataId (object)
  The unique identifier for the current data synchronization operation.
- Changed property syncDataStartTime (object)
  The timestamp in milliseconds when the current data synchronization operation started.
- Changed property tags (object)
  The comma separated list of custom tags assigned to this switch for organization and filtering.
- Changed property trustPorts (object)
  The list of port identifiers configured as trusted ports for DHCP snooping and ARP inspection.
- Changed property venueId (object)
  The unique identifier of the venue where the switch is located.
- Changed property vlanCustomize (object)
  The flag indicating whether VLAN configurations have been customized from default settings.
- Changed property position (object)
  The switch position view, representing the physical location of a switch on a floor plan with x and y coordinates as percentages.
  - Added property xPercent (object)
    The horizontal position of the switch on the floor plan as a percentage of the total width.
  - Added property yPercent (object)
    The vertical position of the switch on the floor plan as a percentage of the total height.
  - Deleted property xpercent (object)
  - Deleted property ypercent (object)
  - Changed property floorplanId (object)
    The identifier of the floor plan where this switch is located.
  - Changed property id (object)
    The identifier

DELETE /switches/{switchId}

Return Type:

Changed response : 400 Bad Request

Bad/malformed request

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 401 Unauthorized

Unauthorized

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 403 Forbidden

Forbidden

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 404 Not Found

Requested resource or related entity not found

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 422 Unprocessable Entity

Validation error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 500 Internal Server Error

Internal Server Error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 200 OK

OK

Changed content type : application/json
- Changed property requestId (object)
  The unique identifier for tracking this API operation request.
- Changed property response (object)
  The empty view representing an API response with no data content, used for operations that return success status without additional information.
Changed content type : application/vnd.ruckus.v1+json
- Changed property requestId (object)
  The unique identifier for tracking this API operation request.
- Changed property response (object)
  The empty view representing an API response with no data content, used for operations that return success status without additional information.

GET /switches/{switchId}/configBackups

Return Type:

Changed response : 200 OK

OK

Changed content type : application/json
- Changed property backupId (object)
  The unique identifier for this configuration backup.
- Changed property backupName (object)
  The descriptive name assigned to this backup for easy identification.
- Changed property backupType (object)
  The type of configuration backup, indicating whether it is automatic, manual, or scheduled.
- Changed property config (object)
  The complete configuration content stored in this backup, containing all switch settings and commands.
- Changed property configBackupViewList (object)
  The list of configuration backup views, used for retrieving multiple backups in a single response.
- Changed property createdDate (object)
  The timestamp when this configuration backup was created.
- Changed property failureReason (object)
  The reason for backup or restore failure, providing details when the operation does not complete successfully.
- Changed property id (object)
  The identifier
- Changed property name (object)
  The name identifier for this configuration backup.
- Changed property restoreStatus (object)
  The status of the last restore operation performed using this backup.
- Changed property restoreTimestamp (object)
  The timestamp when this configuration was last restored to a switch.
- Changed property status (object)
  The current status of this backup, such as completed, in progress, or failed.
- Changed property switchId (object)
  The identifier of the switch that this configuration backup is associated with.
Changed content type : application/vnd.ruckus.v1+json
- Changed property backupId (object)
  The unique identifier for this configuration backup.
- Changed property backupName (object)
  The descriptive name assigned to this backup for easy identification.
- Changed property backupType (object)
  The type of configuration backup, indicating whether it is automatic, manual, or scheduled.
- Changed property config (object)
  The complete configuration content stored in this backup, containing all switch settings and commands.
- Changed property configBackupViewList (object)
  The list of configuration backup views, used for retrieving multiple backups in a single response.
- Changed property createdDate (object)
  The timestamp when this configuration backup was created.
- Changed property failureReason (object)
  The reason for backup or restore failure, providing details when the operation does not complete successfully.
- Changed property id (object)
  The identifier
- Changed property name (object)
  The name identifier for this configuration backup.
- Changed property restoreStatus (object)
  The status of the last restore operation performed using this backup.
- Changed property restoreTimestamp (object)
  The timestamp when this configuration was last restored to a switch.
- Changed property status (object)
  The current status of this backup, such as completed, in progress, or failed.
- Changed property switchId (object)
  The identifier of the switch that this configuration backup is associated with.

Changed response : 400 Bad Request

Bad/malformed request

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 401 Unauthorized

Unauthorized

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 403 Forbidden

Forbidden

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 404 Not Found

Requested resource or related entity not found

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 422 Unprocessable Entity

Validation error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 500 Internal Server Error

Internal Server Error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

POST /switches/{switchId}/configBackups

Request:

Changed content type : application/json

Changed property name (object)
The name of the configuration backup.

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

Changed property name (object)
The name of the configuration backup.

Return Type:

Changed response : 400 Bad Request

Bad/malformed request

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 401 Unauthorized

Unauthorized

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 403 Forbidden

Forbidden

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 404 Not Found

Requested resource or related entity not found

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 422 Unprocessable Entity

Validation error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 500 Internal Server Error

Internal Server Error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 200 OK

OK

Changed content type : application/json
- Changed property requestId (object)
  The unique identifier for tracking this API operation request.
- Changed property response (object)
  The empty view representing an API response with no data content, used for operations that return success status without additional information.
Changed content type : application/vnd.ruckus.v1+json
- Changed property requestId (object)
  The unique identifier for tracking this API operation request.
- Changed property response (object)
  The empty view representing an API response with no data content, used for operations that return success status without additional information.

POST /switches/{switchId}/configHistDetails/query

Request:

Changed content type : application/json

Deleted property orderBy (object)
Changed property filterByConfigType (object)
The configuration type filter to limit results to specific types such as VLAN, ACL, or port configurations.
Changed property filterByStatus (object)
The status filter to limit results to configuration deployments with specific status values such as success, failed, or in progress.
Changed property limit (object)
The maximum number of configuration history records to return per page, defaulting to 8.
Changed property page (object)
The page number for pagination, starting from 1, defaulting to 1.
Changed property pageSize (object)
The page size for pagination in the new request format, superseding the limit parameter when provided.
Changed property sortField (object)
The sort column for ordering configuration history records in the new request format.
Changed property sortOrder (object)
The sort order direction, either ascending or descending, for the new request format.
Changed property filters (object)
Schema for filtering configuration history records by criteria.
- Changed property configType (object)
  The type of configuration for filtering results.
- Changed property filterByStatus (object)
  Filter configuration history records by status.
  Added enum values:
  - ALL
  - SUCCESS
  - FAILED
  - NOTIFY_SUCCESS
Changed property sortInfo (object)
Schema for sorting configuration history details by column and direction.
- Changed property dir (object)
  The sort direction, ascending or descending.
- Changed property sortColumn (object)
  The column name used for sorting results.

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

Deleted property orderBy (object)
Changed property filterByConfigType (object)
The configuration type filter to limit results to specific types such as VLAN, ACL, or port configurations.
Changed property filterByStatus (object)
The status filter to limit results to configuration deployments with specific status values such as success, failed, or in progress.
Changed property limit (object)
The maximum number of configuration history records to return per page, defaulting to 8.
Changed property page (object)
The page number for pagination, starting from 1, defaulting to 1.
Changed property pageSize (object)
The page size for pagination in the new request format, superseding the limit parameter when provided.
Changed property sortField (object)
The sort column for ordering configuration history records in the new request format.
Changed property sortOrder (object)
The sort order direction, either ascending or descending, for the new request format.
Changed property filters (object)
Schema for filtering configuration history records by criteria.
- Changed property configType (object)
  The type of configuration for filtering results.
- Changed property filterByStatus (object)
  Filter configuration history records by status.
  Added enum values:
  - ALL
  - SUCCESS
  - FAILED
  - NOTIFY_SUCCESS
Changed property sortInfo (object)
Schema for sorting configuration history details by column and direction.
- Changed property dir (object)
  The sort direction, ascending or descending.
- Changed property sortColumn (object)
  The column name used for sorting results.

Return Type:

Changed response : 200 OK

OK

Changed content type : application/json
- Changed property id (object)
  The identifier
- Changed property list (object)
  The list of configuration history information records containing deployment details and status.
- Changed property totalCount (object)
  The total number of configuration history records matching the query criteria.
Changed content type : application/vnd.ruckus.v1+json
- Changed property id (object)
  The identifier
- Changed property list (object)
  The list of configuration history information records containing deployment details and status.
- Changed property totalCount (object)
  The total number of configuration history records matching the query criteria.

Changed response : 400 Bad Request

Bad/malformed request

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 401 Unauthorized

Unauthorized

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 403 Forbidden

Forbidden

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 404 Not Found

Requested resource or related entity not found

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 422 Unprocessable Entity

Validation error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 500 Internal Server Error

Internal Server Error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

PUT /switches/{switchId}/dhcpServers

Update DHCP Server Setting

Request:

Changed content type : application/json

Changed property defaultRouterIp (object)
Default gateway IP address to be assigned to DHCP clients.
Changed property dhcpOptions (object)
List of additional DHCP options (e.g., DNS server, domain name).
Changed property dhcpServerEnabled (object)
Flag indicating whether the DHCP server is enabled on the switch.
Changed property excludedEnd (object)
End IP address of the excluded range (addresses not to be assigned).
Changed property excludedStart (object)
Start IP address of the excluded range (addresses not to be assigned).
Changed property id (object)
Unique identifier for the DHCP server configuration.
Changed property leaseDays (object)
Lease duration in days.
Changed property leaseHrs (object)
Lease duration in hours.
Changed property leaseMins (object)
Lease duration in minutes.
Changed property network (object)
Network address in CIDR notation (e.g., 192.168.1.0/24).
Changed property poolName (object)
Name of the DHCP address pool (must be unique).
Changed property prefixLength (object)
Network prefix length (CIDR notation, e.g., 24 for /24).
Changed property subnetAddress (object)
Subnet address extracted from the network configuration.
Changed property subnetMask (object)
Subnet mask for the DHCP pool network (e.g., 255.255.255.0).
Changed property switchId (object)
Switch identifier (serial number) where this DHCP server is configured.

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

Changed property defaultRouterIp (object)
Default gateway IP address to be assigned to DHCP clients.
Changed property dhcpOptions (object)
List of additional DHCP options (e.g., DNS server, domain name).
Changed property dhcpServerEnabled (object)
Flag indicating whether the DHCP server is enabled on the switch.
Changed property excludedEnd (object)
End IP address of the excluded range (addresses not to be assigned).
Changed property excludedStart (object)
Start IP address of the excluded range (addresses not to be assigned).
Changed property id (object)
Unique identifier for the DHCP server configuration.
Changed property leaseDays (object)
Lease duration in days.
Changed property leaseHrs (object)
Lease duration in hours.
Changed property leaseMins (object)
Lease duration in minutes.
Changed property network (object)
Network address in CIDR notation (e.g., 192.168.1.0/24).
Changed property poolName (object)
Name of the DHCP address pool (must be unique).
Changed property prefixLength (object)
Network prefix length (CIDR notation, e.g., 24 for /24).
Changed property subnetAddress (object)
Subnet address extracted from the network configuration.
Changed property subnetMask (object)
Subnet mask for the DHCP pool network (e.g., 255.255.255.0).
Changed property switchId (object)
Switch identifier (serial number) where this DHCP server is configured.

Return Type:

Changed response : 200 OK

OK

Changed content type : application/json
- Changed property defaultRouterIp (object)
  The default gateway IP address provided to DHCP clients.
- Changed property dhcpOptions (object)
  The list of additional DHCP options to be provided to clients.
- Changed property excludedEnd (object)
  The ending IP address of the excluded address range that will not be assigned to clients.
- Changed property excludedStart (object)
  The starting IP address of the excluded address range that will not be assigned to clients.
- Changed property id (object)
  The unique identifier of the DHCP server configuration.
- Changed property leaseDays (object)
  The number of days in the DHCP lease duration.
- Changed property leaseHrs (object)
  The number of hours in the DHCP lease duration.
- Changed property leaseMins (object)
  The number of minutes in the DHCP lease duration.
- Changed property network (object)
  The network address for the DHCP pool.
- Changed property poolName (object)
  The name of the DHCP address pool.
- Changed property subnetAddress (object)
  The subnet network address for the DHCP pool.
- Changed property subnetMask (object)
  The subnet mask for the DHCP network.
Changed content type : application/vnd.ruckus.v1+json
- Changed property defaultRouterIp (object)
  The default gateway IP address provided to DHCP clients.
- Changed property dhcpOptions (object)
  The list of additional DHCP options to be provided to clients.
- Changed property excludedEnd (object)
  The ending IP address of the excluded address range that will not be assigned to clients.
- Changed property excludedStart (object)
  The starting IP address of the excluded address range that will not be assigned to clients.
- Changed property id (object)
  The unique identifier of the DHCP server configuration.
- Changed property leaseDays (object)
  The number of days in the DHCP lease duration.
- Changed property leaseHrs (object)
  The number of hours in the DHCP lease duration.
- Changed property leaseMins (object)
  The number of minutes in the DHCP lease duration.
- Changed property network (object)
  The network address for the DHCP pool.
- Changed property poolName (object)
  The name of the DHCP address pool.
- Changed property subnetAddress (object)
  The subnet network address for the DHCP pool.
- Changed property subnetMask (object)
  The subnet mask for the DHCP network.

Changed response : 400 Bad Request

Bad/malformed request

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 401 Unauthorized

Unauthorized

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 403 Forbidden

Forbidden

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 404 Not Found

Requested resource or related entity not found

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 422 Unprocessable Entity

Validation error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 500 Internal Server Error

Internal Server Error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

POST /switches/{switchId}/dhcpServers

Request:

Changed content type : application/json

Changed property defaultRouterIp (object)
Default gateway IP address to be assigned to DHCP clients.
Changed property dhcpOptions (object)
List of additional DHCP options (e.g., DNS server, domain name).
Changed property dhcpServerEnabled (object)
Flag indicating whether the DHCP server is enabled on the switch.
Changed property excludedEnd (object)
End IP address of the excluded range (addresses not to be assigned).
Changed property excludedStart (object)
Start IP address of the excluded range (addresses not to be assigned).
Changed property id (object)
Unique identifier for the DHCP server configuration.
Changed property leaseDays (object)
Lease duration in days.
Changed property leaseHrs (object)
Lease duration in hours.
Changed property leaseMins (object)
Lease duration in minutes.
Changed property network (object)
Network address in CIDR notation (e.g., 192.168.1.0/24).
Changed property poolName (object)
Name of the DHCP address pool (must be unique).
Changed property prefixLength (object)
Network prefix length (CIDR notation, e.g., 24 for /24).
Changed property subnetAddress (object)
Subnet address extracted from the network configuration.
Changed property subnetMask (object)
Subnet mask for the DHCP pool network (e.g., 255.255.255.0).
Changed property switchId (object)
Switch identifier (serial number) where this DHCP server is configured.

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

Changed property defaultRouterIp (object)
Default gateway IP address to be assigned to DHCP clients.
Changed property dhcpOptions (object)
List of additional DHCP options (e.g., DNS server, domain name).
Changed property dhcpServerEnabled (object)
Flag indicating whether the DHCP server is enabled on the switch.
Changed property excludedEnd (object)
End IP address of the excluded range (addresses not to be assigned).
Changed property excludedStart (object)
Start IP address of the excluded range (addresses not to be assigned).
Changed property id (object)
Unique identifier for the DHCP server configuration.
Changed property leaseDays (object)
Lease duration in days.
Changed property leaseHrs (object)
Lease duration in hours.
Changed property leaseMins (object)
Lease duration in minutes.
Changed property network (object)
Network address in CIDR notation (e.g., 192.168.1.0/24).
Changed property poolName (object)
Name of the DHCP address pool (must be unique).
Changed property prefixLength (object)
Network prefix length (CIDR notation, e.g., 24 for /24).
Changed property subnetAddress (object)
Subnet address extracted from the network configuration.
Changed property subnetMask (object)
Subnet mask for the DHCP pool network (e.g., 255.255.255.0).
Changed property switchId (object)
Switch identifier (serial number) where this DHCP server is configured.

Return Type:

Changed response : 200 OK

OK

Changed content type : application/json
- Changed property defaultRouterIp (object)
  The default gateway IP address provided to DHCP clients.
- Changed property dhcpOptions (object)
  The list of additional DHCP options to be provided to clients.
- Changed property excludedEnd (object)
  The ending IP address of the excluded address range that will not be assigned to clients.
- Changed property excludedStart (object)
  The starting IP address of the excluded address range that will not be assigned to clients.
- Changed property id (object)
  The unique identifier of the DHCP server configuration.
- Changed property leaseDays (object)
  The number of days in the DHCP lease duration.
- Changed property leaseHrs (object)
  The number of hours in the DHCP lease duration.
- Changed property leaseMins (object)
  The number of minutes in the DHCP lease duration.
- Changed property network (object)
  The network address for the DHCP pool.
- Changed property poolName (object)
  The name of the DHCP address pool.
- Changed property subnetAddress (object)
  The subnet network address for the DHCP pool.
- Changed property subnetMask (object)
  The subnet mask for the DHCP network.
Changed content type : application/vnd.ruckus.v1+json
- Changed property defaultRouterIp (object)
  The default gateway IP address provided to DHCP clients.
- Changed property dhcpOptions (object)
  The list of additional DHCP options to be provided to clients.
- Changed property excludedEnd (object)
  The ending IP address of the excluded address range that will not be assigned to clients.
- Changed property excludedStart (object)
  The starting IP address of the excluded address range that will not be assigned to clients.
- Changed property id (object)
  The unique identifier of the DHCP server configuration.
- Changed property leaseDays (object)
  The number of days in the DHCP lease duration.
- Changed property leaseHrs (object)
  The number of hours in the DHCP lease duration.
- Changed property leaseMins (object)
  The number of minutes in the DHCP lease duration.
- Changed property network (object)
  The network address for the DHCP pool.
- Changed property poolName (object)
  The name of the DHCP address pool.
- Changed property subnetAddress (object)
  The subnet network address for the DHCP pool.
- Changed property subnetMask (object)
  The subnet mask for the DHCP network.

Changed response : 400 Bad Request

Bad/malformed request

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 401 Unauthorized

Unauthorized

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 403 Forbidden

Forbidden

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 404 Not Found

Requested resource or related entity not found

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 422 Unprocessable Entity

Validation error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 500 Internal Server Error

Internal Server Error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

DELETE /switches/{switchId}/dhcpServers

Return Type:

Changed response : 400 Bad Request

Bad/malformed request

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 401 Unauthorized

Unauthorized

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 403 Forbidden

Forbidden

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 404 Not Found

Requested resource or related entity not found

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 422 Unprocessable Entity

Validation error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 500 Internal Server Error

Internal Server Error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 200 OK

OK

Changed content type : application/json
- Changed property requestId (object)
  The unique identifier for tracking this API operation request.
- Changed property response (object)
  The empty view representing an API response with no data content, used for operations that return success status without additional information.
Changed content type : application/vnd.ruckus.v1+json
- Changed property requestId (object)
  The unique identifier for tracking this API operation request.
- Changed property response (object)
  The empty view representing an API response with no data content, used for operations that return success status without additional information.

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

Delete DHCP Server Setting

Return Type:

Changed response : 400 Bad Request

Bad/malformed request

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 401 Unauthorized

Unauthorized

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 403 Forbidden

Forbidden

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 404 Not Found

Requested resource or related entity not found

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 422 Unprocessable Entity

Validation error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 500 Internal Server Error

Internal Server Error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 200 OK

OK

Changed content type : application/json
- Changed property requestId (object)
  The unique identifier for tracking this API operation request.
- Changed property response (object)
  The empty view representing an API response with no data content, used for operations that return success status without additional information.
Changed content type : application/vnd.ruckus.v1+json
- Changed property requestId (object)
  The unique identifier for tracking this API operation request.
- Changed property response (object)
  The empty view representing an API response with no data content, used for operations that return success status without additional information.

GET /switches/{switchId}/portSettings

Return Type:

Changed response : 400 Bad Request

Bad/malformed request

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 401 Unauthorized

Unauthorized

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 403 Forbidden

Forbidden

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 404 Not Found

Requested resource or related entity not found

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 422 Unprocessable Entity

Validation error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 500 Internal Server Error

Internal Server Error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 200 OK

OK

Changed content type : application/json
- Added property ipv6DhcpSnoopingTrust (object)
  The flag indicating whether this port is trusted for IPv6 DHCP snooping, bypassing DHCP validation.
- Added property ipv6NdInspectionTrust (object)
  The flag indicating whether this port is trusted for IPv6 ND (Neighbor Discovery) inspection, bypassing ND validation.
- Changed property adminPtToPt (object)
  The RSTP (Rapid Spanning Tree Protocol) point-to-point MAC mode.
- Changed property arpInspectionTrust (object)
  The flag indicating whether this port is trusted for ARP inspection, bypassing ARP validation.
- Changed property dhcpSnoopingTrust (object)
  The flag indicating whether this port is trusted for DHCP snooping, allowing DHCP server responses.
- Changed property egressAcl (object)
  The name of the Access Control List applied to egress (outgoing) traffic on this port.
- Changed property id (object)
  The identifier
- Changed property ignoreFields (object)
  The comma separated list of field names to ignore during update operations.
- Changed property ingressAcl (object)
  The name of the Access Control List applied to ingress (incoming) traffic on this port.
- Changed property ipsg (object)
  The flag indicating whether IP source guard is enabled for additional layer 2 security.
- Changed property lldpEnable (object)
  The flag indicating whether LLDP (Link Layer Discovery Protocol) is enabled on this port.
- Changed property lldpQos (object)
  The set of LLDP (Link Layer Discovery Protocol) QoS (Quality of Service) configurations for network priority advertising.
- Changed property name (object)
  The descriptive name or label assigned to the port for identification purposes.
- Changed property poeBudget (object)
  The PoE power budget allocated to this port in watts.
- Changed property poeCapability (object)
  The flag indicating whether this port has PoE (Power over Ethernet) hardware capability.
- Changed property poeClass (object)
  The PoE (Power over Ethernet) class indicating the maximum power level supported by the connected device.
- Changed property poeEnable (object)
  The flag indicating whether PoE (Power over Ethernet) is enabled on this port.
- Changed property poePriority (object)
  The PoE priority level for power allocation, with lower values indicating higher priority.
- Changed property portEnable (object)
  The flag indicating whether the port is administratively enabled for traffic forwarding.
- Changed property portProtected (object)
  The flag indicating whether the port is configured as a protected port, preventing communication with other protected ports.
- Changed property portSpeed (object)
  The configured speed setting for the port, such as auto negotiation or specific speed values.
- Changed property ports (object)
  The set of port identifiers when performing batch operations on multiple ports.
- Changed property profileName (object)
  The name of the profile applied to this port, displayed in the UI for reference.
- Changed property revert (object)
  The flag indicating whether to revert port configuration to profile defaults.
- Changed property rstpAdminEdgePort (object)
  The flag indicating whether this port is configured as an edge port in RSTP (Rapid Spanning Tree Protocol).
- Changed property stpBpduGuard (object)
  Indicates whether STP (Spanning Tree Protocol) BPDU (Bridge Protocol Data Unit) guard is enabled. When enabled, the port is disabled if BPDU frames are received.
- Changed property stpRootGuard (object)
  The flag indicating whether STP (Spanning Tree Protocol) root guard is enabled to prevent the port from becoming a root port.
- Changed property switchId (object)
  The unique identifier of the switch where this port is located.
- Changed property switchMac (object)
  The MAC address of the switch to which this port belongs, used for UI identification.
- Changed property taggedVlans (object)
  The ordered set of VLAN IDs configured as tagged VLANs on this port for 802.1Q trunking.
- Changed property tags (object)
  The comma separated list of custom tags assigned to this port for organization and filtering.
- Changed property untaggedVlan (object)
  The VLAN ID configured as the untagged (native) VLAN for this port.
- Changed property voiceVlan (object)
  The VLAN ID designated for voice traffic, typically used for VoIP devices.
- Changed property vsixEgressAcl (object)
  The name of the IPV6 ACL applied to egress traffic for virtual switch integration.
- Changed property vsixIngressAcl (object)
  The name of the IPv6 ACL applied to ingress traffic for virtual switch integration.
- Changed property lag (object)
  The LAG (Link Aggregation Group) view, representing a logical interface that bundles multiple physical ports for increased bandwidth and redundancy.
  - Changed property addPorts (object)
    The list of port identifiers to be added to this LAG.
  - Changed property defaultVlanId (object)
    The default VLAN identifier for the LAG interface.
  - Changed property id (object)
    The identifier
  - Changed property lagId (object)
    The unique identifier of the LAG interface.
  - Changed property lagViewList (object)
    The list of LAG view objects for batch operations.
  - Changed property lastName (object)
    The previous name of the LAG interface, used when renaming.
  - Changed property name (object)
    The name of the LAG interface, limited to 64 characters without quotes.
  - Changed property originalUntaggedVlan (object)
    The original untagged VLAN identifier before modification.
  - Changed property portAddVlans (object)
    The list of port VLAN associations to be added for LAG member ports.
  - Changed property portVlans (object)
    The list of port VLAN associations for LAG member ports.
  - Changed property ports (object)
    The set of physical port identifiers that are members of this LAG.
  - Changed property realRemove (object)
    Whether to perform a real removal operation when deleting the LAG.
  - Changed property removePorts (object)
    The list of port identifiers to be removed from this LAG.
  - Changed property switchId (object)
    The unique identifier of the switch where this LAG is configured.
  - Changed property taggedVlans (object)
    The set of VLAN identifiers that are tagged on this LAG interface.
  - Changed property tenantId (object)
    The unique identifier of the tenant.
  - Changed property type (object)
    The type of LAG protocol, such as static or LACP (Link Aggregation Control Protocol).
  - Changed property untaggedVlan (object)
    The VLAN identifier for untagged traffic on this LAG interface.
Changed content type : application/vnd.ruckus.v1+json
- Added property ipv6DhcpSnoopingTrust (object)
  The flag indicating whether this port is trusted for IPv6 DHCP snooping, bypassing DHCP validation.
- Added property ipv6NdInspectionTrust (object)
  The flag indicating whether this port is trusted for IPv6 ND (Neighbor Discovery) inspection, bypassing ND validation.
- Changed property adminPtToPt (object)
  The RSTP (Rapid Spanning Tree Protocol) point-to-point MAC mode.
- Changed property arpInspectionTrust (object)
  The flag indicating whether this port is trusted for ARP inspection, bypassing ARP validation.
- Changed property dhcpSnoopingTrust (object)
  The flag indicating whether this port is trusted for DHCP snooping, allowing DHCP server responses.
- Changed property egressAcl (object)
  The name of the Access Control List applied to egress (outgoing) traffic on this port.
- Changed property id (object)
  The identifier
- Changed property ignoreFields (object)
  The comma separated list of field names to ignore during update operations.
- Changed property ingressAcl (object)
  The name of the Access Control List applied to ingress (incoming) traffic on this port.
- Changed property ipsg (object)
  The flag indicating whether IP source guard is enabled for additional layer 2 security.
- Changed property lldpEnable (object)
  The flag indicating whether LLDP (Link Layer Discovery Protocol) is enabled on this port.
- Changed property lldpQos (object)
  The set of LLDP (Link Layer Discovery Protocol) QoS (Quality of Service) configurations for network priority advertising.
- Changed property name (object)
  The descriptive name or label assigned to the port for identification purposes.
- Changed property poeBudget (object)
  The PoE power budget allocated to this port in watts.
- Changed property poeCapability (object)
  The flag indicating whether this port has PoE (Power over Ethernet) hardware capability.
- Changed property poeClass (object)
  The PoE (Power over Ethernet) class indicating the maximum power level supported by the connected device.
- Changed property poeEnable (object)
  The flag indicating whether PoE (Power over Ethernet) is enabled on this port.
- Changed property poePriority (object)
  The PoE priority level for power allocation, with lower values indicating higher priority.
- Changed property portEnable (object)
  The flag indicating whether the port is administratively enabled for traffic forwarding.
- Changed property portProtected (object)
  The flag indicating whether the port is configured as a protected port, preventing communication with other protected ports.
- Changed property portSpeed (object)
  The configured speed setting for the port, such as auto negotiation or specific speed values.
- Changed property ports (object)
  The set of port identifiers when performing batch operations on multiple ports.
- Changed property profileName (object)
  The name of the profile applied to this port, displayed in the UI for reference.
- Changed property revert (object)
  The flag indicating whether to revert port configuration to profile defaults.
- Changed property rstpAdminEdgePort (object)
  The flag indicating whether this port is configured as an edge port in RSTP (Rapid Spanning Tree Protocol).
- Changed property stpBpduGuard (object)
  Indicates whether STP (Spanning Tree Protocol) BPDU (Bridge Protocol Data Unit) guard is enabled. When enabled, the port is disabled if BPDU frames are received.
- Changed property stpRootGuard (object)
  The flag indicating whether STP (Spanning Tree Protocol) root guard is enabled to prevent the port from becoming a root port.
- Changed property switchId (object)
  The unique identifier of the switch where this port is located.
- Changed property switchMac (object)
  The MAC address of the switch to which this port belongs, used for UI identification.
- Changed property taggedVlans (object)
  The ordered set of VLAN IDs configured as tagged VLANs on this port for 802.1Q trunking.
- Changed property tags (object)
  The comma separated list of custom tags assigned to this port for organization and filtering.
- Changed property untaggedVlan (object)
  The VLAN ID configured as the untagged (native) VLAN for this port.
- Changed property voiceVlan (object)
  The VLAN ID designated for voice traffic, typically used for VoIP devices.
- Changed property vsixEgressAcl (object)
  The name of the IPV6 ACL applied to egress traffic for virtual switch integration.
- Changed property vsixIngressAcl (object)
  The name of the IPv6 ACL applied to ingress traffic for virtual switch integration.
- Changed property lag (object)
  The LAG (Link Aggregation Group) view, representing a logical interface that bundles multiple physical ports for increased bandwidth and redundancy.
  - Changed property addPorts (object)
    The list of port identifiers to be added to this LAG.
  - Changed property defaultVlanId (object)
    The default VLAN identifier for the LAG interface.
  - Changed property id (object)
    The identifier
  - Changed property lagId (object)
    The unique identifier of the LAG interface.
  - Changed property lagViewList (object)
    The list of LAG view objects for batch operations.
  - Changed property lastName (object)
    The previous name of the LAG interface, used when renaming.
  - Changed property name (object)
    The name of the LAG interface, limited to 64 characters without quotes.
  - Changed property originalUntaggedVlan (object)
    The original untagged VLAN identifier before modification.
  - Changed property portAddVlans (object)
    The list of port VLAN associations to be added for LAG member ports.
  - Changed property portVlans (object)
    The list of port VLAN associations for LAG member ports.
  - Changed property ports (object)
    The set of physical port identifiers that are members of this LAG.
  - Changed property realRemove (object)
    Whether to perform a real removal operation when deleting the LAG.
  - Changed property removePorts (object)
    The list of port identifiers to be removed from this LAG.
  - Changed property switchId (object)
    The unique identifier of the switch where this LAG is configured.
  - Changed property taggedVlans (object)
    The set of VLAN identifiers that are tagged on this LAG interface.
  - Changed property tenantId (object)
    The unique identifier of the tenant.
  - Changed property type (object)
    The type of LAG protocol, such as static or LACP (Link Aggregation Control Protocol).
  - Changed property untaggedVlan (object)
    The VLAN identifier for untagged traffic on this LAG interface.

PUT /switches/{switchId}/portSettings

Request:

Changed content type : application/json

Added property ipv6DhcpSnoopingTrust (object)
The flag indicating whether this port is trusted for IPv6 DHCP snooping, bypassing DHCP validation.
Added property ipv6NdInspectionTrust (object)
The flag indicating whether this port is trusted for IPv6 ND (Neighbor Discovery) inspection, bypassing ND validation.
Deleted property authenticationDataByProfile (object)
Deleted property defaultVlan (object)
Deleted property ignoreFieldSet (object)
Deleted property portSet (object)
Changed property adminPtToPt (object)
The RSTP (Rapid Spanning Tree Protocol) point-to-point MAC mode.
Changed property arpInspectionTrust (object)
The flag indicating whether this port is trusted for ARP inspection, bypassing ARP validation.
Changed property authDefaultVlan (object)
The VLAN ID to assign authenticated users when no specific VLAN is provided by the AAA server.
Changed property authFailAction (object)
The action to take when authentication fails: restricted VLAN, drop, or block.
Changed property authTimeoutAction (object)
The action to take when authentication times out: same as auth fail or critical VLAN.
Changed property authenticationCustomize (object)
The flag indicating whether port specific authentication settings override the profile defaults.
Changed property authenticationProfileId (object)
The identifier of the authentication profile applied to this port for access control.
Changed property authenticationType (object)
The authentication method type configured for this port, such as 802.1X, MAC authentication, or Web authentication.
Changed property changeAuthOrder (object)
The flag indicating whether the authentication method order has been modified from defaults.
Changed property criticalVlan (object)
The VLAN ID for critical users requiring network access during AAA server failure.
Changed property dhcpSnoopingTrust (object)
The flag indicating whether this port is trusted for DHCP snooping, allowing DHCP server responses.
Changed property dot1xPortControl (object)
The 802.1X port control mode determining authentication requirements: auto, force authorized, or force unauthorized.
Changed property egressAcl (object)
The name of the Access Control List applied to egress (outgoing) traffic on this port.
Changed property flexibleAuthenticationEnabled (object)
The flag indicating whether flexible authentication with multiple methods is enabled on this port.
Changed property guestVlan (object)
The VLAN ID for guest users who bypass authentication.
Changed property ignoreFields (object)
The comma separated list of field names to ignore during update operations.
Changed property ingressAcl (object)
The name of the Access Control List applied to ingress (incoming) traffic on this port.
Changed property ipsg (object)
The flag indicating whether IP source guard is enabled for additional layer 2 security.
Changed property lldpEnable (object)
The flag indicating whether LLDP (Link Layer Discovery Protocol) is enabled on this port.
Changed property lldpQos (object)
The set of LLDP (Link Layer Discovery Protocol) QoS (Quality of Service) configurations for network priority advertising.
Changed property name (object)
The descriptive name or label assigned to the port for identification purposes.
Changed property poeBudget (object)
The PoE power budget allocated to this port in watts.
Changed property poeCapability (object)
The flag indicating whether this port has PoE (Power over Ethernet) hardware capability.
Changed property poeClass (object)
The PoE (Power over Ethernet) class indicating the maximum power level supported by the connected device.
Changed property poeEnable (object)
The flag indicating whether PoE (Power over Ethernet) is enabled on this port.
Changed property poePriority (object)
The PoE priority level for power allocation, with lower values indicating higher priority.
Changed property portEnable (object)
The flag indicating whether the port is administratively enabled for traffic forwarding.
Changed property portProtected (object)
The flag indicating whether the port is configured as a protected port, preventing communication with other protected ports.
Changed property portSecurity (object)
The flag indicating whether port security is enabled to restrict MAC addresses allowed on this port.
Changed property portSecurityMaxEntries (object)
The maximum number of MAC addresses allowed when port security is enabled.
Changed property portSpeed (object)
The configured speed setting for the port, such as auto negotiation or specific speed values.
Changed property ports (object)
The set of port identifiers when performing batch operations on multiple ports.
Changed property restrictedVlan (object)
The VLAN ID for users who fail authorization after successful authentication.
Changed property revert (object)
The flag indicating whether to revert port configuration to profile defaults.
Changed property rstpAdminEdgePort (object)
The flag indicating whether this port is configured as an edge port in RSTP (Rapid Spanning Tree Protocol).
Changed property stpBpduGuard (object)
Indicates whether STP (Spanning Tree Protocol) BPDU (Bridge Protocol Data Unit) guard is enabled. When enabled, the port is disabled if BPDU frames are received.
Changed property stpRootGuard (object)
The flag indicating whether STP (Spanning Tree Protocol) root guard is enabled to prevent the port from becoming a root port.
Changed property switchMacAcl (object)
The name of the MAC based ACL (Access Control List) applied to this port for layer 2 filtering.
Changed property switchPortProfileId (object)
The identifier of the switch port profile configuration applied to this port.
Changed property switchSerialNumber (object)
The serial number of the switch for hardware identification.
Changed property taggedVlans (object)
The set of VLAN IDs configured as tagged VLANs on this port for 802.1Q trunking.
Changed property tags (object)
The comma separated list of custom tags assigned to this port for organization and filtering.
Changed property untaggedVlan (object)
The VLAN ID configured as the untagged (native) VLAN for this port.
Changed property voiceVlan (object)
The VLAN ID designated for voice traffic, typically used for VoIP devices.
Changed property poeScheduler (object)
Scheduler configuration for defining time-based schedules with daily time slots (24 hours per day, each hour divided into 30-minute blocks).
- Changed property fri (object)
  Friday schedule bitmap (24 characters, each character represents a 1-hour block).
- Changed property mon (object)
  Monday schedule bitmap (24 characters, each character represents a 1-hour block).
- Changed property sat (object)
  Saturday schedule bitmap (24 characters, each character represents a 1-hour block).
- Changed property sun (object)
  Sunday schedule bitmap (24 characters, each character represents a 1-hour block).
- Changed property thu (object)
  Thursday schedule bitmap (24 characters, each character represents a 1-hour block).
- Changed property timeZone (object)
  Time zone identifier for the schedule (e.g., 'America/New_York', 'UTC', default: empty).
- Changed property tue (object)
  Tuesday schedule bitmap (24 characters, each character represents a 1-hour block).
- Changed property type (object)
  Scheduler type indicating the purpose of the schedule (e.g., POE_SCHEDULER for PoE power scheduling).
- Changed property wed (object)
  Wednesday schedule bitmap (24 characters, each character represents a 1-hour block).

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

Added property ipv6DhcpSnoopingTrust (object)
The flag indicating whether this port is trusted for IPv6 DHCP snooping, bypassing DHCP validation.
Added property ipv6NdInspectionTrust (object)
The flag indicating whether this port is trusted for IPv6 ND (Neighbor Discovery) inspection, bypassing ND validation.
Deleted property authenticationDataByProfile (object)
Deleted property defaultVlan (object)
Deleted property ignoreFieldSet (object)
Deleted property portSet (object)
Changed property adminPtToPt (object)
The RSTP (Rapid Spanning Tree Protocol) point-to-point MAC mode.
Changed property arpInspectionTrust (object)
The flag indicating whether this port is trusted for ARP inspection, bypassing ARP validation.
Changed property authDefaultVlan (object)
The VLAN ID to assign authenticated users when no specific VLAN is provided by the AAA server.
Changed property authFailAction (object)
The action to take when authentication fails: restricted VLAN, drop, or block.
Changed property authTimeoutAction (object)
The action to take when authentication times out: same as auth fail or critical VLAN.
Changed property authenticationCustomize (object)
The flag indicating whether port specific authentication settings override the profile defaults.
Changed property authenticationProfileId (object)
The identifier of the authentication profile applied to this port for access control.
Changed property authenticationType (object)
The authentication method type configured for this port, such as 802.1X, MAC authentication, or Web authentication.
Changed property changeAuthOrder (object)
The flag indicating whether the authentication method order has been modified from defaults.
Changed property criticalVlan (object)
The VLAN ID for critical users requiring network access during AAA server failure.
Changed property dhcpSnoopingTrust (object)
The flag indicating whether this port is trusted for DHCP snooping, allowing DHCP server responses.
Changed property dot1xPortControl (object)
The 802.1X port control mode determining authentication requirements: auto, force authorized, or force unauthorized.
Changed property egressAcl (object)
The name of the Access Control List applied to egress (outgoing) traffic on this port.
Changed property flexibleAuthenticationEnabled (object)
The flag indicating whether flexible authentication with multiple methods is enabled on this port.
Changed property guestVlan (object)
The VLAN ID for guest users who bypass authentication.
Changed property ignoreFields (object)
The comma separated list of field names to ignore during update operations.
Changed property ingressAcl (object)
The name of the Access Control List applied to ingress (incoming) traffic on this port.
Changed property ipsg (object)
The flag indicating whether IP source guard is enabled for additional layer 2 security.
Changed property lldpEnable (object)
The flag indicating whether LLDP (Link Layer Discovery Protocol) is enabled on this port.
Changed property lldpQos (object)
The set of LLDP (Link Layer Discovery Protocol) QoS (Quality of Service) configurations for network priority advertising.
Changed property name (object)
The descriptive name or label assigned to the port for identification purposes.
Changed property poeBudget (object)
The PoE power budget allocated to this port in watts.
Changed property poeCapability (object)
The flag indicating whether this port has PoE (Power over Ethernet) hardware capability.
Changed property poeClass (object)
The PoE (Power over Ethernet) class indicating the maximum power level supported by the connected device.
Changed property poeEnable (object)
The flag indicating whether PoE (Power over Ethernet) is enabled on this port.
Changed property poePriority (object)
The PoE priority level for power allocation, with lower values indicating higher priority.
Changed property portEnable (object)
The flag indicating whether the port is administratively enabled for traffic forwarding.
Changed property portProtected (object)
The flag indicating whether the port is configured as a protected port, preventing communication with other protected ports.
Changed property portSecurity (object)
The flag indicating whether port security is enabled to restrict MAC addresses allowed on this port.
Changed property portSecurityMaxEntries (object)
The maximum number of MAC addresses allowed when port security is enabled.
Changed property portSpeed (object)
The configured speed setting for the port, such as auto negotiation or specific speed values.
Changed property ports (object)
The set of port identifiers when performing batch operations on multiple ports.
Changed property restrictedVlan (object)
The VLAN ID for users who fail authorization after successful authentication.
Changed property revert (object)
The flag indicating whether to revert port configuration to profile defaults.
Changed property rstpAdminEdgePort (object)
The flag indicating whether this port is configured as an edge port in RSTP (Rapid Spanning Tree Protocol).
Changed property stpBpduGuard (object)
Indicates whether STP (Spanning Tree Protocol) BPDU (Bridge Protocol Data Unit) guard is enabled. When enabled, the port is disabled if BPDU frames are received.
Changed property stpRootGuard (object)
The flag indicating whether STP (Spanning Tree Protocol) root guard is enabled to prevent the port from becoming a root port.
Changed property switchMacAcl (object)
The name of the MAC based ACL (Access Control List) applied to this port for layer 2 filtering.
Changed property switchPortProfileId (object)
The identifier of the switch port profile configuration applied to this port.
Changed property switchSerialNumber (object)
The serial number of the switch for hardware identification.
Changed property taggedVlans (object)
The set of VLAN IDs configured as tagged VLANs on this port for 802.1Q trunking.
Changed property tags (object)
The comma separated list of custom tags assigned to this port for organization and filtering.
Changed property untaggedVlan (object)
The VLAN ID configured as the untagged (native) VLAN for this port.
Changed property voiceVlan (object)
The VLAN ID designated for voice traffic, typically used for VoIP devices.
Changed property poeScheduler (object)
Scheduler configuration for defining time-based schedules with daily time slots (24 hours per day, each hour divided into 30-minute blocks).
- Changed property fri (object)
  Friday schedule bitmap (24 characters, each character represents a 1-hour block).
- Changed property mon (object)
  Monday schedule bitmap (24 characters, each character represents a 1-hour block).
- Changed property sat (object)
  Saturday schedule bitmap (24 characters, each character represents a 1-hour block).
- Changed property sun (object)
  Sunday schedule bitmap (24 characters, each character represents a 1-hour block).
- Changed property thu (object)
  Thursday schedule bitmap (24 characters, each character represents a 1-hour block).
- Changed property timeZone (object)
  Time zone identifier for the schedule (e.g., 'America/New_York', 'UTC', default: empty).
- Changed property tue (object)
  Tuesday schedule bitmap (24 characters, each character represents a 1-hour block).
- Changed property type (object)
  Scheduler type indicating the purpose of the schedule (e.g., POE_SCHEDULER for PoE power scheduling).
- Changed property wed (object)
  Wednesday schedule bitmap (24 characters, each character represents a 1-hour block).

Return Type:

Changed response : 400 Bad Request

Bad/malformed request

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 401 Unauthorized

Unauthorized

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 403 Forbidden

Forbidden

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 404 Not Found

Requested resource or related entity not found

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 422 Unprocessable Entity

Validation error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 500 Internal Server Error

Internal Server Error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 200 OK

OK

Changed content type : application/json
- Added property ipv6DhcpSnoopingTrust (object)
  The flag indicating whether this port is trusted for IPv6 DHCP snooping, bypassing DHCP validation.
- Added property ipv6NdInspectionTrust (object)
  The flag indicating whether this port is trusted for IPv6 ND (Neighbor Discovery) inspection, bypassing ND validation.
- Changed property adminPtToPt (object)
  The RSTP (Rapid Spanning Tree Protocol) point-to-point MAC mode.
- Changed property arpInspectionTrust (object)
  The flag indicating whether this port is trusted for ARP inspection, bypassing ARP validation.
- Changed property dhcpSnoopingTrust (object)
  The flag indicating whether this port is trusted for DHCP snooping, allowing DHCP server responses.
- Changed property egressAcl (object)
  The name of the Access Control List applied to egress (outgoing) traffic on this port.
- Changed property id (object)
  The identifier
- Changed property ignoreFields (object)
  The comma separated list of field names to ignore during update operations.
- Changed property ingressAcl (object)
  The name of the Access Control List applied to ingress (incoming) traffic on this port.
- Changed property ipsg (object)
  The flag indicating whether IP source guard is enabled for additional layer 2 security.
- Changed property lldpEnable (object)
  The flag indicating whether LLDP (Link Layer Discovery Protocol) is enabled on this port.
- Changed property lldpQos (object)
  The set of LLDP (Link Layer Discovery Protocol) QoS (Quality of Service) configurations for network priority advertising.
- Changed property name (object)
  The descriptive name or label assigned to the port for identification purposes.
- Changed property poeBudget (object)
  The PoE power budget allocated to this port in watts.
- Changed property poeCapability (object)
  The flag indicating whether this port has PoE (Power over Ethernet) hardware capability.
- Changed property poeClass (object)
  The PoE (Power over Ethernet) class indicating the maximum power level supported by the connected device.
- Changed property poeEnable (object)
  The flag indicating whether PoE (Power over Ethernet) is enabled on this port.
- Changed property poePriority (object)
  The PoE priority level for power allocation, with lower values indicating higher priority.
- Changed property portEnable (object)
  The flag indicating whether the port is administratively enabled for traffic forwarding.
- Changed property portProtected (object)
  The flag indicating whether the port is configured as a protected port, preventing communication with other protected ports.
- Changed property portSpeed (object)
  The configured speed setting for the port, such as auto negotiation or specific speed values.
- Changed property ports (object)
  The set of port identifiers when performing batch operations on multiple ports.
- Changed property profileName (object)
  The name of the profile applied to this port, displayed in the UI for reference.
- Changed property revert (object)
  The flag indicating whether to revert port configuration to profile defaults.
- Changed property rstpAdminEdgePort (object)
  The flag indicating whether this port is configured as an edge port in RSTP (Rapid Spanning Tree Protocol).
- Changed property stpBpduGuard (object)
  Indicates whether STP (Spanning Tree Protocol) BPDU (Bridge Protocol Data Unit) guard is enabled. When enabled, the port is disabled if BPDU frames are received.
- Changed property stpRootGuard (object)
  The flag indicating whether STP (Spanning Tree Protocol) root guard is enabled to prevent the port from becoming a root port.
- Changed property switchId (object)
  The unique identifier of the switch where this port is located.
- Changed property switchMac (object)
  The MAC address of the switch to which this port belongs, used for UI identification.
- Changed property taggedVlans (object)
  The ordered set of VLAN IDs configured as tagged VLANs on this port for 802.1Q trunking.
- Changed property tags (object)
  The comma separated list of custom tags assigned to this port for organization and filtering.
- Changed property untaggedVlan (object)
  The VLAN ID configured as the untagged (native) VLAN for this port.
- Changed property voiceVlan (object)
  The VLAN ID designated for voice traffic, typically used for VoIP devices.
- Changed property vsixEgressAcl (object)
  The name of the IPV6 ACL applied to egress traffic for virtual switch integration.
- Changed property vsixIngressAcl (object)
  The name of the IPv6 ACL applied to ingress traffic for virtual switch integration.
- Changed property lag (object)
  The LAG (Link Aggregation Group) view, representing a logical interface that bundles multiple physical ports for increased bandwidth and redundancy.
  - Changed property addPorts (object)
    The list of port identifiers to be added to this LAG.
  - Changed property defaultVlanId (object)
    The default VLAN identifier for the LAG interface.
  - Changed property id (object)
    The identifier
  - Changed property lagId (object)
    The unique identifier of the LAG interface.
  - Changed property lagViewList (object)
    The list of LAG view objects for batch operations.
  - Changed property lastName (object)
    The previous name of the LAG interface, used when renaming.
  - Changed property name (object)
    The name of the LAG interface, limited to 64 characters without quotes.
  - Changed property originalUntaggedVlan (object)
    The original untagged VLAN identifier before modification.
  - Changed property portAddVlans (object)
    The list of port VLAN associations to be added for LAG member ports.
  - Changed property portVlans (object)
    The list of port VLAN associations for LAG member ports.
  - Changed property ports (object)
    The set of physical port identifiers that are members of this LAG.
  - Changed property realRemove (object)
    Whether to perform a real removal operation when deleting the LAG.
  - Changed property removePorts (object)
    The list of port identifiers to be removed from this LAG.
  - Changed property switchId (object)
    The unique identifier of the switch where this LAG is configured.
  - Changed property taggedVlans (object)
    The set of VLAN identifiers that are tagged on this LAG interface.
  - Changed property tenantId (object)
    The unique identifier of the tenant.
  - Changed property type (object)
    The type of LAG protocol, such as static or LACP (Link Aggregation Control Protocol).
  - Changed property untaggedVlan (object)
    The VLAN identifier for untagged traffic on this LAG interface.
Changed content type : application/vnd.ruckus.v1+json
- Added property ipv6DhcpSnoopingTrust (object)
  The flag indicating whether this port is trusted for IPv6 DHCP snooping, bypassing DHCP validation.
- Added property ipv6NdInspectionTrust (object)
  The flag indicating whether this port is trusted for IPv6 ND (Neighbor Discovery) inspection, bypassing ND validation.
- Changed property adminPtToPt (object)
  The RSTP (Rapid Spanning Tree Protocol) point-to-point MAC mode.
- Changed property arpInspectionTrust (object)
  The flag indicating whether this port is trusted for ARP inspection, bypassing ARP validation.
- Changed property dhcpSnoopingTrust (object)
  The flag indicating whether this port is trusted for DHCP snooping, allowing DHCP server responses.
- Changed property egressAcl (object)
  The name of the Access Control List applied to egress (outgoing) traffic on this port.
- Changed property id (object)
  The identifier
- Changed property ignoreFields (object)
  The comma separated list of field names to ignore during update operations.
- Changed property ingressAcl (object)
  The name of the Access Control List applied to ingress (incoming) traffic on this port.
- Changed property ipsg (object)
  The flag indicating whether IP source guard is enabled for additional layer 2 security.
- Changed property lldpEnable (object)
  The flag indicating whether LLDP (Link Layer Discovery Protocol) is enabled on this port.
- Changed property lldpQos (object)
  The set of LLDP (Link Layer Discovery Protocol) QoS (Quality of Service) configurations for network priority advertising.
- Changed property name (object)
  The descriptive name or label assigned to the port for identification purposes.
- Changed property poeBudget (object)
  The PoE power budget allocated to this port in watts.
- Changed property poeCapability (object)
  The flag indicating whether this port has PoE (Power over Ethernet) hardware capability.
- Changed property poeClass (object)
  The PoE (Power over Ethernet) class indicating the maximum power level supported by the connected device.
- Changed property poeEnable (object)
  The flag indicating whether PoE (Power over Ethernet) is enabled on this port.
- Changed property poePriority (object)
  The PoE priority level for power allocation, with lower values indicating higher priority.
- Changed property portEnable (object)
  The flag indicating whether the port is administratively enabled for traffic forwarding.
- Changed property portProtected (object)
  The flag indicating whether the port is configured as a protected port, preventing communication with other protected ports.
- Changed property portSpeed (object)
  The configured speed setting for the port, such as auto negotiation or specific speed values.
- Changed property ports (object)
  The set of port identifiers when performing batch operations on multiple ports.
- Changed property profileName (object)
  The name of the profile applied to this port, displayed in the UI for reference.
- Changed property revert (object)
  The flag indicating whether to revert port configuration to profile defaults.
- Changed property rstpAdminEdgePort (object)
  The flag indicating whether this port is configured as an edge port in RSTP (Rapid Spanning Tree Protocol).
- Changed property stpBpduGuard (object)
  Indicates whether STP (Spanning Tree Protocol) BPDU (Bridge Protocol Data Unit) guard is enabled. When enabled, the port is disabled if BPDU frames are received.
- Changed property stpRootGuard (object)
  The flag indicating whether STP (Spanning Tree Protocol) root guard is enabled to prevent the port from becoming a root port.
- Changed property switchId (object)
  The unique identifier of the switch where this port is located.
- Changed property switchMac (object)
  The MAC address of the switch to which this port belongs, used for UI identification.
- Changed property taggedVlans (object)
  The ordered set of VLAN IDs configured as tagged VLANs on this port for 802.1Q trunking.
- Changed property tags (object)
  The comma separated list of custom tags assigned to this port for organization and filtering.
- Changed property untaggedVlan (object)
  The VLAN ID configured as the untagged (native) VLAN for this port.
- Changed property voiceVlan (object)
  The VLAN ID designated for voice traffic, typically used for VoIP devices.
- Changed property vsixEgressAcl (object)
  The name of the IPV6 ACL applied to egress traffic for virtual switch integration.
- Changed property vsixIngressAcl (object)
  The name of the IPv6 ACL applied to ingress traffic for virtual switch integration.
- Changed property lag (object)
  The LAG (Link Aggregation Group) view, representing a logical interface that bundles multiple physical ports for increased bandwidth and redundancy.
  - Changed property addPorts (object)
    The list of port identifiers to be added to this LAG.
  - Changed property defaultVlanId (object)
    The default VLAN identifier for the LAG interface.
  - Changed property id (object)
    The identifier
  - Changed property lagId (object)
    The unique identifier of the LAG interface.
  - Changed property lagViewList (object)
    The list of LAG view objects for batch operations.
  - Changed property lastName (object)
    The previous name of the LAG interface, used when renaming.
  - Changed property name (object)
    The name of the LAG interface, limited to 64 characters without quotes.
  - Changed property originalUntaggedVlan (object)
    The original untagged VLAN identifier before modification.
  - Changed property portAddVlans (object)
    The list of port VLAN associations to be added for LAG member ports.
  - Changed property portVlans (object)
    The list of port VLAN associations for LAG member ports.
  - Changed property ports (object)
    The set of physical port identifiers that are members of this LAG.
  - Changed property realRemove (object)
    Whether to perform a real removal operation when deleting the LAG.
  - Changed property removePorts (object)
    The list of port identifiers to be removed from this LAG.
  - Changed property switchId (object)
    The unique identifier of the switch where this LAG is configured.
  - Changed property taggedVlans (object)
    The set of VLAN identifiers that are tagged on this LAG interface.
  - Changed property tenantId (object)
    The unique identifier of the tenant.
  - Changed property type (object)
    The type of LAG protocol, such as static or LACP (Link Aggregation Control Protocol).
  - Changed property untaggedVlan (object)
    The VLAN identifier for untagged traffic on this LAG interface.

POST /switches/{switchId}/portSettings

Return Type:

Changed response : 400 Bad Request

Bad/malformed request

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 401 Unauthorized

Unauthorized

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 403 Forbidden

Forbidden

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 404 Not Found

Requested resource or related entity not found

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 422 Unprocessable Entity

Validation error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 500 Internal Server Error

Internal Server Error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 200 OK

OK

Changed content type : application/json
- Added property ipv6DhcpSnoopingTrust (object)
  The flag indicating whether this port is trusted for IPv6 DHCP snooping, bypassing DHCP validation.
- Added property ipv6NdInspectionTrust (object)
  The flag indicating whether this port is trusted for IPv6 ND (Neighbor Discovery) inspection, bypassing ND validation.
- Changed property adminPtToPt (object)
  The RSTP (Rapid Spanning Tree Protocol) point-to-point MAC mode.
- Changed property arpInspectionTrust (object)
  The flag indicating whether this port is trusted for ARP inspection, bypassing ARP validation.
- Changed property dhcpSnoopingTrust (object)
  The flag indicating whether this port is trusted for DHCP snooping, allowing DHCP server responses.
- Changed property egressAcl (object)
  The name of the Access Control List applied to egress (outgoing) traffic on this port.
- Changed property id (object)
  The identifier
- Changed property ignoreFields (object)
  The comma separated list of field names to ignore during update operations.
- Changed property ingressAcl (object)
  The name of the Access Control List applied to ingress (incoming) traffic on this port.
- Changed property ipsg (object)
  The flag indicating whether IP source guard is enabled for additional layer 2 security.
- Changed property lldpEnable (object)
  The flag indicating whether LLDP (Link Layer Discovery Protocol) is enabled on this port.
- Changed property lldpQos (object)
  The set of LLDP (Link Layer Discovery Protocol) QoS (Quality of Service) configurations for network priority advertising.
- Changed property name (object)
  The descriptive name or label assigned to the port for identification purposes.
- Changed property poeBudget (object)
  The PoE power budget allocated to this port in watts.
- Changed property poeCapability (object)
  The flag indicating whether this port has PoE (Power over Ethernet) hardware capability.
- Changed property poeClass (object)
  The PoE (Power over Ethernet) class indicating the maximum power level supported by the connected device.
- Changed property poeEnable (object)
  The flag indicating whether PoE (Power over Ethernet) is enabled on this port.
- Changed property poePriority (object)
  The PoE priority level for power allocation, with lower values indicating higher priority.
- Changed property portEnable (object)
  The flag indicating whether the port is administratively enabled for traffic forwarding.
- Changed property portProtected (object)
  The flag indicating whether the port is configured as a protected port, preventing communication with other protected ports.
- Changed property portSpeed (object)
  The configured speed setting for the port, such as auto negotiation or specific speed values.
- Changed property ports (object)
  The set of port identifiers when performing batch operations on multiple ports.
- Changed property profileName (object)
  The name of the profile applied to this port, displayed in the UI for reference.
- Changed property revert (object)
  The flag indicating whether to revert port configuration to profile defaults.
- Changed property rstpAdminEdgePort (object)
  The flag indicating whether this port is configured as an edge port in RSTP (Rapid Spanning Tree Protocol).
- Changed property stpBpduGuard (object)
  Indicates whether STP (Spanning Tree Protocol) BPDU (Bridge Protocol Data Unit) guard is enabled. When enabled, the port is disabled if BPDU frames are received.
- Changed property stpRootGuard (object)
  The flag indicating whether STP (Spanning Tree Protocol) root guard is enabled to prevent the port from becoming a root port.
- Changed property switchId (object)
  The unique identifier of the switch where this port is located.
- Changed property switchMac (object)
  The MAC address of the switch to which this port belongs, used for UI identification.
- Changed property taggedVlans (object)
  The ordered set of VLAN IDs configured as tagged VLANs on this port for 802.1Q trunking.
- Changed property tags (object)
  The comma separated list of custom tags assigned to this port for organization and filtering.
- Changed property untaggedVlan (object)
  The VLAN ID configured as the untagged (native) VLAN for this port.
- Changed property voiceVlan (object)
  The VLAN ID designated for voice traffic, typically used for VoIP devices.
- Changed property vsixEgressAcl (object)
  The name of the IPV6 ACL applied to egress traffic for virtual switch integration.
- Changed property vsixIngressAcl (object)
  The name of the IPv6 ACL applied to ingress traffic for virtual switch integration.
- Changed property lag (object)
  The LAG (Link Aggregation Group) view, representing a logical interface that bundles multiple physical ports for increased bandwidth and redundancy.
  - Changed property addPorts (object)
    The list of port identifiers to be added to this LAG.
  - Changed property defaultVlanId (object)
    The default VLAN identifier for the LAG interface.
  - Changed property id (object)
    The identifier
  - Changed property lagId (object)
    The unique identifier of the LAG interface.
  - Changed property lagViewList (object)
    The list of LAG view objects for batch operations.
  - Changed property lastName (object)
    The previous name of the LAG interface, used when renaming.
  - Changed property name (object)
    The name of the LAG interface, limited to 64 characters without quotes.
  - Changed property originalUntaggedVlan (object)
    The original untagged VLAN identifier before modification.
  - Changed property portAddVlans (object)
    The list of port VLAN associations to be added for LAG member ports.
  - Changed property portVlans (object)
    The list of port VLAN associations for LAG member ports.
  - Changed property ports (object)
    The set of physical port identifiers that are members of this LAG.
  - Changed property realRemove (object)
    Whether to perform a real removal operation when deleting the LAG.
  - Changed property removePorts (object)
    The list of port identifiers to be removed from this LAG.
  - Changed property switchId (object)
    The unique identifier of the switch where this LAG is configured.
  - Changed property taggedVlans (object)
    The set of VLAN identifiers that are tagged on this LAG interface.
  - Changed property tenantId (object)
    The unique identifier of the tenant.
  - Changed property type (object)
    The type of LAG protocol, such as static or LACP (Link Aggregation Control Protocol).
  - Changed property untaggedVlan (object)
    The VLAN identifier for untagged traffic on this LAG interface.
Changed content type : application/vnd.ruckus.v1+json
- Added property ipv6DhcpSnoopingTrust (object)
  The flag indicating whether this port is trusted for IPv6 DHCP snooping, bypassing DHCP validation.
- Added property ipv6NdInspectionTrust (object)
  The flag indicating whether this port is trusted for IPv6 ND (Neighbor Discovery) inspection, bypassing ND validation.
- Changed property adminPtToPt (object)
  The RSTP (Rapid Spanning Tree Protocol) point-to-point MAC mode.
- Changed property arpInspectionTrust (object)
  The flag indicating whether this port is trusted for ARP inspection, bypassing ARP validation.
- Changed property dhcpSnoopingTrust (object)
  The flag indicating whether this port is trusted for DHCP snooping, allowing DHCP server responses.
- Changed property egressAcl (object)
  The name of the Access Control List applied to egress (outgoing) traffic on this port.
- Changed property id (object)
  The identifier
- Changed property ignoreFields (object)
  The comma separated list of field names to ignore during update operations.
- Changed property ingressAcl (object)
  The name of the Access Control List applied to ingress (incoming) traffic on this port.
- Changed property ipsg (object)
  The flag indicating whether IP source guard is enabled for additional layer 2 security.
- Changed property lldpEnable (object)
  The flag indicating whether LLDP (Link Layer Discovery Protocol) is enabled on this port.
- Changed property lldpQos (object)
  The set of LLDP (Link Layer Discovery Protocol) QoS (Quality of Service) configurations for network priority advertising.
- Changed property name (object)
  The descriptive name or label assigned to the port for identification purposes.
- Changed property poeBudget (object)
  The PoE power budget allocated to this port in watts.
- Changed property poeCapability (object)
  The flag indicating whether this port has PoE (Power over Ethernet) hardware capability.
- Changed property poeClass (object)
  The PoE (Power over Ethernet) class indicating the maximum power level supported by the connected device.
- Changed property poeEnable (object)
  The flag indicating whether PoE (Power over Ethernet) is enabled on this port.
- Changed property poePriority (object)
  The PoE priority level for power allocation, with lower values indicating higher priority.
- Changed property portEnable (object)
  The flag indicating whether the port is administratively enabled for traffic forwarding.
- Changed property portProtected (object)
  The flag indicating whether the port is configured as a protected port, preventing communication with other protected ports.
- Changed property portSpeed (object)
  The configured speed setting for the port, such as auto negotiation or specific speed values.
- Changed property ports (object)
  The set of port identifiers when performing batch operations on multiple ports.
- Changed property profileName (object)
  The name of the profile applied to this port, displayed in the UI for reference.
- Changed property revert (object)
  The flag indicating whether to revert port configuration to profile defaults.
- Changed property rstpAdminEdgePort (object)
  The flag indicating whether this port is configured as an edge port in RSTP (Rapid Spanning Tree Protocol).
- Changed property stpBpduGuard (object)
  Indicates whether STP (Spanning Tree Protocol) BPDU (Bridge Protocol Data Unit) guard is enabled. When enabled, the port is disabled if BPDU frames are received.
- Changed property stpRootGuard (object)
  The flag indicating whether STP (Spanning Tree Protocol) root guard is enabled to prevent the port from becoming a root port.
- Changed property switchId (object)
  The unique identifier of the switch where this port is located.
- Changed property switchMac (object)
  The MAC address of the switch to which this port belongs, used for UI identification.
- Changed property taggedVlans (object)
  The ordered set of VLAN IDs configured as tagged VLANs on this port for 802.1Q trunking.
- Changed property tags (object)
  The comma separated list of custom tags assigned to this port for organization and filtering.
- Changed property untaggedVlan (object)
  The VLAN ID configured as the untagged (native) VLAN for this port.
- Changed property voiceVlan (object)
  The VLAN ID designated for voice traffic, typically used for VoIP devices.
- Changed property vsixEgressAcl (object)
  The name of the IPV6 ACL applied to egress traffic for virtual switch integration.
- Changed property vsixIngressAcl (object)
  The name of the IPv6 ACL applied to ingress traffic for virtual switch integration.
- Changed property lag (object)
  The LAG (Link Aggregation Group) view, representing a logical interface that bundles multiple physical ports for increased bandwidth and redundancy.
  - Changed property addPorts (object)
    The list of port identifiers to be added to this LAG.
  - Changed property defaultVlanId (object)
    The default VLAN identifier for the LAG interface.
  - Changed property id (object)
    The identifier
  - Changed property lagId (object)
    The unique identifier of the LAG interface.
  - Changed property lagViewList (object)
    The list of LAG view objects for batch operations.
  - Changed property lastName (object)
    The previous name of the LAG interface, used when renaming.
  - Changed property name (object)
    The name of the LAG interface, limited to 64 characters without quotes.
  - Changed property originalUntaggedVlan (object)
    The original untagged VLAN identifier before modification.
  - Changed property portAddVlans (object)
    The list of port VLAN associations to be added for LAG member ports.
  - Changed property portVlans (object)
    The list of port VLAN associations for LAG member ports.
  - Changed property ports (object)
    The set of physical port identifiers that are members of this LAG.
  - Changed property realRemove (object)
    Whether to perform a real removal operation when deleting the LAG.
  - Changed property removePorts (object)
    The list of port identifiers to be removed from this LAG.
  - Changed property switchId (object)
    The unique identifier of the switch where this LAG is configured.
  - Changed property taggedVlans (object)
    The set of VLAN identifiers that are tagged on this LAG interface.
  - Changed property tenantId (object)
    The unique identifier of the tenant.
  - Changed property type (object)
    The type of LAG protocol, such as static or LACP (Link Aggregation Control Protocol).
  - Changed property untaggedVlan (object)
    The VLAN identifier for untagged traffic on this LAG interface.

GET /switches/{switchId}/vlans

Return Type:

Changed response : 400 Bad Request

Bad/malformed request

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 401 Unauthorized

Unauthorized

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 403 Forbidden

Forbidden

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 404 Not Found

Requested resource or related entity not found

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 422 Unprocessable Entity

Validation error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 500 Internal Server Error

Internal Server Error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 200 OK

OK

Changed content type : application/json
- Changed property arpInspection (object)
  The flag indicating whether ARP inspection is enabled for this VLAN to prevent ARP spoofing attacks.
- Changed property enableAsDefaultVlan (object)
  The flag indicating whether this VLAN is configured as the default VLAN for the switch.
- Changed property id (object)
  The identifier
- Changed property igmpSnooping (object)
  The IGMP snooping mode for this VLAN to optimize multicast traffic delivery.
- Changed property ipv4DhcpSnooping (object)
  The flag indicating whether IPv4 DHCP snooping is enabled for this VLAN to prevent rogue DHCP servers.
- Changed property multicastVersion (object)
  The IGMP version number used for multicast group management in this VLAN.
- Changed property spanningTreeProtocol (object)
  The STP (Spanning Tree Protocol) variant enabled for this VLAN.
- Changed property switchVlanPortModels (object)
  The set of port model configurations specific to this VLAN on different switch models in a stack.
- Changed property taggedPorts (object)
  The comma separated list of port identifiers configured as tagged (trunk) ports for this VLAN.
- Changed property untaggedPorts (object)
  The comma separated list of port identifiers configured as untagged (access) ports for this VLAN.
- Changed property vlanId (object)
  The VLAN identifier, ranging from 1 to 4095, uniquely identifying this VLAN on the switch.
- Changed property vlanName (object)
  The descriptive name assigned to this VLAN for identification purposes.
- Changed property vePort (object)
  The virtual ethernet port view, representing a layer 3 virtual interface configuration with IP addressing, routing capabilities, and ACL assignments.
  - Changed property connectedVe (object)
    The flag indicating whether this VE interface is connected and operational.
  - Changed property defaultVlan (object)
    The flag indicating whether this is the default VLAN for the switch (deprecated, use connectedVe instead).
  - Changed property deviceStatus (object)
    The operational status of the device associated with this VE interface.
  - Changed property dhcpRelayAgent (object)
    The IP address of the DHCP relay agent for forwarding DHCP requests across subnets.
  - Changed property egressAclName (object)
    The name of the Access Control List applied to egress (outgoing) traffic on this VE interface.
  - Changed property id (object)
    The identifier
  - Changed property ingressAclName (object)
    The name of the Access Control List applied to ingress (incoming) traffic on this VE interface.
  - Changed property ipAddress (object)
    The IPv4 address assigned to this virtual ethernet interface.
  - Changed property ipAddressType (object)
    The IP address assignment method for this VE interface: static or dynamic.
  - Changed property ipSubnetMask (object)
    The subnet mask for the IP address of this virtual ethernet interface.
  - Changed property name (object)
    The descriptive name assigned to the virtual ethernet interface.
  - Changed property ospfArea (object)
    The OSPF area identifier for routing protocol configuration on this VE interface.
  - Changed property portType (object)
    The type of port associated with this VE interface.
  - Changed property stack (object)
    The flag indicating whether the switch is configured in a stack.
  - Changed property switchId (object)
    The identifier of the switch where this VE interface is configured.
  - Changed property switchName (object)
    The name of the switch where this VE interface is configured.
  - Changed property syncedSwitchConfig (object)
    The flag indicating whether the VE interface configuration has been synchronized with the switch.
  - Changed property tenantId (object)
    The unique identifier of the tenant.
  - Changed property veId (object)
    The virtual ethernet interface identifier, used as the VE interface number.
  - Changed property vePortViewList (object)
    The list of VE port configurations for batch operations or nested VE management.
  - Changed property vlanId (object)
    The VLAN ID associated with this virtual ethernet interface for layer 3 routing.
  - Changed property vsixEgressAclName (object)
    The name of the VSIX ACL applied to egress traffic for virtual switch integration.
  - Changed property vsixIngressAclName (object)
    The name of the VSIX ACL applied to ingress traffic for virtual switch integration.
Changed content type : application/vnd.ruckus.v1+json
- Changed property arpInspection (object)
  The flag indicating whether ARP inspection is enabled for this VLAN to prevent ARP spoofing attacks.
- Changed property enableAsDefaultVlan (object)
  The flag indicating whether this VLAN is configured as the default VLAN for the switch.
- Changed property id (object)
  The identifier
- Changed property igmpSnooping (object)
  The IGMP snooping mode for this VLAN to optimize multicast traffic delivery.
- Changed property ipv4DhcpSnooping (object)
  The flag indicating whether IPv4 DHCP snooping is enabled for this VLAN to prevent rogue DHCP servers.
- Changed property multicastVersion (object)
  The IGMP version number used for multicast group management in this VLAN.
- Changed property spanningTreeProtocol (object)
  The STP (Spanning Tree Protocol) variant enabled for this VLAN.
- Changed property switchVlanPortModels (object)
  The set of port model configurations specific to this VLAN on different switch models in a stack.
- Changed property taggedPorts (object)
  The comma separated list of port identifiers configured as tagged (trunk) ports for this VLAN.
- Changed property untaggedPorts (object)
  The comma separated list of port identifiers configured as untagged (access) ports for this VLAN.
- Changed property vlanId (object)
  The VLAN identifier, ranging from 1 to 4095, uniquely identifying this VLAN on the switch.
- Changed property vlanName (object)
  The descriptive name assigned to this VLAN for identification purposes.
- Changed property vePort (object)
  The virtual ethernet port view, representing a layer 3 virtual interface configuration with IP addressing, routing capabilities, and ACL assignments.
  - Changed property connectedVe (object)
    The flag indicating whether this VE interface is connected and operational.
  - Changed property defaultVlan (object)
    The flag indicating whether this is the default VLAN for the switch (deprecated, use connectedVe instead).
  - Changed property deviceStatus (object)
    The operational status of the device associated with this VE interface.
  - Changed property dhcpRelayAgent (object)
    The IP address of the DHCP relay agent for forwarding DHCP requests across subnets.
  - Changed property egressAclName (object)
    The name of the Access Control List applied to egress (outgoing) traffic on this VE interface.
  - Changed property id (object)
    The identifier
  - Changed property ingressAclName (object)
    The name of the Access Control List applied to ingress (incoming) traffic on this VE interface.
  - Changed property ipAddress (object)
    The IPv4 address assigned to this virtual ethernet interface.
  - Changed property ipAddressType (object)
    The IP address assignment method for this VE interface: static or dynamic.
  - Changed property ipSubnetMask (object)
    The subnet mask for the IP address of this virtual ethernet interface.
  - Changed property name (object)
    The descriptive name assigned to the virtual ethernet interface.
  - Changed property ospfArea (object)
    The OSPF area identifier for routing protocol configuration on this VE interface.
  - Changed property portType (object)
    The type of port associated with this VE interface.
  - Changed property stack (object)
    The flag indicating whether the switch is configured in a stack.
  - Changed property switchId (object)
    The identifier of the switch where this VE interface is configured.
  - Changed property switchName (object)
    The name of the switch where this VE interface is configured.
  - Changed property syncedSwitchConfig (object)
    The flag indicating whether the VE interface configuration has been synchronized with the switch.
  - Changed property tenantId (object)
    The unique identifier of the tenant.
  - Changed property veId (object)
    The virtual ethernet interface identifier, used as the VE interface number.
  - Changed property vePortViewList (object)
    The list of VE port configurations for batch operations or nested VE management.
  - Changed property vlanId (object)
    The VLAN ID associated with this virtual ethernet interface for layer 3 routing.
  - Changed property vsixEgressAclName (object)
    The name of the VSIX ACL applied to egress traffic for virtual switch integration.
  - Changed property vsixIngressAclName (object)
    The name of the VSIX ACL applied to ingress traffic for virtual switch integration.

POST /switches/{switchId}/vlans

Request:

Changed content type : application/json

Added property ipv6DhcpSnooping (object)
Enable IPv6 DHCP snooping to prevent such attacks, DHCPv6 snooping helps to secure the IPv6 address configuration in the network (default: false).
Added property ipv6DhcpSnoopingTrustPort (object)
Comma separated list of trusted port identifiers for IPv6 DHCP snooping.
Added property ipv6DhcpSnoopingTrustPortList (object)
List of individual trusted port identifiers for IPv6 DHCP snooping parsed from ipv6DhcpSnoopingTrustPort.
Added property ipv6DhcpTrustPortsList (object)
List of IPv6 DHCP trusted ports for internal use.
Added property ipv6NdInspection (object)
Enable IPv6 ND (Neighbor Discovery) inspection to prevents IPv6 address spoofing at the switch level (default: false).
Added property ipv6NdInspectionTrustPort (object)
Comma separated list of trusted port identifiers for IPv6 ND (Neighbor Discovery) inspection.
Added property ipv6NdInspectionTrustPortList (object)
List of individual trusted port identifiers for IPv6 ND (Neighbor Discovery) inspection parsed from ipv6NdInspectionTrustPort.
Added property ipv6NdTrustPortsList (object)
List of IPv6 ND (Neighbor Discovery) trusted ports for internal use.
Deleted property defaultVlan (object)
Deleted property deleteVlanEnabled (object)
Deleted property dummyVlan (object)
Deleted property igmpSnoopingTypeChanged (object)
Deleted property notDummyVlan (object)
Deleted property rapidSpanningTreeProtocol (object)
Deleted property switchVlanPortModel (object)
Deleted property taggedPortsList (object)
Deleted property untaggedPortsList (object)
Changed property arpInspection (object)
Enable ARP inspection to prevent ARP spoofing attacks (default: false).
Changed property arpInspectionTrustPort (object)
Comma separated list of trusted port identifiers for ARP inspection.
Changed property arpInspectionTrustPortList (object)
List of individual trusted port identifiers for ARP inspection parsed from arpInspectionTrustPort.
Changed property arpTrustPortsList (object)
List of ARP trusted ports for internal use.
Changed property dhcpTrustPortsList (object)
List of DHCP trusted ports for internal use.
Changed property enableAsDefaultVlan (object)
Flag to enable this VLAN as the default VLAN for the switch (default: false).
Changed property id (object)
Unique identifier for the VLAN configuration.
Changed property igmpSnooping (object)
IGMP snooping mode for multicast traffic optimization.
Changed property ipv4DhcpSnooping (object)
Enable IPv4 DHCP snooping to prevent rogue DHCP servers (default: false).
Changed property ipv4DhcpSnoopingTrustPort (object)
Comma separated list of trusted port identifiers for DHCP snooping.
Changed property ipv4DhcpSnoopingTrustPortList (object)
List of individual trusted port identifiers for DHCP snooping parsed from ipv4DhcpSnoopingTrustPort.
Changed property managementVlan (object)
Flag indicating whether this is a management VLAN for switch management access (default: false).
Changed property multicastVersion (object)
IGMP multicast version (0-3).
Changed property rootBridgeFamilyId (object)
Root bridge family ID for spanning tree protocol.
Changed property spanningTreePriority (object)
Spanning tree priority value for root bridge election (0-65535, default: 32768, lower values have higher priority).
Changed property spanningTreeProtocol (object)
STP (Spanning Tree Protocol) mode for loop prevention.
Changed property switchFamilyModels (object)
Set of switch family model configurations for this VLAN.
Changed property switchId (object)
Switch identifier (serial number) where this VLAN is configured.
Changed property switchVlanPortModels (object)
Set of port model configurations defining which ports are assigned to this VLAN as tagged, untagged, or voice ports.
Changed property vlanId (object)
VLAN identifier number (1-4095).
Changed property vlanName (object)
VLAN name for identification and management purposes.

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

Added property ipv6DhcpSnooping (object)
Enable IPv6 DHCP snooping to prevent such attacks, DHCPv6 snooping helps to secure the IPv6 address configuration in the network (default: false).
Added property ipv6DhcpSnoopingTrustPort (object)
Comma separated list of trusted port identifiers for IPv6 DHCP snooping.
Added property ipv6DhcpSnoopingTrustPortList (object)
List of individual trusted port identifiers for IPv6 DHCP snooping parsed from ipv6DhcpSnoopingTrustPort.
Added property ipv6DhcpTrustPortsList (object)
List of IPv6 DHCP trusted ports for internal use.
Added property ipv6NdInspection (object)
Enable IPv6 ND (Neighbor Discovery) inspection to prevents IPv6 address spoofing at the switch level (default: false).
Added property ipv6NdInspectionTrustPort (object)
Comma separated list of trusted port identifiers for IPv6 ND (Neighbor Discovery) inspection.
Added property ipv6NdInspectionTrustPortList (object)
List of individual trusted port identifiers for IPv6 ND (Neighbor Discovery) inspection parsed from ipv6NdInspectionTrustPort.
Added property ipv6NdTrustPortsList (object)
List of IPv6 ND (Neighbor Discovery) trusted ports for internal use.
Deleted property defaultVlan (object)
Deleted property deleteVlanEnabled (object)
Deleted property dummyVlan (object)
Deleted property igmpSnoopingTypeChanged (object)
Deleted property notDummyVlan (object)
Deleted property rapidSpanningTreeProtocol (object)
Deleted property switchVlanPortModel (object)
Deleted property taggedPortsList (object)
Deleted property untaggedPortsList (object)
Changed property arpInspection (object)
Enable ARP inspection to prevent ARP spoofing attacks (default: false).
Changed property arpInspectionTrustPort (object)
Comma separated list of trusted port identifiers for ARP inspection.
Changed property arpInspectionTrustPortList (object)
List of individual trusted port identifiers for ARP inspection parsed from arpInspectionTrustPort.
Changed property arpTrustPortsList (object)
List of ARP trusted ports for internal use.
Changed property dhcpTrustPortsList (object)
List of DHCP trusted ports for internal use.
Changed property enableAsDefaultVlan (object)
Flag to enable this VLAN as the default VLAN for the switch (default: false).
Changed property id (object)
Unique identifier for the VLAN configuration.
Changed property igmpSnooping (object)
IGMP snooping mode for multicast traffic optimization.
Changed property ipv4DhcpSnooping (object)
Enable IPv4 DHCP snooping to prevent rogue DHCP servers (default: false).
Changed property ipv4DhcpSnoopingTrustPort (object)
Comma separated list of trusted port identifiers for DHCP snooping.
Changed property ipv4DhcpSnoopingTrustPortList (object)
List of individual trusted port identifiers for DHCP snooping parsed from ipv4DhcpSnoopingTrustPort.
Changed property managementVlan (object)
Flag indicating whether this is a management VLAN for switch management access (default: false).
Changed property multicastVersion (object)
IGMP multicast version (0-3).
Changed property rootBridgeFamilyId (object)
Root bridge family ID for spanning tree protocol.
Changed property spanningTreePriority (object)
Spanning tree priority value for root bridge election (0-65535, default: 32768, lower values have higher priority).
Changed property spanningTreeProtocol (object)
STP (Spanning Tree Protocol) mode for loop prevention.
Changed property switchFamilyModels (object)
Set of switch family model configurations for this VLAN.
Changed property switchId (object)
Switch identifier (serial number) where this VLAN is configured.
Changed property switchVlanPortModels (object)
Set of port model configurations defining which ports are assigned to this VLAN as tagged, untagged, or voice ports.
Changed property vlanId (object)
VLAN identifier number (1-4095).
Changed property vlanName (object)
VLAN name for identification and management purposes.

Return Type:

Changed response : 400 Bad Request

Bad/malformed request

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 401 Unauthorized

Unauthorized

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 403 Forbidden

Forbidden

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 404 Not Found

Requested resource or related entity not found

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 422 Unprocessable Entity

Validation error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 500 Internal Server Error

Internal Server Error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 200 OK

OK

Changed content type : application/json
- Changed property arpInspection (object)
  The flag indicating whether ARP inspection is enabled for this VLAN to prevent ARP spoofing attacks.
- Changed property enableAsDefaultVlan (object)
  The flag indicating whether this VLAN is configured as the default VLAN for the switch.
- Changed property id (object)
  The identifier
- Changed property igmpSnooping (object)
  The IGMP snooping mode for this VLAN to optimize multicast traffic delivery.
- Changed property ipv4DhcpSnooping (object)
  The flag indicating whether IPv4 DHCP snooping is enabled for this VLAN to prevent rogue DHCP servers.
- Changed property multicastVersion (object)
  The IGMP version number used for multicast group management in this VLAN.
- Changed property spanningTreeProtocol (object)
  The STP (Spanning Tree Protocol) variant enabled for this VLAN.
- Changed property switchVlanPortModels (object)
  The set of port model configurations specific to this VLAN on different switch models in a stack.
- Changed property taggedPorts (object)
  The comma separated list of port identifiers configured as tagged (trunk) ports for this VLAN.
- Changed property untaggedPorts (object)
  The comma separated list of port identifiers configured as untagged (access) ports for this VLAN.
- Changed property vlanId (object)
  The VLAN identifier, ranging from 1 to 4095, uniquely identifying this VLAN on the switch.
- Changed property vlanName (object)
  The descriptive name assigned to this VLAN for identification purposes.
- Changed property vePort (object)
  The virtual ethernet port view, representing a layer 3 virtual interface configuration with IP addressing, routing capabilities, and ACL assignments.
  - Changed property connectedVe (object)
    The flag indicating whether this VE interface is connected and operational.
  - Changed property defaultVlan (object)
    The flag indicating whether this is the default VLAN for the switch (deprecated, use connectedVe instead).
  - Changed property deviceStatus (object)
    The operational status of the device associated with this VE interface.
  - Changed property dhcpRelayAgent (object)
    The IP address of the DHCP relay agent for forwarding DHCP requests across subnets.
  - Changed property egressAclName (object)
    The name of the Access Control List applied to egress (outgoing) traffic on this VE interface.
  - Changed property id (object)
    The identifier
  - Changed property ingressAclName (object)
    The name of the Access Control List applied to ingress (incoming) traffic on this VE interface.
  - Changed property ipAddress (object)
    The IPv4 address assigned to this virtual ethernet interface.
  - Changed property ipAddressType (object)
    The IP address assignment method for this VE interface: static or dynamic.
  - Changed property ipSubnetMask (object)
    The subnet mask for the IP address of this virtual ethernet interface.
  - Changed property name (object)
    The descriptive name assigned to the virtual ethernet interface.
  - Changed property ospfArea (object)
    The OSPF area identifier for routing protocol configuration on this VE interface.
  - Changed property portType (object)
    The type of port associated with this VE interface.
  - Changed property stack (object)
    The flag indicating whether the switch is configured in a stack.
  - Changed property switchId (object)
    The identifier of the switch where this VE interface is configured.
  - Changed property switchName (object)
    The name of the switch where this VE interface is configured.
  - Changed property syncedSwitchConfig (object)
    The flag indicating whether the VE interface configuration has been synchronized with the switch.
  - Changed property tenantId (object)
    The unique identifier of the tenant.
  - Changed property veId (object)
    The virtual ethernet interface identifier, used as the VE interface number.
  - Changed property vePortViewList (object)
    The list of VE port configurations for batch operations or nested VE management.
  - Changed property vlanId (object)
    The VLAN ID associated with this virtual ethernet interface for layer 3 routing.
  - Changed property vsixEgressAclName (object)
    The name of the VSIX ACL applied to egress traffic for virtual switch integration.
  - Changed property vsixIngressAclName (object)
    The name of the VSIX ACL applied to ingress traffic for virtual switch integration.
Changed content type : application/vnd.ruckus.v1+json
- Changed property arpInspection (object)
  The flag indicating whether ARP inspection is enabled for this VLAN to prevent ARP spoofing attacks.
- Changed property enableAsDefaultVlan (object)
  The flag indicating whether this VLAN is configured as the default VLAN for the switch.
- Changed property id (object)
  The identifier
- Changed property igmpSnooping (object)
  The IGMP snooping mode for this VLAN to optimize multicast traffic delivery.
- Changed property ipv4DhcpSnooping (object)
  The flag indicating whether IPv4 DHCP snooping is enabled for this VLAN to prevent rogue DHCP servers.
- Changed property multicastVersion (object)
  The IGMP version number used for multicast group management in this VLAN.
- Changed property spanningTreeProtocol (object)
  The STP (Spanning Tree Protocol) variant enabled for this VLAN.
- Changed property switchVlanPortModels (object)
  The set of port model configurations specific to this VLAN on different switch models in a stack.
- Changed property taggedPorts (object)
  The comma separated list of port identifiers configured as tagged (trunk) ports for this VLAN.
- Changed property untaggedPorts (object)
  The comma separated list of port identifiers configured as untagged (access) ports for this VLAN.
- Changed property vlanId (object)
  The VLAN identifier, ranging from 1 to 4095, uniquely identifying this VLAN on the switch.
- Changed property vlanName (object)
  The descriptive name assigned to this VLAN for identification purposes.
- Changed property vePort (object)
  The virtual ethernet port view, representing a layer 3 virtual interface configuration with IP addressing, routing capabilities, and ACL assignments.
  - Changed property connectedVe (object)
    The flag indicating whether this VE interface is connected and operational.
  - Changed property defaultVlan (object)
    The flag indicating whether this is the default VLAN for the switch (deprecated, use connectedVe instead).
  - Changed property deviceStatus (object)
    The operational status of the device associated with this VE interface.
  - Changed property dhcpRelayAgent (object)
    The IP address of the DHCP relay agent for forwarding DHCP requests across subnets.
  - Changed property egressAclName (object)
    The name of the Access Control List applied to egress (outgoing) traffic on this VE interface.
  - Changed property id (object)
    The identifier
  - Changed property ingressAclName (object)
    The name of the Access Control List applied to ingress (incoming) traffic on this VE interface.
  - Changed property ipAddress (object)
    The IPv4 address assigned to this virtual ethernet interface.
  - Changed property ipAddressType (object)
    The IP address assignment method for this VE interface: static or dynamic.
  - Changed property ipSubnetMask (object)
    The subnet mask for the IP address of this virtual ethernet interface.
  - Changed property name (object)
    The descriptive name assigned to the virtual ethernet interface.
  - Changed property ospfArea (object)
    The OSPF area identifier for routing protocol configuration on this VE interface.
  - Changed property portType (object)
    The type of port associated with this VE interface.
  - Changed property stack (object)
    The flag indicating whether the switch is configured in a stack.
  - Changed property switchId (object)
    The identifier of the switch where this VE interface is configured.
  - Changed property switchName (object)
    The name of the switch where this VE interface is configured.
  - Changed property syncedSwitchConfig (object)
    The flag indicating whether the VE interface configuration has been synchronized with the switch.
  - Changed property tenantId (object)
    The unique identifier of the tenant.
  - Changed property veId (object)
    The virtual ethernet interface identifier, used as the VE interface number.
  - Changed property vePortViewList (object)
    The list of VE port configurations for batch operations or nested VE management.
  - Changed property vlanId (object)
    The VLAN ID associated with this virtual ethernet interface for layer 3 routing.
  - Changed property vsixEgressAclName (object)
    The name of the VSIX ACL applied to egress traffic for virtual switch integration.
  - Changed property vsixIngressAclName (object)
    The name of the VSIX ACL applied to ingress traffic for virtual switch integration.

GET /templates/switchProfiles

Return Type:

Changed response : 400 Bad Request

Bad/malformed request

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 401 Unauthorized

Unauthorized

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 403 Forbidden

Forbidden

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 404 Not Found

Requested resource or related entity not found

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 422 Unprocessable Entity

Validation error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 500 Internal Server Error

Internal Server Error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 200 OK

OK

Changed content type : application/json
- Changed property acls (object)
  The set of Access Control List configurations included in this profile for traffic filtering.
- Changed property applyOnboardOnly (object)
  The flag indicating whether this profile should only be applied during switch onboarding.
- Changed property description (object)
  The detailed description explaining the purpose and contents of this configuration profile.
- Changed property id (object)
  The identifier
- Changed property name (object)
  The name of the configuration profile for identification and reference.
- Changed property profileType (object)
  The type of profile indicating its scope: global, venue specific, or template based.
- Changed property templateId (object)
  The identifier of the profile template used as the basis for this profile configuration.
- Changed property templateVersion (object)
  The version number of the profile template.
- Changed property trustedPorts (object)
  The set of trusted port configurations for DHCP snooping and ARP inspection security features.
- Changed property venueCount (object)
  The total number of venues where this profile is currently deployed.
- Changed property venues (object)
  The set of venue identifiers where this profile is deployed or available for use.
- Changed property vlans (object)
  The ordered set of VLAN configurations included in this profile with layer 2 security features.
- Changed property voiceVlanConfigs (object)
  The set of voice VLAN configurations for VoIP traffic prioritization across different switch models.
- Changed property venueCliTemplate (object)
  The venue CLI template view, representing CLI templates configured at the venue level for managing switch configurations across multiple devices.
  - Changed property cli (object)
    The CLI command template content containing switch configuration commands and variable placeholders.
  - Changed property id (object)
    The identifier
  - Changed property name (object)
    The unique name identifier for this venue CLI template.
  - Changed property overwrite (object)
    Indicates whether this venue CLI template should overwrite existing configurations when applied to switches.
  - Changed property switchModels (object)
    The switch model identifiers that this venue CLI template supports, defining which hardware models are compatible.
  - Changed property variables (object)
    The set of variables defined in this venue CLI template for dynamic configuration value substitution.
Changed content type : application/vnd.ruckus.v1+json
- Changed property acls (object)
  The set of Access Control List configurations included in this profile for traffic filtering.
- Changed property applyOnboardOnly (object)
  The flag indicating whether this profile should only be applied during switch onboarding.
- Changed property description (object)
  The detailed description explaining the purpose and contents of this configuration profile.
- Changed property id (object)
  The identifier
- Changed property name (object)
  The name of the configuration profile for identification and reference.
- Changed property profileType (object)
  The type of profile indicating its scope: global, venue specific, or template based.
- Changed property templateId (object)
  The identifier of the profile template used as the basis for this profile configuration.
- Changed property templateVersion (object)
  The version number of the profile template.
- Changed property trustedPorts (object)
  The set of trusted port configurations for DHCP snooping and ARP inspection security features.
- Changed property venueCount (object)
  The total number of venues where this profile is currently deployed.
- Changed property venues (object)
  The set of venue identifiers where this profile is deployed or available for use.
- Changed property vlans (object)
  The ordered set of VLAN configurations included in this profile with layer 2 security features.
- Changed property voiceVlanConfigs (object)
  The set of voice VLAN configurations for VoIP traffic prioritization across different switch models.
- Changed property venueCliTemplate (object)
  The venue CLI template view, representing CLI templates configured at the venue level for managing switch configurations across multiple devices.
  - Changed property cli (object)
    The CLI command template content containing switch configuration commands and variable placeholders.
  - Changed property id (object)
    The identifier
  - Changed property name (object)
    The unique name identifier for this venue CLI template.
  - Changed property overwrite (object)
    Indicates whether this venue CLI template should overwrite existing configurations when applied to switches.
  - Changed property switchModels (object)
    The switch model identifiers that this venue CLI template supports, defining which hardware models are compatible.
  - Changed property variables (object)
    The set of variables defined in this venue CLI template for dynamic configuration value substitution.

POST /templates/switchProfiles

Request:

Changed content type : application/json

Changed property acls (object)
The set of Access Control List configurations to be applied as part of this profile.
Changed property applyOnboardOnly (object)
The flag indicating whether this profile should only be applied during the initial switch onboarding process.
Changed property description (object)
The descriptive text providing details about the purpose and usage of this profile.
Changed property name (object)
The unique name identifier for this switch configuration profile.
Changed property profileType (object)
The profile type indicating whether this is a port profile, switch profile, or other profile type.
Changed property trustedPorts (object)
The set of trusted port configurations for DHCP snooping and ARP inspection security features.
Changed property vlans (object)
The set of VLAN configurations defining VLANs to be created or managed by this profile.
Changed property voiceVlanConfigs (object)
The set of voice VLAN configurations for VoIP traffic prioritization on switches using this profile.
Changed property venueCliTemplate (object)
The venue CLI template view, representing CLI templates configured at the venue level for deployment across multiple switches.
- Changed property cli (object)
  The CLI command template content to be deployed to switches within the venue.
- Changed property name (object)
  The unique name identifier for this venue CLI template, with a length between 1 and 64 characters.
- Changed property overwrite (object)
  Indicates whether this venue CLI template should overwrite existing configurations on the target switches.
- Changed property switchModels (object)
  The switch model identifiers that this venue CLI template is compatible with, specifying which hardware models can use this template.
- Changed property variables (object)
  The set of variables used in this venue CLI template for dynamic value substitution across multiple switches.

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

Changed property acls (object)
The set of Access Control List configurations to be applied as part of this profile.
Changed property applyOnboardOnly (object)
The flag indicating whether this profile should only be applied during the initial switch onboarding process.
Changed property description (object)
The descriptive text providing details about the purpose and usage of this profile.
Changed property name (object)
The unique name identifier for this switch configuration profile.
Changed property profileType (object)
The profile type indicating whether this is a port profile, switch profile, or other profile type.
Changed property trustedPorts (object)
The set of trusted port configurations for DHCP snooping and ARP inspection security features.
Changed property vlans (object)
The set of VLAN configurations defining VLANs to be created or managed by this profile.
Changed property voiceVlanConfigs (object)
The set of voice VLAN configurations for VoIP traffic prioritization on switches using this profile.
Changed property venueCliTemplate (object)
The venue CLI template view, representing CLI templates configured at the venue level for deployment across multiple switches.
- Changed property cli (object)
  The CLI command template content to be deployed to switches within the venue.
- Changed property name (object)
  The unique name identifier for this venue CLI template, with a length between 1 and 64 characters.
- Changed property overwrite (object)
  Indicates whether this venue CLI template should overwrite existing configurations on the target switches.
- Changed property switchModels (object)
  The switch model identifiers that this venue CLI template is compatible with, specifying which hardware models can use this template.
- Changed property variables (object)
  The set of variables used in this venue CLI template for dynamic value substitution across multiple switches.

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

Changed property acls (object)
Set of ACL (Access Control List) configurations included in this profile.
Changed property applyOnboardOnly (object)
Flag indicating whether this profile should only be applied during switch onboarding.
Changed property description (object)
Profile description providing additional details about the configuration purpose.
Changed property id (object)
Unique identifier for the profile.
Changed property isTemplate (object)
Flag indicating whether this profile is a template that can be used to create other profiles (default: false).
Changed property name (object)
Profile name (1-64 characters).
Changed property portProfileMappings (object)
Set of mappings between port profiles and this configuration profile.
Changed property profileType (object)
Profile type (Regular, CLI).
Changed property templateId (object)
Identifier of the template that this profile was created from (if applicable).
Changed property templateVersion (object)
Version number of the template being used.
Changed property trustedPorts (object)
Set of trusted port configurations for QoS and security settings.
Changed property venues (object)
List of venue identifiers where this profile is applied.
Changed property vlans (object)
Set of VLAN configurations included in this profile.
Changed property voiceVlanConfigs (object)
Set of voice VLAN configurations for IP phones and voice devices.
Changed property venueCliTemplate (object)
Venue level CLI template configuration for applying custom CLI commands across multiple switches in a venue. Deprecated, this version, application/vnd.ruckus.v1+json will be removed no sooner than 06/30/2026.
- Deleted property customizedSerialSet (object)
- Changed property cli (object)
  The CLI command template content with variable placeholders for venue wide configuration.
- Changed property id (object)
  Unique identifier for the venue CLI template.
- Changed property name (object)
  Name of the venue CLI template (1-64 characters).
- Changed property overwrite (object)
  Flag indicating whether to overwrite existing configuration when applying this template (default: false).
- Changed property switchModels (object)
  Comma separated list of switch models that this template is compatible with (e.g., ICX7150, ICX7250).
- Changed property variables (object)
  Set of template variables that can be customized for each switch when applying the CLI template.

Return Type:

Changed response : 400 Bad Request

Bad/malformed request

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 401 Unauthorized

Unauthorized

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 403 Forbidden

Forbidden

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 404 Not Found

Requested resource or related entity not found

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 422 Unprocessable Entity

Validation error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 500 Internal Server Error

Internal Server Error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 200 OK

OK

Changed content type : application/vnd.ruckus.v1+json
- Changed property requestId (object)
  The unique identifier for tracking this API operation request.
- Changed property response (object)
  The empty view representing an API response with no data content, used for operations that return success status without additional information.

Changed response : 202 Accepted

Accepted

Changed content type : application/json
- Changed property requestId (object)
  The unique identifier for tracking this API operation request.
- Changed property response (object)
  The empty view representing an API response with no data content, used for operations that return success status without additional information.
Changed content type : application/vnd.ruckus.v1.1+json
- Changed property requestId (object)
  The unique identifier for tracking this API operation request.
- Changed property response (object)
  The empty view representing an API response with no data content, used for operations that return success status without additional information.

DELETE /templates/switchProfiles

Return Type:

Changed response : 400 Bad Request

Bad/malformed request

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 401 Unauthorized

Unauthorized

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 403 Forbidden

Forbidden

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 404 Not Found

Requested resource or related entity not found

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 422 Unprocessable Entity

Validation error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 500 Internal Server Error

Internal Server Error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 200 OK

OK

Changed content type : application/json
- Changed property requestId (object)
  The unique identifier for tracking this API operation request.
- Changed property response (object)
  The empty view representing an API response with no data content, used for operations that return success status without additional information.
Changed content type : application/vnd.ruckus.v1+json
- Changed property requestId (object)
  The unique identifier for tracking this API operation request.
- Changed property response (object)
  The empty view representing an API response with no data content, used for operations that return success status without additional information.

GET /templates/switchProfiles/{switchProfileId}

Return Type:

Changed response : 400 Bad Request

Bad/malformed request

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 401 Unauthorized

Unauthorized

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 403 Forbidden

Forbidden

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 404 Not Found

Requested resource or related entity not found

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 422 Unprocessable Entity

Validation error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 500 Internal Server Error

Internal Server Error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 200 OK

OK

Changed content type : application/json
- Deleted property applyOnboardOnly (object)
- Deleted property templateVersion (object)
- Changed property acls (object)
  The set of Access Control List configurations included in this profile for traffic filtering.
- Changed property description (object)
  The detailed description explaining the purpose and contents of this configuration profile.
- Changed property name (object)
  The name of the configuration profile for identification and reference.
- Changed property profileType (object)
  The type of profile indicating its scope: global, venue specific, or template based.
- Changed property templateId (object)
  The identifier of the profile template used as the basis for this profile configuration.
- Changed property trustedPorts (object)
  The set of trusted port configurations for DHCP snooping and ARP inspection security features.
- Changed property venueCount (object)
  The total number of venues where this profile is currently deployed.
- Changed property venues (object)
  The set of venue identifiers where this profile is deployed or available for use.
- Changed property vlans (object)
  The ordered set of VLAN configurations included in this profile with layer 2 security features.
- Changed property voiceVlanConfigs (object)
  The set of voice VLAN configurations for VoIP traffic prioritization across different switch models.
- Changed property venueCliTemplate (object)
  The venue CLI template view, representing CLI templates configured at the venue level for deployment across multiple switches.
  - Changed property cli (object)
    The CLI command template content to be deployed to switches within the venue.
  - Changed property name (object)
    The unique name identifier for this venue CLI template, with a length between 1 and 64 characters.
  - Changed property overwrite (object)
    Indicates whether this venue CLI template should overwrite existing configurations on the target switches.
  - Changed property switchModels (object)
    The switch model identifiers that this venue CLI template is compatible with, specifying which hardware models can use this template.
  - Changed property variables (object)
    The set of variables used in this venue CLI template for dynamic value substitution across multiple switches.
Changed content type : application/vnd.ruckus.v1.1+json
- Deleted property applyOnboardOnly (object)
- Deleted property templateVersion (object)
- Changed property acls (object)
  The set of Access Control List configurations included in this profile for traffic filtering.
- Changed property description (object)
  The detailed description explaining the purpose and contents of this configuration profile.
- Changed property name (object)
  The name of the configuration profile for identification and reference.
- Changed property profileType (object)
  The type of profile indicating its scope: global, venue specific, or template based.
- Changed property templateId (object)
  The identifier of the profile template used as the basis for this profile configuration.
- Changed property trustedPorts (object)
  The set of trusted port configurations for DHCP snooping and ARP inspection security features.
- Changed property venueCount (object)
  The total number of venues where this profile is currently deployed.
- Changed property venues (object)
  The set of venue identifiers where this profile is deployed or available for use.
- Changed property vlans (object)
  The ordered set of VLAN configurations included in this profile with layer 2 security features.
- Changed property voiceVlanConfigs (object)
  The set of voice VLAN configurations for VoIP traffic prioritization across different switch models.
- Changed property venueCliTemplate (object)
  The venue CLI template view, representing CLI templates configured at the venue level for deployment across multiple switches.
  - Changed property cli (object)
    The CLI command template content to be deployed to switches within the venue.
  - Changed property name (object)
    The unique name identifier for this venue CLI template, with a length between 1 and 64 characters.
  - Changed property overwrite (object)
    Indicates whether this venue CLI template should overwrite existing configurations on the target switches.
  - Changed property switchModels (object)
    The switch model identifiers that this venue CLI template is compatible with, specifying which hardware models can use this template.
  - Changed property variables (object)
    The set of variables used in this venue CLI template for dynamic value substitution across multiple switches.
Changed content type : application/vnd.ruckus.v1+json
- Changed property acls (object)
  The set of Access Control List configurations included in this profile for traffic filtering.
- Changed property applyOnboardOnly (object)
  The flag indicating whether this profile should only be applied during switch onboarding.
- Changed property description (object)
  The detailed description explaining the purpose and contents of this configuration profile.
- Changed property id (object)
  The identifier
- Changed property name (object)
  The name of the configuration profile for identification and reference.
- Changed property profileType (object)
  The type of profile indicating its scope: global, venue specific, or template based.
- Changed property templateId (object)
  The identifier of the profile template used as the basis for this profile configuration.
- Changed property templateVersion (object)
  The version number of the profile template.
- Changed property trustedPorts (object)
  The set of trusted port configurations for DHCP snooping and ARP inspection security features.
- Changed property venueCount (object)
  The total number of venues where this profile is currently deployed.
- Changed property venues (object)
  The set of venue identifiers where this profile is deployed or available for use.
- Changed property vlans (object)
  The ordered set of VLAN configurations included in this profile with layer 2 security features.
- Changed property voiceVlanConfigs (object)
  The set of voice VLAN configurations for VoIP traffic prioritization across different switch models.
- Changed property venueCliTemplate (object)
  The venue CLI template view, representing CLI templates configured at the venue level for managing switch configurations across multiple devices.
  - Changed property cli (object)
    The CLI command template content containing switch configuration commands and variable placeholders.
  - Changed property id (object)
    The identifier
  - Changed property name (object)
    The unique name identifier for this venue CLI template.
  - Changed property overwrite (object)
    Indicates whether this venue CLI template should overwrite existing configurations when applied to switches.
  - Changed property switchModels (object)
    The switch model identifiers that this venue CLI template supports, defining which hardware models are compatible.
  - Changed property variables (object)
    The set of variables defined in this venue CLI template for dynamic configuration value substitution.

PUT /templates/switchProfiles/{switchProfileId}

Request:

Changed content type : application/json

Changed property acls (object)
The set of Access Control List configurations to be applied as part of this profile.
Changed property applyOnboardOnly (object)
The flag indicating whether this profile should only be applied during the initial switch onboarding process.
Changed property description (object)
The descriptive text providing details about the purpose and usage of this profile.
Changed property name (object)
The unique name identifier for this switch configuration profile.
Changed property profileType (object)
The profile type indicating whether this is a port profile, switch profile, or other profile type.
Changed property trustedPorts (object)
The set of trusted port configurations for DHCP snooping and ARP inspection security features.
Changed property vlans (object)
The set of VLAN configurations defining VLANs to be created or managed by this profile.
Changed property voiceVlanConfigs (object)
The set of voice VLAN configurations for VoIP traffic prioritization on switches using this profile.
Changed property venueCliTemplate (object)
The venue CLI template view, representing CLI templates configured at the venue level for deployment across multiple switches.
- Changed property cli (object)
  The CLI command template content to be deployed to switches within the venue.
- Changed property name (object)
  The unique name identifier for this venue CLI template, with a length between 1 and 64 characters.
- Changed property overwrite (object)
  Indicates whether this venue CLI template should overwrite existing configurations on the target switches.
- Changed property switchModels (object)
  The switch model identifiers that this venue CLI template is compatible with, specifying which hardware models can use this template.
- Changed property variables (object)
  The set of variables used in this venue CLI template for dynamic value substitution across multiple switches.

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

Changed property acls (object)
The set of Access Control List configurations to be applied as part of this profile.
Changed property applyOnboardOnly (object)
The flag indicating whether this profile should only be applied during the initial switch onboarding process.
Changed property description (object)
The descriptive text providing details about the purpose and usage of this profile.
Changed property name (object)
The unique name identifier for this switch configuration profile.
Changed property profileType (object)
The profile type indicating whether this is a port profile, switch profile, or other profile type.
Changed property trustedPorts (object)
The set of trusted port configurations for DHCP snooping and ARP inspection security features.
Changed property vlans (object)
The set of VLAN configurations defining VLANs to be created or managed by this profile.
Changed property voiceVlanConfigs (object)
The set of voice VLAN configurations for VoIP traffic prioritization on switches using this profile.
Changed property venueCliTemplate (object)
The venue CLI template view, representing CLI templates configured at the venue level for deployment across multiple switches.
- Changed property cli (object)
  The CLI command template content to be deployed to switches within the venue.
- Changed property name (object)
  The unique name identifier for this venue CLI template, with a length between 1 and 64 characters.
- Changed property overwrite (object)
  Indicates whether this venue CLI template should overwrite existing configurations on the target switches.
- Changed property switchModels (object)
  The switch model identifiers that this venue CLI template is compatible with, specifying which hardware models can use this template.
- Changed property variables (object)
  The set of variables used in this venue CLI template for dynamic value substitution across multiple switches.

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

Changed property acls (object)
Set of ACL (Access Control List) configurations included in this profile.
Changed property applyOnboardOnly (object)
Flag indicating whether this profile should only be applied during switch onboarding.
Changed property description (object)
Profile description providing additional details about the configuration purpose.
Changed property id (object)
Unique identifier for the profile.
Changed property isTemplate (object)
Flag indicating whether this profile is a template that can be used to create other profiles (default: false).
Changed property name (object)
Profile name (1-64 characters).
Changed property portProfileMappings (object)
Set of mappings between port profiles and this configuration profile.
Changed property profileType (object)
Profile type (Regular, CLI).
Changed property templateId (object)
Identifier of the template that this profile was created from (if applicable).
Changed property templateVersion (object)
Version number of the template being used.
Changed property trustedPorts (object)
Set of trusted port configurations for QoS and security settings.
Changed property venues (object)
List of venue identifiers where this profile is applied.
Changed property vlans (object)
Set of VLAN configurations included in this profile.
Changed property voiceVlanConfigs (object)
Set of voice VLAN configurations for IP phones and voice devices.
Changed property venueCliTemplate (object)
Venue level CLI template configuration for applying custom CLI commands across multiple switches in a venue. Deprecated, this version, application/vnd.ruckus.v1+json will be removed no sooner than 06/30/2026.
- Deleted property customizedSerialSet (object)
- Changed property cli (object)
  The CLI command template content with variable placeholders for venue wide configuration.
- Changed property id (object)
  Unique identifier for the venue CLI template.
- Changed property name (object)
  Name of the venue CLI template (1-64 characters).
- Changed property overwrite (object)
  Flag indicating whether to overwrite existing configuration when applying this template (default: false).
- Changed property switchModels (object)
  Comma separated list of switch models that this template is compatible with (e.g., ICX7150, ICX7250).
- Changed property variables (object)
  Set of template variables that can be customized for each switch when applying the CLI template.

Return Type:

Changed response : 400 Bad Request

Bad/malformed request

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 401 Unauthorized

Unauthorized

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 403 Forbidden

Forbidden

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 404 Not Found

Requested resource or related entity not found

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 422 Unprocessable Entity

Validation error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 500 Internal Server Error

Internal Server Error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 200 OK

OK

Changed content type : application/vnd.ruckus.v1+json
- Changed property requestId (object)
  The unique identifier for tracking this API operation request.
- Changed property response (object)
  The empty view representing an API response with no data content, used for operations that return success status without additional information.

Changed response : 202 Accepted

Accepted

Changed content type : application/json
- Changed property requestId (object)
  The unique identifier for tracking this API operation request.
- Changed property response (object)
  The empty view representing an API response with no data content, used for operations that return success status without additional information.
Changed content type : application/vnd.ruckus.v1.1+json
- Changed property requestId (object)
  The unique identifier for tracking this API operation request.
- Changed property response (object)
  The empty view representing an API response with no data content, used for operations that return success status without additional information.

DELETE /templates/switchProfiles/{switchProfileId}

Return Type:

Changed response : 400 Bad Request

Bad/malformed request

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 401 Unauthorized

Unauthorized

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 403 Forbidden

Forbidden

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 404 Not Found

Requested resource or related entity not found

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 422 Unprocessable Entity

Validation error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 500 Internal Server Error

Internal Server Error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 200 OK

OK

Changed content type : application/vnd.ruckus.v1+json
- Changed property requestId (object)
  The unique identifier for tracking this API operation request.
- Changed property response (object)
  The empty view representing an API response with no data content, used for operations that return success status without additional information.

Changed response : 202 Accepted

Accepted

Changed content type : application/json
- Changed property requestId (object)
  The unique identifier for tracking this API operation request.
- Changed property response (object)
  The empty view representing an API response with no data content, used for operations that return success status without additional information.
Changed content type : application/vnd.ruckus.v1.1+json
- Changed property requestId (object)
  The unique identifier for tracking this API operation request.
- Changed property response (object)
  The empty view representing an API response with no data content, used for operations that return success status without additional information.

DELETE /templates/venues/aaaServers

Return Type:

Changed response : 400 Bad Request

Bad/malformed request

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 401 Unauthorized

Unauthorized

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 403 Forbidden

Forbidden

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 404 Not Found

Requested resource or related entity not found

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 422 Unprocessable Entity

Validation error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 500 Internal Server Error

Internal Server Error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 200 OK

OK

Changed content type : application/json
- Changed property requestId (object)
  The unique identifier for tracking this API operation request.
- Changed property response (object)
  The empty view representing an API response with no data content, used for operations that return success status without additional information.
Changed content type : application/vnd.ruckus.v1+json
- Changed property requestId (object)
  The unique identifier for tracking this API operation request.
- Changed property response (object)
  The empty view representing an API response with no data content, used for operations that return success status without additional information.

GET /templates/venues/aaaServers/{aaaServerId}

Return Type:

Changed response : 200 OK

OK

Changed content type : application/json
- Changed property aaaServerViewList (object)
  The list of AAA server configurations for batch operations or nested server management.
- Changed property acctPort (object)
  The UDP port number for RADIUS accounting packets, typically 1813.
- Changed property authPort (object)
  The UDP port number for RADIUS authentication packets, typically 1812.
- Changed property id (object)
  The unique identifier of the AAA server configuration.
- Changed property ip (object)
  The IP address of the AAA server.
- Changed property level (object)
  The access level or privilege level associated with this AAA server configuration.
- Changed property name (object)
  The name of the AAA server configuration for identification.
- Changed property password (object)
  The password credential for authenticating to the AAA server.
- Changed property purpose (object)
  The purpose of the AAA server: authentication, authorization, or accounting.
- Changed property secret (object)
  The shared secret key used for secure communication with the RADIUS or TACACS+ server.
- Changed property serverType (object)
  The type of AAA server protocol: RADIUS or TACACS+.
- Changed property switchCountInVenue (object)
  The total number of switches in the venue that can use this AAA server.
- Changed property syncedPasswordSwitchCount (object)
  The number of switches that have successfully synchronized the AAA server password.
- Changed property username (object)
  The username credential for authenticating to the AAA server, used for management access.
Changed content type : application/vnd.ruckus.v1+json
- Changed property aaaServerViewList (object)
  The list of AAA server configurations for batch operations or nested server management.
- Changed property acctPort (object)
  The UDP port number for RADIUS accounting packets, typically 1813.
- Changed property authPort (object)
  The UDP port number for RADIUS authentication packets, typically 1812.
- Changed property id (object)
  The unique identifier of the AAA server configuration.
- Changed property ip (object)
  The IP address of the AAA server.
- Changed property level (object)
  The access level or privilege level associated with this AAA server configuration.
- Changed property name (object)
  The name of the AAA server configuration for identification.
- Changed property password (object)
  The password credential for authenticating to the AAA server.
- Changed property purpose (object)
  The purpose of the AAA server: authentication, authorization, or accounting.
- Changed property secret (object)
  The shared secret key used for secure communication with the RADIUS or TACACS+ server.
- Changed property serverType (object)
  The type of AAA server protocol: RADIUS or TACACS+.
- Changed property switchCountInVenue (object)
  The total number of switches in the venue that can use this AAA server.
- Changed property syncedPasswordSwitchCount (object)
  The number of switches that have successfully synchronized the AAA server password.
- Changed property username (object)
  The username credential for authenticating to the AAA server, used for management access.

Changed response : 400 Bad Request

Bad/malformed request

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 401 Unauthorized

Unauthorized

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 403 Forbidden

Forbidden

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 404 Not Found

Requested resource or related entity not found

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 422 Unprocessable Entity

Validation error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 500 Internal Server Error

Internal Server Error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

DELETE /templates/venues/aaaServers/{aaaServerId}

Return Type:

Changed response : 400 Bad Request

Bad/malformed request

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 401 Unauthorized

Unauthorized

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 403 Forbidden

Forbidden

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 404 Not Found

Requested resource or related entity not found

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 422 Unprocessable Entity

Validation error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 500 Internal Server Error

Internal Server Error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 200 OK

OK

Changed content type : application/json
- Changed property requestId (object)
  The unique identifier for tracking this API operation request.
- Changed property response (object)
  The empty view representing an API response with no data content, used for operations that return success status without additional information.
Changed content type : application/vnd.ruckus.v1+json
- Changed property requestId (object)
  The unique identifier for tracking this API operation request.
- Changed property response (object)
  The empty view representing an API response with no data content, used for operations that return success status without additional information.

POST /templates/venues/{venueId}/aaaServers

Request:

Changed content type : application/json

Changed property acctPort (object)
The port number for accounting services, ranging from 0 to 65535.
Changed property authPort (object)
The port number for authentication services, ranging from 0 to 65535.
Changed property ip (object)
The IP address of the AAA server, supporting both IPv4 and IPv6 formats.
Changed property level (object)
The authorization level to be assigned to users authenticated through this server.
Changed property name (object)
The unique name identifier for this AAA server, with a length between 2 and 64 characters.
Changed property password (object)
The password credential for server authentication, with a length between 8 and 64 characters.
Changed property purpose (object)
The purpose of this AAA server, specifying whether it handles authentication, authorization, or accounting.
Changed property secret (object)
The shared secret key for secure communication with the AAA server, with a length between 1 and 64 characters.
Changed property serverType (object)
The AAA server protocol type, such as RADIUS or TACACS+.
Changed property username (object)
The username credential for server authentication, with a length between 2 and 48 characters.

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

Changed property acctPort (object)
The port number for accounting services, ranging from 0 to 65535.
Changed property authPort (object)
The port number for authentication services, ranging from 0 to 65535.
Changed property ip (object)
The IP address of the AAA server, supporting both IPv4 and IPv6 formats.
Changed property level (object)
The authorization level to be assigned to users authenticated through this server.
Changed property name (object)
The unique name identifier for this AAA server, with a length between 2 and 64 characters.
Changed property password (object)
The password credential for server authentication, with a length between 8 and 64 characters.
Changed property purpose (object)
The purpose of this AAA server, specifying whether it handles authentication, authorization, or accounting.
Changed property secret (object)
The shared secret key for secure communication with the AAA server, with a length between 1 and 64 characters.
Changed property serverType (object)
The AAA server protocol type, such as RADIUS or TACACS+.
Changed property username (object)
The username credential for server authentication, with a length between 2 and 48 characters.

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

Changed property acctPort (object)
Accounting port number for RADIUS server (0-65535).
Changed property authEnable (object)
Enable or disable authentication for RADIUS server.
Changed property authPort (object)
Authentication port number for RADIUS or TACACS+ server (0-65535).
Changed property encryptedPassword (object)
Encrypted password for local user authentication.
Changed property id (object)
Unique identifier for the AAA server
Changed property ip (object)
IP address of the AAA server (supports both IPv4 and IPv6 formats).
Changed property level (object)
Privilege level for local user.
Changed property name (object)
Name of the AAA server (2-64 characters)
Changed property password (object)
Password for local user authentication (8-64 characters, stored in plain text for internal use).
Changed property purpose (object)
Purpose of TACACS+ server (e.g., authentication, authorization, accounting).
Changed property secret (object)
Shared secret for RADIUS or TACACS+ server authentication (1-64 characters).
Changed property serverType (object)
Type of AAA server (RADIUS, TACACS_PLUS, or LOCAL).
Changed property username (object)
Username for local user authentication (2-48 characters).

Return Type:

Changed response : 200 OK

OK

Changed content type : application/vnd.ruckus.v1+json
- Changed property aaaServerViewList (object)
  The list of AAA server configurations for batch operations or nested server management.
- Changed property acctPort (object)
  The UDP port number for RADIUS accounting packets, typically 1813.
- Changed property authPort (object)
  The UDP port number for RADIUS authentication packets, typically 1812.
- Changed property id (object)
  The unique identifier of the AAA server configuration.
- Changed property ip (object)
  The IP address of the AAA server.
- Changed property level (object)
  The access level or privilege level associated with this AAA server configuration.
- Changed property name (object)
  The name of the AAA server configuration for identification.
- Changed property password (object)
  The password credential for authenticating to the AAA server.
- Changed property purpose (object)
  The purpose of the AAA server: authentication, authorization, or accounting.
- Changed property secret (object)
  The shared secret key used for secure communication with the RADIUS or TACACS+ server.
- Changed property serverType (object)
  The type of AAA server protocol: RADIUS or TACACS+.
- Changed property switchCountInVenue (object)
  The total number of switches in the venue that can use this AAA server.
- Changed property syncedPasswordSwitchCount (object)
  The number of switches that have successfully synchronized the AAA server password.
- Changed property username (object)
  The username credential for authenticating to the AAA server, used for management access.

Changed response : 400 Bad Request

Bad/malformed request

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 401 Unauthorized

Unauthorized

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 403 Forbidden

Forbidden

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 404 Not Found

Requested resource or related entity not found

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 422 Unprocessable Entity

Validation error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 500 Internal Server Error

Internal Server Error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 201 Created

Created

Changed content type : application/json
- Changed property requestId (object)
  The unique identifier for tracking this API operation request.
- Changed property response (object)
  The venue template AAA server view, representing an Authentication, Authorization, and Accounting server configuration in a venue template with RADIUS or TACACS+ settings.
  - Changed property acctPort (object)
    The UDP port number for RADIUS accounting traffic, typically 1813.
  - Changed property authPort (object)
    The UDP port number for RADIUS authentication traffic, typically 1812.
  - Changed property ip (object)
    The IP address or hostname of the AAA server.
  - Changed property level (object)
    The privilege level for commands and access control on the AAA server.
  - Changed property name (object)
    The unique name identifier for this AAA server configuration.
  - Changed property password (object)
    The password for authenticating to the AAA server for administrative access.
  - Changed property purpose (object)
    The purpose of this AAA server, such as authentication, authorization, or accounting.
  - Changed property secret (object)
    The shared secret key used for secure communication with the RADIUS server.
  - Changed property serverType (object)
    The type of AAA server protocol, such as RADIUS or TACACS+.
  - Changed property username (object)
    The username for authenticating to the AAA server for administrative access.
Changed content type : application/vnd.ruckus.v1.1+json
- Changed property requestId (object)
  The unique identifier for tracking this API operation request.
- Changed property response (object)
  The venue template AAA server view, representing an Authentication, Authorization, and Accounting server configuration in a venue template with RADIUS or TACACS+ settings.
  - Changed property acctPort (object)
    The UDP port number for RADIUS accounting traffic, typically 1813.
  - Changed property authPort (object)
    The UDP port number for RADIUS authentication traffic, typically 1812.
  - Changed property ip (object)
    The IP address or hostname of the AAA server.
  - Changed property level (object)
    The privilege level for commands and access control on the AAA server.
  - Changed property name (object)
    The unique name identifier for this AAA server configuration.
  - Changed property password (object)
    The password for authenticating to the AAA server for administrative access.
  - Changed property purpose (object)
    The purpose of this AAA server, such as authentication, authorization, or accounting.
  - Changed property secret (object)
    The shared secret key used for secure communication with the RADIUS server.
  - Changed property serverType (object)
    The type of AAA server protocol, such as RADIUS or TACACS+.
  - Changed property username (object)
    The username for authenticating to the AAA server for administrative access.

DELETE /templates/venues/{venueId}/aaaServers

Return Type:

Changed response : 400 Bad Request

Bad/malformed request

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 401 Unauthorized

Unauthorized

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 403 Forbidden

Forbidden

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 404 Not Found

Requested resource or related entity not found

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 422 Unprocessable Entity

Validation error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 500 Internal Server Error

Internal Server Error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 200 OK

OK

Changed content type : application/json
- Changed property requestId (object)
  The unique identifier for tracking this API operation request.
- Changed property response (object)
  The empty view representing an API response with no data content, used for operations that return success status without additional information.
Changed content type : application/vnd.ruckus.v1+json
- Changed property requestId (object)
  The unique identifier for tracking this API operation request.
- Changed property response (object)
  The empty view representing an API response with no data content, used for operations that return success status without additional information.

GET /templates/venues/{venueId}/aaaServers/{aaaServerId}

Return Type:

Changed response : 200 OK

OK

Changed content type : application/json
- Changed property acctPort (object)
  The UDP port number for RADIUS accounting traffic, typically 1813.
- Changed property authPort (object)
  The UDP port number for RADIUS authentication traffic, typically 1812.
- Changed property ip (object)
  The IP address or hostname of the AAA server.
- Changed property level (object)
  The privilege level for commands and access control on the AAA server.
- Changed property name (object)
  The unique name identifier for this AAA server configuration.
- Changed property password (object)
  The password for authenticating to the AAA server for administrative access.
- Changed property purpose (object)
  The purpose of this AAA server, such as authentication, authorization, or accounting.
- Changed property secret (object)
  The shared secret key used for secure communication with the RADIUS server.
- Changed property serverType (object)
  The type of AAA server protocol, such as RADIUS or TACACS+.
- Changed property username (object)
  The username for authenticating to the AAA server for administrative access.
Changed content type : application/vnd.ruckus.v1+json
- Changed property acctPort (object)
  The UDP port number for RADIUS accounting traffic, typically 1813.
- Changed property authPort (object)
  The UDP port number for RADIUS authentication traffic, typically 1812.
- Changed property ip (object)
  The IP address or hostname of the AAA server.
- Changed property level (object)
  The privilege level for commands and access control on the AAA server.
- Changed property name (object)
  The unique name identifier for this AAA server configuration.
- Changed property password (object)
  The password for authenticating to the AAA server for administrative access.
- Changed property purpose (object)
  The purpose of this AAA server, such as authentication, authorization, or accounting.
- Changed property secret (object)
  The shared secret key used for secure communication with the RADIUS server.
- Changed property serverType (object)
  The type of AAA server protocol, such as RADIUS or TACACS+.
- Changed property username (object)
  The username for authenticating to the AAA server for administrative access.

Changed response : 400 Bad Request

Bad/malformed request

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 401 Unauthorized

Unauthorized

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 403 Forbidden

Forbidden

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 404 Not Found

Requested resource or related entity not found

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 422 Unprocessable Entity

Validation error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 500 Internal Server Error

Internal Server Error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

PUT /templates/venues/{venueId}/aaaServers/{aaaServerId}

Request:

Changed content type : application/json

Changed property acctPort (object)
The port number for accounting services, ranging from 0 to 65535.
Changed property authPort (object)
The port number for authentication services, ranging from 0 to 65535.
Changed property ip (object)
The IP address of the AAA server, supporting both IPv4 and IPv6 formats.
Changed property level (object)
The authorization level to be assigned to users authenticated through this server.
Changed property name (object)
The unique name identifier for this AAA server, with a length between 2 and 64 characters.
Changed property password (object)
The password credential for server authentication, with a length between 8 and 64 characters.
Changed property purpose (object)
The purpose of this AAA server, specifying whether it handles authentication, authorization, or accounting.
Changed property secret (object)
The shared secret key for secure communication with the AAA server, with a length between 1 and 64 characters.
Changed property serverType (object)
The AAA server protocol type, such as RADIUS or TACACS+.
Changed property username (object)
The username credential for server authentication, with a length between 2 and 48 characters.

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

Changed property acctPort (object)
The port number for accounting services, ranging from 0 to 65535.
Changed property authPort (object)
The port number for authentication services, ranging from 0 to 65535.
Changed property ip (object)
The IP address of the AAA server, supporting both IPv4 and IPv6 formats.
Changed property level (object)
The authorization level to be assigned to users authenticated through this server.
Changed property name (object)
The unique name identifier for this AAA server, with a length between 2 and 64 characters.
Changed property password (object)
The password credential for server authentication, with a length between 8 and 64 characters.
Changed property purpose (object)
The purpose of this AAA server, specifying whether it handles authentication, authorization, or accounting.
Changed property secret (object)
The shared secret key for secure communication with the AAA server, with a length between 1 and 64 characters.
Changed property serverType (object)
The AAA server protocol type, such as RADIUS or TACACS+.
Changed property username (object)
The username credential for server authentication, with a length between 2 and 48 characters.

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

Changed property acctPort (object)
Accounting port number for RADIUS server (0-65535).
Changed property authEnable (object)
Enable or disable authentication for RADIUS server.
Changed property authPort (object)
Authentication port number for RADIUS or TACACS+ server (0-65535).
Changed property encryptedPassword (object)
Encrypted password for local user authentication.
Changed property id (object)
Unique identifier for the AAA server
Changed property ip (object)
IP address of the AAA server (supports both IPv4 and IPv6 formats).
Changed property level (object)
Privilege level for local user.
Changed property name (object)
Name of the AAA server (2-64 characters)
Changed property password (object)
Password for local user authentication (8-64 characters, stored in plain text for internal use).
Changed property purpose (object)
Purpose of TACACS+ server (e.g., authentication, authorization, accounting).
Changed property secret (object)
Shared secret for RADIUS or TACACS+ server authentication (1-64 characters).
Changed property serverType (object)
Type of AAA server (RADIUS, TACACS_PLUS, or LOCAL).
Changed property username (object)
Username for local user authentication (2-48 characters).

Return Type:

Changed response : 400 Bad Request

Bad/malformed request

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 401 Unauthorized

Unauthorized

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 403 Forbidden

Forbidden

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 404 Not Found

Requested resource or related entity not found

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 422 Unprocessable Entity

Validation error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 500 Internal Server Error

Internal Server Error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 200 OK

OK

Changed content type : application/vnd.ruckus.v1+json
- Changed property aaaServerViewList (object)
  The list of AAA server configurations for batch operations or nested server management.
- Changed property acctPort (object)
  The UDP port number for RADIUS accounting packets, typically 1813.
- Changed property authPort (object)
  The UDP port number for RADIUS authentication packets, typically 1812.
- Changed property id (object)
  The unique identifier of the AAA server configuration.
- Changed property ip (object)
  The IP address of the AAA server.
- Changed property level (object)
  The access level or privilege level associated with this AAA server configuration.
- Changed property name (object)
  The name of the AAA server configuration for identification.
- Changed property password (object)
  The password credential for authenticating to the AAA server.
- Changed property purpose (object)
  The purpose of the AAA server: authentication, authorization, or accounting.
- Changed property secret (object)
  The shared secret key used for secure communication with the RADIUS or TACACS+ server.
- Changed property serverType (object)
  The type of AAA server protocol: RADIUS or TACACS+.
- Changed property switchCountInVenue (object)
  The total number of switches in the venue that can use this AAA server.
- Changed property syncedPasswordSwitchCount (object)
  The number of switches that have successfully synchronized the AAA server password.
- Changed property username (object)
  The username credential for authenticating to the AAA server, used for management access.
Changed content type : application/json
- Changed property requestId (object)
  The unique identifier for tracking this API operation request.
- Changed property response (object)
  The venue template AAA server view, representing an Authentication, Authorization, and Accounting server configuration in a venue template with RADIUS or TACACS+ settings.
  - Changed property acctPort (object)
    The UDP port number for RADIUS accounting traffic, typically 1813.
  - Changed property authPort (object)
    The UDP port number for RADIUS authentication traffic, typically 1812.
  - Changed property ip (object)
    The IP address or hostname of the AAA server.
  - Changed property level (object)
    The privilege level for commands and access control on the AAA server.
  - Changed property name (object)
    The unique name identifier for this AAA server configuration.
  - Changed property password (object)
    The password for authenticating to the AAA server for administrative access.
  - Changed property purpose (object)
    The purpose of this AAA server, such as authentication, authorization, or accounting.
  - Changed property secret (object)
    The shared secret key used for secure communication with the RADIUS server.
  - Changed property serverType (object)
    The type of AAA server protocol, such as RADIUS or TACACS+.
  - Changed property username (object)
    The username for authenticating to the AAA server for administrative access.
Changed content type : application/vnd.ruckus.v1.1+json
- Changed property requestId (object)
  The unique identifier for tracking this API operation request.
- Changed property response (object)
  The venue template AAA server view, representing an Authentication, Authorization, and Accounting server configuration in a venue template with RADIUS or TACACS+ settings.
  - Changed property acctPort (object)
    The UDP port number for RADIUS accounting traffic, typically 1813.
  - Changed property authPort (object)
    The UDP port number for RADIUS authentication traffic, typically 1812.
  - Changed property ip (object)
    The IP address or hostname of the AAA server.
  - Changed property level (object)
    The privilege level for commands and access control on the AAA server.
  - Changed property name (object)
    The unique name identifier for this AAA server configuration.
  - Changed property password (object)
    The password for authenticating to the AAA server for administrative access.
  - Changed property purpose (object)
    The purpose of this AAA server, such as authentication, authorization, or accounting.
  - Changed property secret (object)
    The shared secret key used for secure communication with the RADIUS server.
  - Changed property serverType (object)
    The type of AAA server protocol, such as RADIUS or TACACS+.
  - Changed property username (object)
    The username for authenticating to the AAA server for administrative access.

DELETE /templates/venues/{venueId}/aaaServers/{aaaServerId}

Return Type:

Changed response : 400 Bad Request

Bad/malformed request

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 401 Unauthorized

Unauthorized

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 403 Forbidden

Forbidden

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 404 Not Found

Requested resource or related entity not found

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 422 Unprocessable Entity

Validation error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 500 Internal Server Error

Internal Server Error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 200 OK

OK

Changed content type : application/json
- Changed property requestId (object)
  The unique identifier for tracking this API operation request.
- Changed property response (object)
  The empty view representing an API response with no data content, used for operations that return success status without additional information.
Changed content type : application/vnd.ruckus.v1+json
- Changed property requestId (object)
  The unique identifier for tracking this API operation request.
- Changed property response (object)
  The empty view representing an API response with no data content, used for operations that return success status without additional information.

GET /templates/venues/{venueId}/aaaSettings

Return Type:

Changed response : 200 OK

OK

Changed content type : application/json
- Changed property acctCommonsFirstServer (object)
  The first server to receive accounting records for common commands.
- Changed property acctCommonsLevel (object)
  The accounting level for common commands, determining which commands are logged.
- Changed property acctCommonsSecondServer (object)
  The second server to receive accounting records for common commands if the first server is unavailable.
- Changed property acctCommonsThirdServer (object)
  The third server to receive accounting records for common commands if the first two servers are unavailable.
- Changed property acctEnabledCommand (object)
  Indicates whether accounting is enabled for command execution, tracking user commands for auditing purposes.
- Changed property acctEnabledExec (object)
  Indicates whether accounting is enabled for exec mode sessions, tracking user login sessions for auditing purposes.
- Changed property acctExecFirstServer (object)
  The first server to receive accounting records for exec mode sessions.
- Changed property acctExecSecondServer (object)
  The second server to receive accounting records for exec mode sessions if the first server is unavailable.
- Changed property acctExecThirdServer (object)
  The third server to receive accounting records for exec mode sessions if the first two servers are unavailable.
- Changed property authnEnabledSsh (object)
  Indicates whether AAA authentication is enabled for SSH access to the switch.
- Changed property authnFirstPref (object)
  The first preference method for authentication, specifying the primary authentication mechanism to be used.
- Changed property authnFourthPref (object)
  The fourth preference method for authentication, used as the final fallback option.
- Changed property authnSecondPref (object)
  The second preference method for authentication, used as a fallback if the first method fails.
- Changed property authnThirdPref (object)
  The third preference method for authentication, used as a fallback if the second method fails.
- Changed property authzCommonsFirstServer (object)
  The first server to be consulted for common command authorization.
- Changed property authzCommonsLevel (object)
  The authorization level for common commands, determining the privilege level required.
- Changed property authzCommonsSecondServer (object)
  The second server to be consulted for common command authorization if the first server is unavailable.
- Changed property authzCommonsThirdServer (object)
  The third server to be consulted for common command authorization if the first two servers are unavailable.
- Changed property authzEnabledCommand (object)
  Indicates whether authorization is enabled for command execution on the switch.
- Changed property authzEnabledExec (object)
  Indicates whether authorization is enabled for exec mode access on the switch.
- Changed property authzExecFirstServer (object)
  The first server to be consulted for exec mode authorization.
- Changed property authzExecSecondServer (object)
  The second server to be consulted for exec mode authorization if the first server is unavailable.
- Changed property authzExecThirdServer (object)
  The third server to be consulted for exec mode authorization if the first two servers are unavailable.
Changed content type : application/vnd.ruckus.v1.1+json
- Changed property acctCommonsFirstServer (object)
  The first server to receive accounting records for common commands.
- Changed property acctCommonsLevel (object)
  The accounting level for common commands, determining which commands are logged.
- Changed property acctCommonsSecondServer (object)
  The second server to receive accounting records for common commands if the first server is unavailable.
- Changed property acctCommonsThirdServer (object)
  The third server to receive accounting records for common commands if the first two servers are unavailable.
- Changed property acctEnabledCommand (object)
  Indicates whether accounting is enabled for command execution, tracking user commands for auditing purposes.
- Changed property acctEnabledExec (object)
  Indicates whether accounting is enabled for exec mode sessions, tracking user login sessions for auditing purposes.
- Changed property acctExecFirstServer (object)
  The first server to receive accounting records for exec mode sessions.
- Changed property acctExecSecondServer (object)
  The second server to receive accounting records for exec mode sessions if the first server is unavailable.
- Changed property acctExecThirdServer (object)
  The third server to receive accounting records for exec mode sessions if the first two servers are unavailable.
- Changed property authnEnabledSsh (object)
  Indicates whether AAA authentication is enabled for SSH access to the switch.
- Changed property authnFirstPref (object)
  The first preference method for authentication, specifying the primary authentication mechanism to be used.
- Changed property authnFourthPref (object)
  The fourth preference method for authentication, used as the final fallback option.
- Changed property authnSecondPref (object)
  The second preference method for authentication, used as a fallback if the first method fails.
- Changed property authnThirdPref (object)
  The third preference method for authentication, used as a fallback if the second method fails.
- Changed property authzCommonsFirstServer (object)
  The first server to be consulted for common command authorization.
- Changed property authzCommonsLevel (object)
  The authorization level for common commands, determining the privilege level required.
- Changed property authzCommonsSecondServer (object)
  The second server to be consulted for common command authorization if the first server is unavailable.
- Changed property authzCommonsThirdServer (object)
  The third server to be consulted for common command authorization if the first two servers are unavailable.
- Changed property authzEnabledCommand (object)
  Indicates whether authorization is enabled for command execution on the switch.
- Changed property authzEnabledExec (object)
  Indicates whether authorization is enabled for exec mode access on the switch.
- Changed property authzExecFirstServer (object)
  The first server to be consulted for exec mode authorization.
- Changed property authzExecSecondServer (object)
  The second server to be consulted for exec mode authorization if the first server is unavailable.
- Changed property authzExecThirdServer (object)
  The third server to be consulted for exec mode authorization if the first two servers are unavailable.
Changed content type : application/vnd.ruckus.v1+json
- Changed property acctCommonsFirstServer (object)
  The first TACACS+ server used for common command accounting.
- Changed property acctCommonsLevel (object)
  The privilege level for common accounting commands.
- Changed property acctCommonsSecondServer (object)
  The second TACACS+ server used for common command accounting.
- Changed property acctCommonsThirdServer (object)
  The third TACACS+ server used for common command accounting.
- Changed property acctEnabledCommand (object)
  The flag indicating whether AAA accounting is enabled for CLI command execution tracking.
- Changed property acctEnabledExec (object)
  The flag indicating whether AAA accounting is enabled for exec mode session tracking.
- Changed property acctExecFirstServer (object)
  The first TACACS+ server used for exec mode accounting.
- Changed property acctExecSecondServer (object)
  The second TACACS+ server used for exec mode accounting.
- Changed property acctExecThirdServer (object)
  The third TACACS+ server used for exec mode accounting.
- Changed property authnEnabledSsh (object)
  The flag indicating whether AAA authentication is enabled for SSH access to the switch.
- Changed property authnFirstPref (object)
  The first preference for authentication method, determining the primary authentication source.
- Changed property authnFourthPref (object)
  The fourth preference for authentication method, used as the last fallback authentication source.
- Changed property authnSecondPref (object)
  The second preference for authentication method, used if the first preference fails.
- Changed property authnThirdPref (object)
  The third preference for authentication method, used if the first and second preferences fail.
- Changed property authzCommonsFirstServer (object)
  The first TACACS+ server used for common command authorization.
- Changed property authzCommonsLevel (object)
  The privilege level for common authorization commands.
- Changed property authzCommonsSecondServer (object)
  The second TACACS+ server used for common command authorization.
- Changed property authzCommonsThirdServer (object)
  The third TACACS+ server used for common command authorization.
- Changed property authzEnabledCommand (object)
  The flag indicating whether AAA authorization is enabled for CLI command execution.
- Changed property authzEnabledExec (object)
  The flag indicating whether AAA authorization is enabled for exec mode access.
- Changed property authzExecFirstServer (object)
  The first TACACS+ server used for exec mode authorization.
- Changed property authzExecSecondServer (object)
  The second TACACS+ server used for exec mode authorization.
- Changed property authzExecThirdServer (object)
  The third TACACS+ server used for exec mode authorization.
- Changed property id (object)
  The unique identifier of the AAA settings configuration.

Changed response : 400 Bad Request

Bad/malformed request

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 401 Unauthorized

Unauthorized

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 403 Forbidden

Forbidden

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 404 Not Found

Requested resource or related entity not found

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 422 Unprocessable Entity

Validation error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 500 Internal Server Error

Internal Server Error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

PUT /templates/venues/{venueId}/aaaSettings

Request:

Changed content type : application/json

Changed property acctCommonsFirstServer (object)
The first server to receive accounting records for common commands.
Changed property acctCommonsLevel (object)
The accounting level for common commands, determining which commands are logged.
Changed property acctCommonsSecondServer (object)
The second server to receive accounting records for common commands if the first server is unavailable.
Changed property acctCommonsThirdServer (object)
The third server to receive accounting records for common commands if the first two servers are unavailable.
Changed property acctEnabledCommand (object)
Indicates whether accounting is enabled for command execution, tracking user commands for auditing purposes.
Changed property acctEnabledExec (object)
Indicates whether accounting is enabled for exec mode sessions, tracking user login sessions for auditing purposes.
Changed property acctExecFirstServer (object)
The first server to receive accounting records for exec mode sessions.
Changed property acctExecSecondServer (object)
The second server to receive accounting records for exec mode sessions if the first server is unavailable.
Changed property acctExecThirdServer (object)
The third server to receive accounting records for exec mode sessions if the first two servers are unavailable.
Changed property authnEnabledSsh (object)
Indicates whether AAA authentication is enabled for SSH access to the switch.
Changed property authnFirstPref (object)
The first preference method for authentication, specifying the primary authentication mechanism to be used.
Changed property authnFourthPref (object)
The fourth preference method for authentication, used as the final fallback option.
Changed property authnSecondPref (object)
The second preference method for authentication, used as a fallback if the first method fails.
Changed property authnThirdPref (object)
The third preference method for authentication, used as a fallback if the second method fails.
Changed property authzCommonsFirstServer (object)
The first server to be consulted for common command authorization.
Changed property authzCommonsLevel (object)
The authorization level for common commands, determining the privilege level required.
Changed property authzCommonsSecondServer (object)
The second server to be consulted for common command authorization if the first server is unavailable.
Changed property authzCommonsThirdServer (object)
The third server to be consulted for common command authorization if the first two servers are unavailable.
Changed property authzEnabledCommand (object)
Indicates whether authorization is enabled for command execution on the switch.
Changed property authzEnabledExec (object)
Indicates whether authorization is enabled for exec mode access on the switch.
Changed property authzExecFirstServer (object)
The first server to be consulted for exec mode authorization.
Changed property authzExecSecondServer (object)
The second server to be consulted for exec mode authorization if the first server is unavailable.
Changed property authzExecThirdServer (object)
The third server to be consulted for exec mode authorization if the first two servers are unavailable.

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

Changed property acctCommonsFirstServer (object)
The first server to receive accounting records for common commands.
Changed property acctCommonsLevel (object)
The accounting level for common commands, determining which commands are logged.
Changed property acctCommonsSecondServer (object)
The second server to receive accounting records for common commands if the first server is unavailable.
Changed property acctCommonsThirdServer (object)
The third server to receive accounting records for common commands if the first two servers are unavailable.
Changed property acctEnabledCommand (object)
Indicates whether accounting is enabled for command execution, tracking user commands for auditing purposes.
Changed property acctEnabledExec (object)
Indicates whether accounting is enabled for exec mode sessions, tracking user login sessions for auditing purposes.
Changed property acctExecFirstServer (object)
The first server to receive accounting records for exec mode sessions.
Changed property acctExecSecondServer (object)
The second server to receive accounting records for exec mode sessions if the first server is unavailable.
Changed property acctExecThirdServer (object)
The third server to receive accounting records for exec mode sessions if the first two servers are unavailable.
Changed property authnEnabledSsh (object)
Indicates whether AAA authentication is enabled for SSH access to the switch.
Changed property authnFirstPref (object)
The first preference method for authentication, specifying the primary authentication mechanism to be used.
Changed property authnFourthPref (object)
The fourth preference method for authentication, used as the final fallback option.
Changed property authnSecondPref (object)
The second preference method for authentication, used as a fallback if the first method fails.
Changed property authnThirdPref (object)
The third preference method for authentication, used as a fallback if the second method fails.
Changed property authzCommonsFirstServer (object)
The first server to be consulted for common command authorization.
Changed property authzCommonsLevel (object)
The authorization level for common commands, determining the privilege level required.
Changed property authzCommonsSecondServer (object)
The second server to be consulted for common command authorization if the first server is unavailable.
Changed property authzCommonsThirdServer (object)
The third server to be consulted for common command authorization if the first two servers are unavailable.
Changed property authzEnabledCommand (object)
Indicates whether authorization is enabled for command execution on the switch.
Changed property authzEnabledExec (object)
Indicates whether authorization is enabled for exec mode access on the switch.
Changed property authzExecFirstServer (object)
The first server to be consulted for exec mode authorization.
Changed property authzExecSecondServer (object)
The second server to be consulted for exec mode authorization if the first server is unavailable.
Changed property authzExecThirdServer (object)
The third server to be consulted for exec mode authorization if the first two servers are unavailable.

Return Type:

Changed response : 400 Bad Request

Bad/malformed request

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 401 Unauthorized

Unauthorized

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 403 Forbidden

Forbidden

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 404 Not Found

Requested resource or related entity not found

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 422 Unprocessable Entity

Validation error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 500 Internal Server Error

Internal Server Error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 200 OK

OK

Changed content type : application/json
- Changed property requestId (object)
  The unique identifier for tracking this API operation request.
- Changed property response (object)
  The AAA settings view, containing authentication, authorization, and accounting configuration for switch access control.
  - Changed property acctCommonsFirstServer (object)
    The first server to receive accounting records for common commands.
  - Changed property acctCommonsLevel (object)
    The accounting level for common commands, determining which commands are logged.
  - Changed property acctCommonsSecondServer (object)
    The second server to receive accounting records for common commands if the first server is unavailable.
  - Changed property acctCommonsThirdServer (object)
    The third server to receive accounting records for common commands if the first two servers are unavailable.
  - Changed property acctEnabledCommand (object)
    Indicates whether accounting is enabled for command execution, tracking user commands for auditing purposes.
  - Changed property acctEnabledExec (object)
    Indicates whether accounting is enabled for exec mode sessions, tracking user login sessions for auditing purposes.
  - Changed property acctExecFirstServer (object)
    The first server to receive accounting records for exec mode sessions.
  - Changed property acctExecSecondServer (object)
    The second server to receive accounting records for exec mode sessions if the first server is unavailable.
  - Changed property acctExecThirdServer (object)
    The third server to receive accounting records for exec mode sessions if the first two servers are unavailable.
  - Changed property authnEnabledSsh (object)
    Indicates whether AAA authentication is enabled for SSH access to the switch.
  - Changed property authnFirstPref (object)
    The first preference method for authentication, specifying the primary authentication mechanism to be used.
  - Changed property authnFourthPref (object)
    The fourth preference method for authentication, used as the final fallback option.
  - Changed property authnSecondPref (object)
    The second preference method for authentication, used as a fallback if the first method fails.
  - Changed property authnThirdPref (object)
    The third preference method for authentication, used as a fallback if the second method fails.
  - Changed property authzCommonsFirstServer (object)
    The first server to be consulted for common command authorization.
  - Changed property authzCommonsLevel (object)
    The authorization level for common commands, determining the privilege level required.
  - Changed property authzCommonsSecondServer (object)
    The second server to be consulted for common command authorization if the first server is unavailable.
  - Changed property authzCommonsThirdServer (object)
    The third server to be consulted for common command authorization if the first two servers are unavailable.
  - Changed property authzEnabledCommand (object)
    Indicates whether authorization is enabled for command execution on the switch.
  - Changed property authzEnabledExec (object)
    Indicates whether authorization is enabled for exec mode access on the switch.
  - Changed property authzExecFirstServer (object)
    The first server to be consulted for exec mode authorization.
  - Changed property authzExecSecondServer (object)
    The second server to be consulted for exec mode authorization if the first server is unavailable.
  - Changed property authzExecThirdServer (object)
    The third server to be consulted for exec mode authorization if the first two servers are unavailable.
Changed content type : application/vnd.ruckus.v1+json
- Changed property requestId (object)
  The unique identifier for tracking this API operation request.
- Changed property response (object)
  The AAA settings view, containing authentication, authorization, and accounting configuration for switch access control.
  - Changed property acctCommonsFirstServer (object)
    The first server to receive accounting records for common commands.
  - Changed property acctCommonsLevel (object)
    The accounting level for common commands, determining which commands are logged.
  - Changed property acctCommonsSecondServer (object)
    The second server to receive accounting records for common commands if the first server is unavailable.
  - Changed property acctCommonsThirdServer (object)
    The third server to receive accounting records for common commands if the first two servers are unavailable.
  - Changed property acctEnabledCommand (object)
    Indicates whether accounting is enabled for command execution, tracking user commands for auditing purposes.
  - Changed property acctEnabledExec (object)
    Indicates whether accounting is enabled for exec mode sessions, tracking user login sessions for auditing purposes.
  - Changed property acctExecFirstServer (object)
    The first server to receive accounting records for exec mode sessions.
  - Changed property acctExecSecondServer (object)
    The second server to receive accounting records for exec mode sessions if the first server is unavailable.
  - Changed property acctExecThirdServer (object)
    The third server to receive accounting records for exec mode sessions if the first two servers are unavailable.
  - Changed property authnEnabledSsh (object)
    Indicates whether AAA authentication is enabled for SSH access to the switch.
  - Changed property authnFirstPref (object)
    The first preference method for authentication, specifying the primary authentication mechanism to be used.
  - Changed property authnFourthPref (object)
    The fourth preference method for authentication, used as the final fallback option.
  - Changed property authnSecondPref (object)
    The second preference method for authentication, used as a fallback if the first method fails.
  - Changed property authnThirdPref (object)
    The third preference method for authentication, used as a fallback if the second method fails.
  - Changed property authzCommonsFirstServer (object)
    The first server to be consulted for common command authorization.
  - Changed property authzCommonsLevel (object)
    The authorization level for common commands, determining the privilege level required.
  - Changed property authzCommonsSecondServer (object)
    The second server to be consulted for common command authorization if the first server is unavailable.
  - Changed property authzCommonsThirdServer (object)
    The third server to be consulted for common command authorization if the first two servers are unavailable.
  - Changed property authzEnabledCommand (object)
    Indicates whether authorization is enabled for command execution on the switch.
  - Changed property authzEnabledExec (object)
    Indicates whether authorization is enabled for exec mode access on the switch.
  - Changed property authzExecFirstServer (object)
    The first server to be consulted for exec mode authorization.
  - Changed property authzExecSecondServer (object)
    The second server to be consulted for exec mode authorization if the first server is unavailable.
  - Changed property authzExecThirdServer (object)
    The third server to be consulted for exec mode authorization if the first two servers are unavailable.

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

Request:

Changed content type : application/json

Changed property acctCommonsFirstServer (object)
First preference for accounting command server.
Changed property acctCommonsLevel (object)
Accounting command privilege level.
Changed property acctCommonsSecondServer (object)
Second preference for accounting command server.
Changed property acctCommonsThirdServer (object)
Third preference for accounting command server.
Changed property acctEnabledCommand (object)
Enable or disable command accounting (default: false).
Changed property acctEnabledExec (object)
Enable or disable exec accounting (default: false).
Changed property acctExecFirstServer (object)
First preference for accounting exec server.
Changed property acctExecSecondServer (object)
Second preference for accounting exec server.
Changed property acctExecThirdServer (object)
Third preference for accounting exec server.
Changed property authnEnabledSsh (object)
Enable or disable SSH authentication (default: true).
Changed property authnFirstPref (object)
First preference for authentication server type.
Changed property authnFourthPref (object)
Fourth preference for authentication server type.
Changed property authnSecondPref (object)
Second preference for authentication server type.
Changed property authnThirdPref (object)
Third preference for authentication server type.
Changed property authzCommonsFirstServer (object)
First preference for authorization command server.
Changed property authzCommonsLevel (object)
Authorization command privilege level.
Changed property authzCommonsSecondServer (object)
Second preference for authorization command server.
Changed property authzCommonsThirdServer (object)
Third preference for authorization command server.
Changed property authzEnabledCommand (object)
Enable or disable command authorization (default: false).
Changed property authzEnabledExec (object)
Enable or disable exec authorization (default: false).
Changed property authzExecFirstServer (object)
First preference for authorization exec server.
Changed property authzExecSecondServer (object)
Second preference for authorization exec server.
Changed property authzExecThirdServer (object)
Third preference for authorization exec server.

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

Changed property acctCommonsFirstServer (object)
First preference for accounting command server.
Changed property acctCommonsLevel (object)
Accounting command privilege level.
Changed property acctCommonsSecondServer (object)
Second preference for accounting command server.
Changed property acctCommonsThirdServer (object)
Third preference for accounting command server.
Changed property acctEnabledCommand (object)
Enable or disable command accounting (default: false).
Changed property acctEnabledExec (object)
Enable or disable exec accounting (default: false).
Changed property acctExecFirstServer (object)
First preference for accounting exec server.
Changed property acctExecSecondServer (object)
Second preference for accounting exec server.
Changed property acctExecThirdServer (object)
Third preference for accounting exec server.
Changed property authnEnabledSsh (object)
Enable or disable SSH authentication (default: true).
Changed property authnFirstPref (object)
First preference for authentication server type.
Changed property authnFourthPref (object)
Fourth preference for authentication server type.
Changed property authnSecondPref (object)
Second preference for authentication server type.
Changed property authnThirdPref (object)
Third preference for authentication server type.
Changed property authzCommonsFirstServer (object)
First preference for authorization command server.
Changed property authzCommonsLevel (object)
Authorization command privilege level.
Changed property authzCommonsSecondServer (object)
Second preference for authorization command server.
Changed property authzCommonsThirdServer (object)
Third preference for authorization command server.
Changed property authzEnabledCommand (object)
Enable or disable command authorization (default: false).
Changed property authzEnabledExec (object)
Enable or disable exec authorization (default: false).
Changed property authzExecFirstServer (object)
First preference for authorization exec server.
Changed property authzExecSecondServer (object)
Second preference for authorization exec server.
Changed property authzExecThirdServer (object)
Third preference for authorization exec server.

Return Type:

Changed response : 400 Bad Request

Bad/malformed request

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 401 Unauthorized

Unauthorized

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 403 Forbidden

Forbidden

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 404 Not Found

Requested resource or related entity not found

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 422 Unprocessable Entity

Validation error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 500 Internal Server Error

Internal Server Error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 200 OK

OK

Changed content type : application/json
- Changed property requestId (object)
  The unique identifier for tracking this API operation request.
- Changed property response (object)
  The empty view representing an API response with no data content, used for operations that return success status without additional information.
Changed content type : application/vnd.ruckus.v1+json
- Changed property requestId (object)
  The unique identifier for tracking this API operation request.
- Changed property response (object)
  The empty view representing an API response with no data content, used for operations that return success status without additional information.

GET /templates/venues/{venueId}/switchProfiles

Return Type:

Changed response : 400 Bad Request

Bad/malformed request

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 401 Unauthorized

Unauthorized

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 403 Forbidden

Forbidden

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 404 Not Found

Requested resource or related entity not found

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 422 Unprocessable Entity

Validation error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 500 Internal Server Error

Internal Server Error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 200 OK

OK

Changed content type : application/vnd.ruckus.v1+json
- Changed property acls (object)
  The set of Access Control List configurations included in this profile for traffic filtering.
- Changed property applyOnboardOnly (object)
  The flag indicating whether this profile should only be applied during switch onboarding.
- Changed property description (object)
  The detailed description explaining the purpose and contents of this configuration profile.
- Changed property id (object)
  The identifier
- Changed property name (object)
  The name of the configuration profile for identification and reference.
- Changed property profileType (object)
  The type of profile indicating its scope: global, venue specific, or template based.
- Changed property templateId (object)
  The identifier of the profile template used as the basis for this profile configuration.
- Changed property templateVersion (object)
  The version number of the profile template.
- Changed property trustedPorts (object)
  The set of trusted port configurations for DHCP snooping and ARP inspection security features.
- Changed property venueCount (object)
  The total number of venues where this profile is currently deployed.
- Changed property venues (object)
  The set of venue identifiers where this profile is deployed or available for use.
- Changed property vlans (object)
  The ordered set of VLAN configurations included in this profile with layer 2 security features.
- Changed property voiceVlanConfigs (object)
  The set of voice VLAN configurations for VoIP traffic prioritization across different switch models.
- Changed property venueCliTemplate (object)
  The venue CLI template view, representing CLI templates configured at the venue level for managing switch configurations across multiple devices.
  - Changed property cli (object)
    The CLI command template content containing switch configuration commands and variable placeholders.
  - Changed property id (object)
    The identifier
  - Changed property name (object)
    The unique name identifier for this venue CLI template.
  - Changed property overwrite (object)
    Indicates whether this venue CLI template should overwrite existing configurations when applied to switches.
  - Changed property switchModels (object)
    The switch model identifiers that this venue CLI template supports, defining which hardware models are compatible.
  - Changed property variables (object)
    The set of variables defined in this venue CLI template for dynamic configuration value substitution.

PUT /templates/venues/{venueId}/switchProfiles/{switchProfileId}

Return Type:

Changed response : 400 Bad Request

Bad/malformed request

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 401 Unauthorized

Unauthorized

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 403 Forbidden

Forbidden

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 404 Not Found

Requested resource or related entity not found

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 422 Unprocessable Entity

Validation error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 500 Internal Server Error

Internal Server Error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 202 Accepted

Accepted

Changed content type : application/json
- Changed property requestId (object)
  The unique identifier for tracking this API operation request.
- Changed property response (object)
  The empty view representing an API response with no data content, used for operations that return success status without additional information.
Changed content type : application/vnd.ruckus.v1+json
- Changed property requestId (object)
  The unique identifier for tracking this API operation request.
- Changed property response (object)
  The empty view representing an API response with no data content, used for operations that return success status without additional information.

DELETE /templates/venues/{venueId}/switchProfiles/{switchProfileId}

Return Type:

Changed response : 400 Bad Request

Bad/malformed request

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 401 Unauthorized

Unauthorized

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 403 Forbidden

Forbidden

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 404 Not Found

Requested resource or related entity not found

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 422 Unprocessable Entity

Validation error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 500 Internal Server Error

Internal Server Error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 202 Accepted

Accepted

Changed content type : application/json
- Changed property requestId (object)
  The unique identifier for tracking this API operation request.
- Changed property response (object)
  The empty view representing an API response with no data content, used for operations that return success status without additional information.
Changed content type : application/vnd.ruckus.v1+json
- Changed property requestId (object)
  The unique identifier for tracking this API operation request.
- Changed property response (object)
  The empty view representing an API response with no data content, used for operations that return success status without additional information.

GET /templates/venues/{venueId}/switchSettings

Return Type:

Changed response : 200 OK

OK

Changed content type : application/json
- Changed property cliApplied (object)
  The flag indicating whether CLI templates have been applied to switches in this venue.
- Changed property dns (object)
  The list of DNS server IP addresses configured for this venue template.
- Changed property name (object)
  The unique name of the venue template.
- Changed property profileId (object)
  The set of port profile identifiers associated with this venue template.
- Changed property switchCliProfileIds (object)
  The set of CLI profile identifiers for switch command line interface configuration.
- Changed property switchProfileIds (object)
  The set of switch profile identifiers that are applied at the venue level.
- Changed property syslogEnabled (object)
  The flag indicating whether syslog functionality is enabled for this venue template.
- Changed property syslogPrimaryServer (object)
  The IP address or hostname of the primary syslog server for log collection.
- Changed property syslogSecondaryServer (object)
  The IP address or hostname of the secondary syslog server for redundancy.
Changed content type : application/vnd.ruckus.v1.1+json
- Changed property cliApplied (object)
  The flag indicating whether CLI templates have been applied to switches in this venue.
- Changed property dns (object)
  The list of DNS server IP addresses configured for this venue template.
- Changed property name (object)
  The unique name of the venue template.
- Changed property profileId (object)
  The set of port profile identifiers associated with this venue template.
- Changed property switchCliProfileIds (object)
  The set of CLI profile identifiers for switch command line interface configuration.
- Changed property switchProfileIds (object)
  The set of switch profile identifiers that are applied at the venue level.
- Changed property syslogEnabled (object)
  The flag indicating whether syslog functionality is enabled for this venue template.
- Changed property syslogPrimaryServer (object)
  The IP address or hostname of the primary syslog server for log collection.
- Changed property syslogSecondaryServer (object)
  The IP address or hostname of the secondary syslog server for redundancy.
Changed content type : application/vnd.ruckus.v1+json
- Changed property cliApplied (object)
  The flag indicating whether CLI templates have been applied to switches in this venue.
- Changed property dns (object)
  The list of DNS server IP addresses configured for name resolution at the venue level.
- Changed property id (object)
  The identifier
- Changed property name (object)
  The name of the venue representing a physical location or site in the network infrastructure.
- Changed property profileId (object)
  The set of profile identifiers associated with this venue for switch configuration management.
- Changed property switchCliProfileIds (object)
  The set of CLI profile identifiers applied to switches in this venue.
- Changed property switchLoginPassword (object)
  The password credential for logging into switches in this venue.
- Changed property switchLoginUsername (object)
  The username credential for logging into switches in this venue.
- Changed property switchProfileIds (object)
  The set of switch specific profile identifiers applied to switches in this venue.
- Changed property syslogEnabled (object)
  The flag indicating whether syslog forwarding is enabled for centralized logging of venue switches.
- Changed property syslogPrimaryServer (object)
  The IP address of the primary syslog server for receiving log messages from switches in this venue.
- Changed property syslogSecondaryServer (object)
  The IP address of the secondary syslog server for redundant log message reception.

Changed response : 400 Bad Request

Bad/malformed request

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 401 Unauthorized

Unauthorized

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 403 Forbidden

Forbidden

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 404 Not Found

Requested resource or related entity not found

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 422 Unprocessable Entity

Validation error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 500 Internal Server Error

Internal Server Error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

PUT /templates/venues/{venueId}/switchSettings

Request:

Changed content type : application/json

Changed property dns (object)
List of DNS server IP addresses for switches in venues using this template.
Changed property profileId (object)
Set of profile identifiers associated with this venue template.
Changed property syslogEnabled (object)
Enable syslog for centralized logging of switches in venues using this template (default: false).
Changed property syslogPrimaryServer (object)
Primary syslog server IP address or hostname for the template.
Changed property syslogSecondaryServer (object)
Secondary syslog server IP address or hostname for redundancy in the template.

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

Changed property dns (object)
List of DNS server IP addresses for switches in venues using this template.
Changed property profileId (object)
Set of profile identifiers associated with this venue template.
Changed property syslogEnabled (object)
Enable syslog for centralized logging of switches in venues using this template (default: false).
Changed property syslogPrimaryServer (object)
Primary syslog server IP address or hostname for the template.
Changed property syslogSecondaryServer (object)
Secondary syslog server IP address or hostname for redundancy in the template.

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

Changed property dns (object)
List of DNS server IP addresses for switches in this venue.
Changed property id (object)
Unique identifier for the venue.
Changed property profileId (object)
List of profile identifiers to be associated with this venue.
Changed property syslogEnabled (object)
Enable syslog for centralized logging (default: false).
Changed property syslogPrimaryServer (object)
Primary syslog server IP address or hostname.
Changed property syslogSecondaryServer (object)
Secondary syslog server IP address or hostname for redundancy.

Return Type:

Changed response : 400 Bad Request

Bad/malformed request

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 401 Unauthorized

Unauthorized

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 403 Forbidden

Forbidden

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 404 Not Found

Requested resource or related entity not found

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 422 Unprocessable Entity

Validation error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 500 Internal Server Error

Internal Server Error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 200 OK

OK

Changed content type : application/vnd.ruckus.v1+json
- Changed property cliApplied (object)
  The flag indicating whether CLI templates have been applied to switches in this venue.
- Changed property dns (object)
  The list of DNS server IP addresses configured for name resolution at the venue level.
- Changed property id (object)
  The identifier
- Changed property name (object)
  The name of the venue representing a physical location or site in the network infrastructure.
- Changed property profileId (object)
  The set of profile identifiers associated with this venue for switch configuration management.
- Changed property switchCliProfileIds (object)
  The set of CLI profile identifiers applied to switches in this venue.
- Changed property switchLoginPassword (object)
  The password credential for logging into switches in this venue.
- Changed property switchLoginUsername (object)
  The username credential for logging into switches in this venue.
- Changed property switchProfileIds (object)
  The set of switch specific profile identifiers applied to switches in this venue.
- Changed property syslogEnabled (object)
  The flag indicating whether syslog forwarding is enabled for centralized logging of venue switches.
- Changed property syslogPrimaryServer (object)
  The IP address of the primary syslog server for receiving log messages from switches in this venue.
- Changed property syslogSecondaryServer (object)
  The IP address of the secondary syslog server for redundant log message reception.
Changed content type : application/json
- Changed property requestId (object)
  The unique identifier for tracking this API operation request.
- Changed property response (object)
  The venue view, representing a physical location or site with associated switches, profiles, and network configurations.
  - Changed property cliApplied (object)
    The flag indicating whether CLI templates have been applied to switches in this venue.
  - Changed property dns (object)
    The list of DNS server IP addresses configured for name resolution at the venue level.
  - Changed property name (object)
    The name of the venue representing a physical location or site in the network infrastructure.
  - Changed property profileId (object)
    The set of profile identifiers associated with this venue for switch configuration management.
  - Changed property syslogEnabled (object)
    The flag indicating whether syslog forwarding is enabled for centralized logging of venue switches.
  - Changed property syslogPrimaryServer (object)
    The IP address of the primary syslog server for receiving log messages from switches in this venue.
  - Changed property syslogSecondaryServer (object)
    The IP address of the secondary syslog server for redundant log message reception.
Changed content type : application/vnd.ruckus.v1.1+json
- Changed property requestId (object)
  The unique identifier for tracking this API operation request.
- Changed property response (object)
  The venue view, representing a physical location or site with associated switches, profiles, and network configurations.
  - Changed property cliApplied (object)
    The flag indicating whether CLI templates have been applied to switches in this venue.
  - Changed property dns (object)
    The list of DNS server IP addresses configured for name resolution at the venue level.
  - Changed property name (object)
    The name of the venue representing a physical location or site in the network infrastructure.
  - Changed property profileId (object)
    The set of profile identifiers associated with this venue for switch configuration management.
  - Changed property syslogEnabled (object)
    The flag indicating whether syslog forwarding is enabled for centralized logging of venue switches.
  - Changed property syslogPrimaryServer (object)
    The IP address of the primary syslog server for receiving log messages from switches in this venue.
  - Changed property syslogSecondaryServer (object)
    The IP address of the secondary syslog server for redundant log message reception.

DELETE /venues/aaaServers

Return Type:

Changed response : 400 Bad Request

Bad/malformed request

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 401 Unauthorized

Unauthorized

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 403 Forbidden

Forbidden

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 404 Not Found

Requested resource or related entity not found

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 422 Unprocessable Entity

Validation error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 500 Internal Server Error

Internal Server Error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 200 OK

OK

Changed content type : application/json
- Changed property requestId (object)
  The unique identifier for tracking this API operation request.
- Changed property response (object)
  The empty view representing an API response with no data content, used for operations that return success status without additional information.
Changed content type : application/vnd.ruckus.v1+json
- Changed property requestId (object)
  The unique identifier for tracking this API operation request.
- Changed property response (object)
  The empty view representing an API response with no data content, used for operations that return success status without additional information.

GET /venues/aaaServers/{aaaServerId}

Get AAA Server Setting

Return Type:

Changed response : 200 OK

OK

Changed content type : application/json
- Changed property aaaServerViewList (object)
  The list of AAA server configurations for batch operations or nested server management.
- Changed property acctPort (object)
  The UDP port number for RADIUS accounting packets, typically 1813.
- Changed property authPort (object)
  The UDP port number for RADIUS authentication packets, typically 1812.
- Changed property id (object)
  The unique identifier of the AAA server configuration.
- Changed property ip (object)
  The IP address of the AAA server.
- Changed property level (object)
  The access level or privilege level associated with this AAA server configuration.
- Changed property name (object)
  The name of the AAA server configuration for identification.
- Changed property password (object)
  The password credential for authenticating to the AAA server.
- Changed property purpose (object)
  The purpose of the AAA server: authentication, authorization, or accounting.
- Changed property secret (object)
  The shared secret key used for secure communication with the RADIUS or TACACS+ server.
- Changed property serverType (object)
  The type of AAA server protocol: RADIUS or TACACS+.
- Changed property switchCountInVenue (object)
  The total number of switches in the venue that can use this AAA server.
- Changed property syncedPasswordSwitchCount (object)
  The number of switches that have successfully synchronized the AAA server password.
- Changed property username (object)
  The username credential for authenticating to the AAA server, used for management access.
Changed content type : application/vnd.ruckus.v1+json
- Changed property aaaServerViewList (object)
  The list of AAA server configurations for batch operations or nested server management.
- Changed property acctPort (object)
  The UDP port number for RADIUS accounting packets, typically 1813.
- Changed property authPort (object)
  The UDP port number for RADIUS authentication packets, typically 1812.
- Changed property id (object)
  The unique identifier of the AAA server configuration.
- Changed property ip (object)
  The IP address of the AAA server.
- Changed property level (object)
  The access level or privilege level associated with this AAA server configuration.
- Changed property name (object)
  The name of the AAA server configuration for identification.
- Changed property password (object)
  The password credential for authenticating to the AAA server.
- Changed property purpose (object)
  The purpose of the AAA server: authentication, authorization, or accounting.
- Changed property secret (object)
  The shared secret key used for secure communication with the RADIUS or TACACS+ server.
- Changed property serverType (object)
  The type of AAA server protocol: RADIUS or TACACS+.
- Changed property switchCountInVenue (object)
  The total number of switches in the venue that can use this AAA server.
- Changed property syncedPasswordSwitchCount (object)
  The number of switches that have successfully synchronized the AAA server password.
- Changed property username (object)
  The username credential for authenticating to the AAA server, used for management access.

Changed response : 400 Bad Request

Bad/malformed request

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 401 Unauthorized

Unauthorized

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 403 Forbidden

Forbidden

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 404 Not Found

Requested resource or related entity not found

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 422 Unprocessable Entity

Validation error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 500 Internal Server Error

Internal Server Error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

DELETE /venues/aaaServers/{aaaServerId}

Return Type:

Changed response : 400 Bad Request

Bad/malformed request

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 401 Unauthorized

Unauthorized

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 403 Forbidden

Forbidden

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 404 Not Found

Requested resource or related entity not found

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 422 Unprocessable Entity

Validation error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 500 Internal Server Error

Internal Server Error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 200 OK

OK

Changed content type : application/json
- Changed property requestId (object)
  The unique identifier for tracking this API operation request.
- Changed property response (object)
  The empty view representing an API response with no data content, used for operations that return success status without additional information.
Changed content type : application/vnd.ruckus.v1+json
- Changed property requestId (object)
  The unique identifier for tracking this API operation request.
- Changed property response (object)
  The empty view representing an API response with no data content, used for operations that return success status without additional information.

POST /venues/switches

Return Type:

Changed response : 400 Bad Request

Bad/malformed request

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 401 Unauthorized

Unauthorized

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 403 Forbidden

Forbidden

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 404 Not Found

Requested resource or related entity not found

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 422 Unprocessable Entity

Validation error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 500 Internal Server Error

Internal Server Error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 200 OK

OK

Changed content type : application/json
- Changed property requestId (object)
  The unique identifier for tracking this API operation request.
- Changed property response (object)
  The empty view representing an API response with no data content, used for operations that return success status without additional information.
Changed content type : application/vnd.ruckus.v1+json
- Changed property requestId (object)
  The unique identifier for tracking this API operation request.
- Changed property response (object)
  The empty view representing an API response with no data content, used for operations that return success status without additional information.

POST /venues/{venueId}/aaaServers

Request:

Changed content type : application/json

Changed property acctPort (object)
Accounting port number for RADIUS server (0-65535).
Changed property authEnable (object)
Enable or disable authentication for RADIUS server.
Changed property authPort (object)
Authentication port number for RADIUS or TACACS+ server (0-65535).
Changed property encryptedPassword (object)
Encrypted password for local user authentication.
Changed property id (object)
Unique identifier for the AAA server
Changed property ip (object)
IP address of the AAA server (supports both IPv4 and IPv6 formats).
Changed property level (object)
Privilege level for local user.
Changed property name (object)
Name of the AAA server (2-64 characters)
Changed property password (object)
Password for local user authentication (8-64 characters, stored in plain text for internal use).
Changed property purpose (object)
Purpose of TACACS+ server (e.g., authentication, authorization, accounting).
Changed property secret (object)
Shared secret for RADIUS or TACACS+ server authentication (1-64 characters).
Changed property serverType (object)
Type of AAA server (RADIUS, TACACS_PLUS, or LOCAL).
Changed property username (object)
Username for local user authentication (2-48 characters).

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

Changed property acctPort (object)
Accounting port number for RADIUS server (0-65535).
Changed property authEnable (object)
Enable or disable authentication for RADIUS server.
Changed property authPort (object)
Authentication port number for RADIUS or TACACS+ server (0-65535).
Changed property encryptedPassword (object)
Encrypted password for local user authentication.
Changed property id (object)
Unique identifier for the AAA server
Changed property ip (object)
IP address of the AAA server (supports both IPv4 and IPv6 formats).
Changed property level (object)
Privilege level for local user.
Changed property name (object)
Name of the AAA server (2-64 characters)
Changed property password (object)
Password for local user authentication (8-64 characters, stored in plain text for internal use).
Changed property purpose (object)
Purpose of TACACS+ server (e.g., authentication, authorization, accounting).
Changed property secret (object)
Shared secret for RADIUS or TACACS+ server authentication (1-64 characters).
Changed property serverType (object)
Type of AAA server (RADIUS, TACACS_PLUS, or LOCAL).
Changed property username (object)
Username for local user authentication (2-48 characters).

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

Changed property acctPort (object)
The port number for accounting services, ranging from 0 to 65535.
Changed property authPort (object)
The port number for authentication services, ranging from 0 to 65535.
Changed property ip (object)
The IP address of the AAA server, supporting both IPv4 and IPv6 formats.
Changed property level (object)
The authorization level to be assigned to users authenticated through this server.
Changed property name (object)
The unique name identifier for this AAA server, with a length between 2 and 64 characters.
Changed property password (object)
The password credential for server authentication, with a length between 8 and 64 characters.
Changed property purpose (object)
The purpose of this AAA server, specifying whether it handles authentication, authorization, or accounting.
Changed property secret (object)
The shared secret key for secure communication with the AAA server, with a length between 1 and 64 characters.
Changed property serverType (object)
The AAA server protocol type, such as RADIUS or TACACS+.
Changed property username (object)
The username credential for server authentication, with a length between 2 and 48 characters.

Return Type:

Changed response : 200 OK

OK

Changed content type : application/json
- Changed property aaaServerViewList (object)
  The list of AAA server configurations for batch operations or nested server management.
- Changed property acctPort (object)
  The UDP port number for RADIUS accounting packets, typically 1813.
- Changed property authPort (object)
  The UDP port number for RADIUS authentication packets, typically 1812.
- Changed property id (object)
  The unique identifier of the AAA server configuration.
- Changed property ip (object)
  The IP address of the AAA server.
- Changed property level (object)
  The access level or privilege level associated with this AAA server configuration.
- Changed property name (object)
  The name of the AAA server configuration for identification.
- Changed property password (object)
  The password credential for authenticating to the AAA server.
- Changed property purpose (object)
  The purpose of the AAA server: authentication, authorization, or accounting.
- Changed property secret (object)
  The shared secret key used for secure communication with the RADIUS or TACACS+ server.
- Changed property serverType (object)
  The type of AAA server protocol: RADIUS or TACACS+.
- Changed property switchCountInVenue (object)
  The total number of switches in the venue that can use this AAA server.
- Changed property syncedPasswordSwitchCount (object)
  The number of switches that have successfully synchronized the AAA server password.
- Changed property username (object)
  The username credential for authenticating to the AAA server, used for management access.
Changed content type : application/vnd.ruckus.v1+json
- Changed property aaaServerViewList (object)
  The list of AAA server configurations for batch operations or nested server management.
- Changed property acctPort (object)
  The UDP port number for RADIUS accounting packets, typically 1813.
- Changed property authPort (object)
  The UDP port number for RADIUS authentication packets, typically 1812.
- Changed property id (object)
  The unique identifier of the AAA server configuration.
- Changed property ip (object)
  The IP address of the AAA server.
- Changed property level (object)
  The access level or privilege level associated with this AAA server configuration.
- Changed property name (object)
  The name of the AAA server configuration for identification.
- Changed property password (object)
  The password credential for authenticating to the AAA server.
- Changed property purpose (object)
  The purpose of the AAA server: authentication, authorization, or accounting.
- Changed property secret (object)
  The shared secret key used for secure communication with the RADIUS or TACACS+ server.
- Changed property serverType (object)
  The type of AAA server protocol: RADIUS or TACACS+.
- Changed property switchCountInVenue (object)
  The total number of switches in the venue that can use this AAA server.
- Changed property syncedPasswordSwitchCount (object)
  The number of switches that have successfully synchronized the AAA server password.
- Changed property username (object)
  The username credential for authenticating to the AAA server, used for management access.

Changed response : 400 Bad Request

Bad/malformed request

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 401 Unauthorized

Unauthorized

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 403 Forbidden

Forbidden

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 404 Not Found

Requested resource or related entity not found

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 422 Unprocessable Entity

Validation error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 500 Internal Server Error

Internal Server Error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 201 Created

Created

Changed content type : application/vnd.ruckus.v1.1+json
- Changed property requestId (object)
  The unique identifier for tracking this API operation request.
- Changed property response (object)
  The AAA server configuration view, containing server connection details and authentication settings.
  - Changed property acctPort (object)
    The port number used for accounting services on the AAA server.
  - Changed property authPort (object)
    The port number used for authentication services on the AAA server.
  - Changed property ip (object)
    The IP address of the AAA server.
  - Changed property level (object)
    The authorization level assigned to users authenticated through this AAA server.
  - Changed property name (object)
    The name identifier for this AAA server configuration.
  - Changed property password (object)
    The password credential used for authenticating with the AAA server.
  - Changed property purpose (object)
    The purpose of this AAA server, indicating whether it is used for authentication, authorization, or accounting.
  - Changed property secret (object)
    The shared secret key used for secure communication between the switch and the AAA server.
  - Changed property serverType (object)
    The type of AAA server protocol being used, such as RADIUS or TACACS+.
  - Changed property switchCountInVenue (object)
    The total number of switches in the venue that are configured to use this AAA server.
  - Changed property syncedPasswordSwitchCount (object)
    The number of switches that have successfully synchronized their admin password with this AAA server.
  - Changed property username (object)
    The username credential used for authenticating with the AAA server.

DELETE /venues/{venueId}/aaaServers

Return Type:

Changed response : 400 Bad Request

Bad/malformed request

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 401 Unauthorized

Unauthorized

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 403 Forbidden

Forbidden

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 404 Not Found

Requested resource or related entity not found

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 422 Unprocessable Entity

Validation error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 500 Internal Server Error

Internal Server Error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 204 No Content

No Content

Changed content type : application/json
- Changed property requestId (object)
  The unique identifier for tracking this API operation request.
- Changed property response (object)
  The empty view representing an API response with no data content, used for operations that return success status without additional information.
Changed content type : application/vnd.ruckus.v1+json
- Changed property requestId (object)
  The unique identifier for tracking this API operation request.
- Changed property response (object)
  The empty view representing an API response with no data content, used for operations that return success status without additional information.

GET /venues/{venueId}/aaaServers/{aaaServerId}

Get AAA Server Setting

Return Type:

Changed response : 200 OK

OK

Changed content type : application/json
- Changed property acctPort (object)
  The port number used for accounting services on the AAA server.
- Changed property authPort (object)
  The port number used for authentication services on the AAA server.
- Changed property ip (object)
  The IP address of the AAA server.
- Changed property level (object)
  The authorization level assigned to users authenticated through this AAA server.
- Changed property name (object)
  The name identifier for this AAA server configuration.
- Changed property password (object)
  The password credential used for authenticating with the AAA server.
- Changed property purpose (object)
  The purpose of this AAA server, indicating whether it is used for authentication, authorization, or accounting.
- Changed property secret (object)
  The shared secret key used for secure communication between the switch and the AAA server.
- Changed property serverType (object)
  The type of AAA server protocol being used, such as RADIUS or TACACS+.
- Changed property switchCountInVenue (object)
  The total number of switches in the venue that are configured to use this AAA server.
- Changed property syncedPasswordSwitchCount (object)
  The number of switches that have successfully synchronized their admin password with this AAA server.
- Changed property username (object)
  The username credential used for authenticating with the AAA server.
Changed content type : application/vnd.ruckus.v1+json
- Changed property acctPort (object)
  The port number used for accounting services on the AAA server.
- Changed property authPort (object)
  The port number used for authentication services on the AAA server.
- Changed property ip (object)
  The IP address of the AAA server.
- Changed property level (object)
  The authorization level assigned to users authenticated through this AAA server.
- Changed property name (object)
  The name identifier for this AAA server configuration.
- Changed property password (object)
  The password credential used for authenticating with the AAA server.
- Changed property purpose (object)
  The purpose of this AAA server, indicating whether it is used for authentication, authorization, or accounting.
- Changed property secret (object)
  The shared secret key used for secure communication between the switch and the AAA server.
- Changed property serverType (object)
  The type of AAA server protocol being used, such as RADIUS or TACACS+.
- Changed property switchCountInVenue (object)
  The total number of switches in the venue that are configured to use this AAA server.
- Changed property syncedPasswordSwitchCount (object)
  The number of switches that have successfully synchronized their admin password with this AAA server.
- Changed property username (object)
  The username credential used for authenticating with the AAA server.

Changed response : 400 Bad Request

Bad/malformed request

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 401 Unauthorized

Unauthorized

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 403 Forbidden

Forbidden

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 404 Not Found

Requested resource or related entity not found

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 422 Unprocessable Entity

Validation error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 500 Internal Server Error

Internal Server Error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

PUT /venues/{venueId}/aaaServers/{aaaServerId}

Request:

Changed content type : application/json

Changed property acctPort (object)
Accounting port number for RADIUS server (0-65535).
Changed property authEnable (object)
Enable or disable authentication for RADIUS server.
Changed property authPort (object)
Authentication port number for RADIUS or TACACS+ server (0-65535).
Changed property encryptedPassword (object)
Encrypted password for local user authentication.
Changed property id (object)
Unique identifier for the AAA server
Changed property ip (object)
IP address of the AAA server (supports both IPv4 and IPv6 formats).
Changed property level (object)
Privilege level for local user.
Changed property name (object)
Name of the AAA server (2-64 characters)
Changed property password (object)
Password for local user authentication (8-64 characters, stored in plain text for internal use).
Changed property purpose (object)
Purpose of TACACS+ server (e.g., authentication, authorization, accounting).
Changed property secret (object)
Shared secret for RADIUS or TACACS+ server authentication (1-64 characters).
Changed property serverType (object)
Type of AAA server (RADIUS, TACACS_PLUS, or LOCAL).
Changed property username (object)
Username for local user authentication (2-48 characters).

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

Changed property acctPort (object)
Accounting port number for RADIUS server (0-65535).
Changed property authEnable (object)
Enable or disable authentication for RADIUS server.
Changed property authPort (object)
Authentication port number for RADIUS or TACACS+ server (0-65535).
Changed property encryptedPassword (object)
Encrypted password for local user authentication.
Changed property id (object)
Unique identifier for the AAA server
Changed property ip (object)
IP address of the AAA server (supports both IPv4 and IPv6 formats).
Changed property level (object)
Privilege level for local user.
Changed property name (object)
Name of the AAA server (2-64 characters)
Changed property password (object)
Password for local user authentication (8-64 characters, stored in plain text for internal use).
Changed property purpose (object)
Purpose of TACACS+ server (e.g., authentication, authorization, accounting).
Changed property secret (object)
Shared secret for RADIUS or TACACS+ server authentication (1-64 characters).
Changed property serverType (object)
Type of AAA server (RADIUS, TACACS_PLUS, or LOCAL).
Changed property username (object)
Username for local user authentication (2-48 characters).

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

Changed property acctPort (object)
The port number for accounting services, ranging from 0 to 65535.
Changed property authPort (object)
The port number for authentication services, ranging from 0 to 65535.
Changed property ip (object)
The IP address of the AAA server, supporting both IPv4 and IPv6 formats.
Changed property level (object)
The authorization level to be assigned to users authenticated through this server.
Changed property name (object)
The unique name identifier for this AAA server, with a length between 2 and 64 characters.
Changed property password (object)
The password credential for server authentication, with a length between 8 and 64 characters.
Changed property purpose (object)
The purpose of this AAA server, specifying whether it handles authentication, authorization, or accounting.
Changed property secret (object)
The shared secret key for secure communication with the AAA server, with a length between 1 and 64 characters.
Changed property serverType (object)
The AAA server protocol type, such as RADIUS or TACACS+.
Changed property username (object)
The username credential for server authentication, with a length between 2 and 48 characters.

Return Type:

Changed response : 400 Bad Request

Bad/malformed request

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 401 Unauthorized

Unauthorized

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 403 Forbidden

Forbidden

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 404 Not Found

Requested resource or related entity not found

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 422 Unprocessable Entity

Validation error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 500 Internal Server Error

Internal Server Error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 200 OK

OK

Changed content type : application/json
- Changed property aaaServerViewList (object)
  The list of AAA server configurations for batch operations or nested server management.
- Changed property acctPort (object)
  The UDP port number for RADIUS accounting packets, typically 1813.
- Changed property authPort (object)
  The UDP port number for RADIUS authentication packets, typically 1812.
- Changed property id (object)
  The unique identifier of the AAA server configuration.
- Changed property ip (object)
  The IP address of the AAA server.
- Changed property level (object)
  The access level or privilege level associated with this AAA server configuration.
- Changed property name (object)
  The name of the AAA server configuration for identification.
- Changed property password (object)
  The password credential for authenticating to the AAA server.
- Changed property purpose (object)
  The purpose of the AAA server: authentication, authorization, or accounting.
- Changed property secret (object)
  The shared secret key used for secure communication with the RADIUS or TACACS+ server.
- Changed property serverType (object)
  The type of AAA server protocol: RADIUS or TACACS+.
- Changed property switchCountInVenue (object)
  The total number of switches in the venue that can use this AAA server.
- Changed property syncedPasswordSwitchCount (object)
  The number of switches that have successfully synchronized the AAA server password.
- Changed property username (object)
  The username credential for authenticating to the AAA server, used for management access.
Changed content type : application/vnd.ruckus.v1+json
- Changed property aaaServerViewList (object)
  The list of AAA server configurations for batch operations or nested server management.
- Changed property acctPort (object)
  The UDP port number for RADIUS accounting packets, typically 1813.
- Changed property authPort (object)
  The UDP port number for RADIUS authentication packets, typically 1812.
- Changed property id (object)
  The unique identifier of the AAA server configuration.
- Changed property ip (object)
  The IP address of the AAA server.
- Changed property level (object)
  The access level or privilege level associated with this AAA server configuration.
- Changed property name (object)
  The name of the AAA server configuration for identification.
- Changed property password (object)
  The password credential for authenticating to the AAA server.
- Changed property purpose (object)
  The purpose of the AAA server: authentication, authorization, or accounting.
- Changed property secret (object)
  The shared secret key used for secure communication with the RADIUS or TACACS+ server.
- Changed property serverType (object)
  The type of AAA server protocol: RADIUS or TACACS+.
- Changed property switchCountInVenue (object)
  The total number of switches in the venue that can use this AAA server.
- Changed property syncedPasswordSwitchCount (object)
  The number of switches that have successfully synchronized the AAA server password.
- Changed property username (object)
  The username credential for authenticating to the AAA server, used for management access.
Changed content type : application/vnd.ruckus.v1.1+json
- Changed property requestId (object)
  The unique identifier for tracking this API operation request.
- Changed property response (object)
  The AAA server configuration view, containing server connection details and authentication settings.
  - Changed property acctPort (object)
    The port number used for accounting services on the AAA server.
  - Changed property authPort (object)
    The port number used for authentication services on the AAA server.
  - Changed property ip (object)
    The IP address of the AAA server.
  - Changed property level (object)
    The authorization level assigned to users authenticated through this AAA server.
  - Changed property name (object)
    The name identifier for this AAA server configuration.
  - Changed property password (object)
    The password credential used for authenticating with the AAA server.
  - Changed property purpose (object)
    The purpose of this AAA server, indicating whether it is used for authentication, authorization, or accounting.
  - Changed property secret (object)
    The shared secret key used for secure communication between the switch and the AAA server.
  - Changed property serverType (object)
    The type of AAA server protocol being used, such as RADIUS or TACACS+.
  - Changed property switchCountInVenue (object)
    The total number of switches in the venue that are configured to use this AAA server.
  - Changed property syncedPasswordSwitchCount (object)
    The number of switches that have successfully synchronized their admin password with this AAA server.
  - Changed property username (object)
    The username credential used for authenticating with the AAA server.

DELETE /venues/{venueId}/aaaServers/{aaaServerId}

Return Type:

Changed response : 400 Bad Request

Bad/malformed request

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 401 Unauthorized

Unauthorized

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 403 Forbidden

Forbidden

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 404 Not Found

Requested resource or related entity not found

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 422 Unprocessable Entity

Validation error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 500 Internal Server Error

Internal Server Error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 200 OK

OK

Changed content type : application/json
- Changed property requestId (object)
  The unique identifier for tracking this API operation request.
- Changed property response (object)
  The empty view representing an API response with no data content, used for operations that return success status without additional information.
Changed content type : application/vnd.ruckus.v1+json
- Changed property requestId (object)
  The unique identifier for tracking this API operation request.
- Changed property response (object)
  The empty view representing an API response with no data content, used for operations that return success status without additional information.

GET /venues/{venueId}/aaaSettings

Return Type:

Changed response : 200 OK

OK

Changed content type : application/json
- Changed property acctCommonsFirstServer (object)
  The first TACACS+ server used for common command accounting.
- Changed property acctCommonsLevel (object)
  The privilege level for common accounting commands.
- Changed property acctCommonsSecondServer (object)
  The second TACACS+ server used for common command accounting.
- Changed property acctCommonsThirdServer (object)
  The third TACACS+ server used for common command accounting.
- Changed property acctEnabledCommand (object)
  The flag indicating whether AAA accounting is enabled for CLI command execution tracking.
- Changed property acctEnabledExec (object)
  The flag indicating whether AAA accounting is enabled for exec mode session tracking.
- Changed property acctExecFirstServer (object)
  The first TACACS+ server used for exec mode accounting.
- Changed property acctExecSecondServer (object)
  The second TACACS+ server used for exec mode accounting.
- Changed property acctExecThirdServer (object)
  The third TACACS+ server used for exec mode accounting.
- Changed property authnEnabledSsh (object)
  The flag indicating whether AAA authentication is enabled for SSH access to the switch.
- Changed property authnFirstPref (object)
  The first preference for authentication method, determining the primary authentication source.
- Changed property authnFourthPref (object)
  The fourth preference for authentication method, used as the last fallback authentication source.
- Changed property authnSecondPref (object)
  The second preference for authentication method, used if the first preference fails.
- Changed property authnThirdPref (object)
  The third preference for authentication method, used if the first and second preferences fail.
- Changed property authzCommonsFirstServer (object)
  The first TACACS+ server used for common command authorization.
- Changed property authzCommonsLevel (object)
  The privilege level for common authorization commands.
- Changed property authzCommonsSecondServer (object)
  The second TACACS+ server used for common command authorization.
- Changed property authzCommonsThirdServer (object)
  The third TACACS+ server used for common command authorization.
- Changed property authzEnabledCommand (object)
  The flag indicating whether AAA authorization is enabled for CLI command execution.
- Changed property authzEnabledExec (object)
  The flag indicating whether AAA authorization is enabled for exec mode access.
- Changed property authzExecFirstServer (object)
  The first TACACS+ server used for exec mode authorization.
- Changed property authzExecSecondServer (object)
  The second TACACS+ server used for exec mode authorization.
- Changed property authzExecThirdServer (object)
  The third TACACS+ server used for exec mode authorization.
- Changed property id (object)
  The unique identifier of the AAA settings configuration.
Changed content type : application/vnd.ruckus.v1+json
- Changed property acctCommonsFirstServer (object)
  The first TACACS+ server used for common command accounting.
- Changed property acctCommonsLevel (object)
  The privilege level for common accounting commands.
- Changed property acctCommonsSecondServer (object)
  The second TACACS+ server used for common command accounting.
- Changed property acctCommonsThirdServer (object)
  The third TACACS+ server used for common command accounting.
- Changed property acctEnabledCommand (object)
  The flag indicating whether AAA accounting is enabled for CLI command execution tracking.
- Changed property acctEnabledExec (object)
  The flag indicating whether AAA accounting is enabled for exec mode session tracking.
- Changed property acctExecFirstServer (object)
  The first TACACS+ server used for exec mode accounting.
- Changed property acctExecSecondServer (object)
  The second TACACS+ server used for exec mode accounting.
- Changed property acctExecThirdServer (object)
  The third TACACS+ server used for exec mode accounting.
- Changed property authnEnabledSsh (object)
  The flag indicating whether AAA authentication is enabled for SSH access to the switch.
- Changed property authnFirstPref (object)
  The first preference for authentication method, determining the primary authentication source.
- Changed property authnFourthPref (object)
  The fourth preference for authentication method, used as the last fallback authentication source.
- Changed property authnSecondPref (object)
  The second preference for authentication method, used if the first preference fails.
- Changed property authnThirdPref (object)
  The third preference for authentication method, used if the first and second preferences fail.
- Changed property authzCommonsFirstServer (object)
  The first TACACS+ server used for common command authorization.
- Changed property authzCommonsLevel (object)
  The privilege level for common authorization commands.
- Changed property authzCommonsSecondServer (object)
  The second TACACS+ server used for common command authorization.
- Changed property authzCommonsThirdServer (object)
  The third TACACS+ server used for common command authorization.
- Changed property authzEnabledCommand (object)
  The flag indicating whether AAA authorization is enabled for CLI command execution.
- Changed property authzEnabledExec (object)
  The flag indicating whether AAA authorization is enabled for exec mode access.
- Changed property authzExecFirstServer (object)
  The first TACACS+ server used for exec mode authorization.
- Changed property authzExecSecondServer (object)
  The second TACACS+ server used for exec mode authorization.
- Changed property authzExecThirdServer (object)
  The third TACACS+ server used for exec mode authorization.
- Changed property id (object)
  The unique identifier of the AAA settings configuration.
Changed content type : application/vnd.ruckus.v1.1+json
- Changed property acctCommonsFirstServer (object)
  The first server to receive accounting records for common commands.
- Changed property acctCommonsLevel (object)
  The accounting level for common commands, determining which commands are logged.
- Changed property acctCommonsSecondServer (object)
  The second server to receive accounting records for common commands if the first server is unavailable.
- Changed property acctCommonsThirdServer (object)
  The third server to receive accounting records for common commands if the first two servers are unavailable.
- Changed property acctEnabledCommand (object)
  Indicates whether accounting is enabled for command execution, tracking user commands for auditing purposes.
- Changed property acctEnabledExec (object)
  Indicates whether accounting is enabled for exec mode sessions, tracking user login sessions for auditing purposes.
- Changed property acctExecFirstServer (object)
  The first server to receive accounting records for exec mode sessions.
- Changed property acctExecSecondServer (object)
  The second server to receive accounting records for exec mode sessions if the first server is unavailable.
- Changed property acctExecThirdServer (object)
  The third server to receive accounting records for exec mode sessions if the first two servers are unavailable.
- Changed property authnEnabledSsh (object)
  Indicates whether AAA authentication is enabled for SSH access to the switch.
- Changed property authnFirstPref (object)
  The first preference method for authentication, specifying the primary authentication mechanism to be used.
- Changed property authnFourthPref (object)
  The fourth preference method for authentication, used as the final fallback option.
- Changed property authnSecondPref (object)
  The second preference method for authentication, used as a fallback if the first method fails.
- Changed property authnThirdPref (object)
  The third preference method for authentication, used as a fallback if the second method fails.
- Changed property authzCommonsFirstServer (object)
  The first server to be consulted for common command authorization.
- Changed property authzCommonsLevel (object)
  The authorization level for common commands, determining the privilege level required.
- Changed property authzCommonsSecondServer (object)
  The second server to be consulted for common command authorization if the first server is unavailable.
- Changed property authzCommonsThirdServer (object)
  The third server to be consulted for common command authorization if the first two servers are unavailable.
- Changed property authzEnabledCommand (object)
  Indicates whether authorization is enabled for command execution on the switch.
- Changed property authzEnabledExec (object)
  Indicates whether authorization is enabled for exec mode access on the switch.
- Changed property authzExecFirstServer (object)
  The first server to be consulted for exec mode authorization.
- Changed property authzExecSecondServer (object)
  The second server to be consulted for exec mode authorization if the first server is unavailable.
- Changed property authzExecThirdServer (object)
  The third server to be consulted for exec mode authorization if the first two servers are unavailable.

Changed response : 400 Bad Request

Bad/malformed request

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 401 Unauthorized

Unauthorized

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 403 Forbidden

Forbidden

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 404 Not Found

Requested resource or related entity not found

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 422 Unprocessable Entity

Validation error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 500 Internal Server Error

Internal Server Error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

PUT /venues/{venueId}/aaaSettings

Request:

Changed content type : application/json

Changed property acctCommonsFirstServer (object)
The first server to receive accounting records for common commands.
Changed property acctCommonsLevel (object)
The accounting level for common commands, determining which commands are logged.
Changed property acctCommonsSecondServer (object)
The second server to receive accounting records for common commands if the first server is unavailable.
Changed property acctCommonsThirdServer (object)
The third server to receive accounting records for common commands if the first two servers are unavailable.
Changed property acctEnabledCommand (object)
Indicates whether accounting is enabled for command execution, tracking user commands for auditing purposes.
Changed property acctEnabledExec (object)
Indicates whether accounting is enabled for exec mode sessions, tracking user login sessions for auditing purposes.
Changed property acctExecFirstServer (object)
The first server to receive accounting records for exec mode sessions.
Changed property acctExecSecondServer (object)
The second server to receive accounting records for exec mode sessions if the first server is unavailable.
Changed property acctExecThirdServer (object)
The third server to receive accounting records for exec mode sessions if the first two servers are unavailable.
Changed property authnEnabledSsh (object)
Indicates whether AAA authentication is enabled for SSH access to the switch.
Changed property authnFirstPref (object)
The first preference method for authentication, specifying the primary authentication mechanism to be used.
Changed property authnFourthPref (object)
The fourth preference method for authentication, used as the final fallback option.
Changed property authnSecondPref (object)
The second preference method for authentication, used as a fallback if the first method fails.
Changed property authnThirdPref (object)
The third preference method for authentication, used as a fallback if the second method fails.
Changed property authzCommonsFirstServer (object)
The first server to be consulted for common command authorization.
Changed property authzCommonsLevel (object)
The authorization level for common commands, determining the privilege level required.
Changed property authzCommonsSecondServer (object)
The second server to be consulted for common command authorization if the first server is unavailable.
Changed property authzCommonsThirdServer (object)
The third server to be consulted for common command authorization if the first two servers are unavailable.
Changed property authzEnabledCommand (object)
Indicates whether authorization is enabled for command execution on the switch.
Changed property authzEnabledExec (object)
Indicates whether authorization is enabled for exec mode access on the switch.
Changed property authzExecFirstServer (object)
The first server to be consulted for exec mode authorization.
Changed property authzExecSecondServer (object)
The second server to be consulted for exec mode authorization if the first server is unavailable.
Changed property authzExecThirdServer (object)
The third server to be consulted for exec mode authorization if the first two servers are unavailable.

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

Changed property acctCommonsFirstServer (object)
The first server to receive accounting records for common commands.
Changed property acctCommonsLevel (object)
The accounting level for common commands, determining which commands are logged.
Changed property acctCommonsSecondServer (object)
The second server to receive accounting records for common commands if the first server is unavailable.
Changed property acctCommonsThirdServer (object)
The third server to receive accounting records for common commands if the first two servers are unavailable.
Changed property acctEnabledCommand (object)
Indicates whether accounting is enabled for command execution, tracking user commands for auditing purposes.
Changed property acctEnabledExec (object)
Indicates whether accounting is enabled for exec mode sessions, tracking user login sessions for auditing purposes.
Changed property acctExecFirstServer (object)
The first server to receive accounting records for exec mode sessions.
Changed property acctExecSecondServer (object)
The second server to receive accounting records for exec mode sessions if the first server is unavailable.
Changed property acctExecThirdServer (object)
The third server to receive accounting records for exec mode sessions if the first two servers are unavailable.
Changed property authnEnabledSsh (object)
Indicates whether AAA authentication is enabled for SSH access to the switch.
Changed property authnFirstPref (object)
The first preference method for authentication, specifying the primary authentication mechanism to be used.
Changed property authnFourthPref (object)
The fourth preference method for authentication, used as the final fallback option.
Changed property authnSecondPref (object)
The second preference method for authentication, used as a fallback if the first method fails.
Changed property authnThirdPref (object)
The third preference method for authentication, used as a fallback if the second method fails.
Changed property authzCommonsFirstServer (object)
The first server to be consulted for common command authorization.
Changed property authzCommonsLevel (object)
The authorization level for common commands, determining the privilege level required.
Changed property authzCommonsSecondServer (object)
The second server to be consulted for common command authorization if the first server is unavailable.
Changed property authzCommonsThirdServer (object)
The third server to be consulted for common command authorization if the first two servers are unavailable.
Changed property authzEnabledCommand (object)
Indicates whether authorization is enabled for command execution on the switch.
Changed property authzEnabledExec (object)
Indicates whether authorization is enabled for exec mode access on the switch.
Changed property authzExecFirstServer (object)
The first server to be consulted for exec mode authorization.
Changed property authzExecSecondServer (object)
The second server to be consulted for exec mode authorization if the first server is unavailable.
Changed property authzExecThirdServer (object)
The third server to be consulted for exec mode authorization if the first two servers are unavailable.

Return Type:

Changed response : 400 Bad Request

Bad/malformed request

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 401 Unauthorized

Unauthorized

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 403 Forbidden

Forbidden

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 404 Not Found

Requested resource or related entity not found

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 422 Unprocessable Entity

Validation error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 500 Internal Server Error

Internal Server Error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 200 OK

OK

Changed content type : application/json
- Changed property requestId (object)
  The unique identifier for tracking this API operation request.
- Changed property response (object)
  The AAA settings view, containing authentication, authorization, and accounting configuration for switch access control.
  - Changed property acctCommonsFirstServer (object)
    The first server to receive accounting records for common commands.
  - Changed property acctCommonsLevel (object)
    The accounting level for common commands, determining which commands are logged.
  - Changed property acctCommonsSecondServer (object)
    The second server to receive accounting records for common commands if the first server is unavailable.
  - Changed property acctCommonsThirdServer (object)
    The third server to receive accounting records for common commands if the first two servers are unavailable.
  - Changed property acctEnabledCommand (object)
    Indicates whether accounting is enabled for command execution, tracking user commands for auditing purposes.
  - Changed property acctEnabledExec (object)
    Indicates whether accounting is enabled for exec mode sessions, tracking user login sessions for auditing purposes.
  - Changed property acctExecFirstServer (object)
    The first server to receive accounting records for exec mode sessions.
  - Changed property acctExecSecondServer (object)
    The second server to receive accounting records for exec mode sessions if the first server is unavailable.
  - Changed property acctExecThirdServer (object)
    The third server to receive accounting records for exec mode sessions if the first two servers are unavailable.
  - Changed property authnEnabledSsh (object)
    Indicates whether AAA authentication is enabled for SSH access to the switch.
  - Changed property authnFirstPref (object)
    The first preference method for authentication, specifying the primary authentication mechanism to be used.
  - Changed property authnFourthPref (object)
    The fourth preference method for authentication, used as the final fallback option.
  - Changed property authnSecondPref (object)
    The second preference method for authentication, used as a fallback if the first method fails.
  - Changed property authnThirdPref (object)
    The third preference method for authentication, used as a fallback if the second method fails.
  - Changed property authzCommonsFirstServer (object)
    The first server to be consulted for common command authorization.
  - Changed property authzCommonsLevel (object)
    The authorization level for common commands, determining the privilege level required.
  - Changed property authzCommonsSecondServer (object)
    The second server to be consulted for common command authorization if the first server is unavailable.
  - Changed property authzCommonsThirdServer (object)
    The third server to be consulted for common command authorization if the first two servers are unavailable.
  - Changed property authzEnabledCommand (object)
    Indicates whether authorization is enabled for command execution on the switch.
  - Changed property authzEnabledExec (object)
    Indicates whether authorization is enabled for exec mode access on the switch.
  - Changed property authzExecFirstServer (object)
    The first server to be consulted for exec mode authorization.
  - Changed property authzExecSecondServer (object)
    The second server to be consulted for exec mode authorization if the first server is unavailable.
  - Changed property authzExecThirdServer (object)
    The third server to be consulted for exec mode authorization if the first two servers are unavailable.
Changed content type : application/vnd.ruckus.v1+json
- Changed property requestId (object)
  The unique identifier for tracking this API operation request.
- Changed property response (object)
  The AAA settings view, containing authentication, authorization, and accounting configuration for switch access control.
  - Changed property acctCommonsFirstServer (object)
    The first server to receive accounting records for common commands.
  - Changed property acctCommonsLevel (object)
    The accounting level for common commands, determining which commands are logged.
  - Changed property acctCommonsSecondServer (object)
    The second server to receive accounting records for common commands if the first server is unavailable.
  - Changed property acctCommonsThirdServer (object)
    The third server to receive accounting records for common commands if the first two servers are unavailable.
  - Changed property acctEnabledCommand (object)
    Indicates whether accounting is enabled for command execution, tracking user commands for auditing purposes.
  - Changed property acctEnabledExec (object)
    Indicates whether accounting is enabled for exec mode sessions, tracking user login sessions for auditing purposes.
  - Changed property acctExecFirstServer (object)
    The first server to receive accounting records for exec mode sessions.
  - Changed property acctExecSecondServer (object)
    The second server to receive accounting records for exec mode sessions if the first server is unavailable.
  - Changed property acctExecThirdServer (object)
    The third server to receive accounting records for exec mode sessions if the first two servers are unavailable.
  - Changed property authnEnabledSsh (object)
    Indicates whether AAA authentication is enabled for SSH access to the switch.
  - Changed property authnFirstPref (object)
    The first preference method for authentication, specifying the primary authentication mechanism to be used.
  - Changed property authnFourthPref (object)
    The fourth preference method for authentication, used as the final fallback option.
  - Changed property authnSecondPref (object)
    The second preference method for authentication, used as a fallback if the first method fails.
  - Changed property authnThirdPref (object)
    The third preference method for authentication, used as a fallback if the second method fails.
  - Changed property authzCommonsFirstServer (object)
    The first server to be consulted for common command authorization.
  - Changed property authzCommonsLevel (object)
    The authorization level for common commands, determining the privilege level required.
  - Changed property authzCommonsSecondServer (object)
    The second server to be consulted for common command authorization if the first server is unavailable.
  - Changed property authzCommonsThirdServer (object)
    The third server to be consulted for common command authorization if the first two servers are unavailable.
  - Changed property authzEnabledCommand (object)
    Indicates whether authorization is enabled for command execution on the switch.
  - Changed property authzEnabledExec (object)
    Indicates whether authorization is enabled for exec mode access on the switch.
  - Changed property authzExecFirstServer (object)
    The first server to be consulted for exec mode authorization.
  - Changed property authzExecSecondServer (object)
    The second server to be consulted for exec mode authorization if the first server is unavailable.
  - Changed property authzExecThirdServer (object)
    The third server to be consulted for exec mode authorization if the first two servers are unavailable.

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

Request:

Changed content type : application/json

Changed property acctCommonsFirstServer (object)
First preference for accounting command server.
Changed property acctCommonsLevel (object)
Accounting command privilege level.
Changed property acctCommonsSecondServer (object)
Second preference for accounting command server.
Changed property acctCommonsThirdServer (object)
Third preference for accounting command server.
Changed property acctEnabledCommand (object)
Enable or disable command accounting (default: false).
Changed property acctEnabledExec (object)
Enable or disable exec accounting (default: false).
Changed property acctExecFirstServer (object)
First preference for accounting exec server.
Changed property acctExecSecondServer (object)
Second preference for accounting exec server.
Changed property acctExecThirdServer (object)
Third preference for accounting exec server.
Changed property authnEnabledSsh (object)
Enable or disable SSH authentication (default: true).
Changed property authnFirstPref (object)
First preference for authentication server type.
Changed property authnFourthPref (object)
Fourth preference for authentication server type.
Changed property authnSecondPref (object)
Second preference for authentication server type.
Changed property authnThirdPref (object)
Third preference for authentication server type.
Changed property authzCommonsFirstServer (object)
First preference for authorization command server.
Changed property authzCommonsLevel (object)
Authorization command privilege level.
Changed property authzCommonsSecondServer (object)
Second preference for authorization command server.
Changed property authzCommonsThirdServer (object)
Third preference for authorization command server.
Changed property authzEnabledCommand (object)
Enable or disable command authorization (default: false).
Changed property authzEnabledExec (object)
Enable or disable exec authorization (default: false).
Changed property authzExecFirstServer (object)
First preference for authorization exec server.
Changed property authzExecSecondServer (object)
Second preference for authorization exec server.
Changed property authzExecThirdServer (object)
Third preference for authorization exec server.

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

Changed property acctCommonsFirstServer (object)
First preference for accounting command server.
Changed property acctCommonsLevel (object)
Accounting command privilege level.
Changed property acctCommonsSecondServer (object)
Second preference for accounting command server.
Changed property acctCommonsThirdServer (object)
Third preference for accounting command server.
Changed property acctEnabledCommand (object)
Enable or disable command accounting (default: false).
Changed property acctEnabledExec (object)
Enable or disable exec accounting (default: false).
Changed property acctExecFirstServer (object)
First preference for accounting exec server.
Changed property acctExecSecondServer (object)
Second preference for accounting exec server.
Changed property acctExecThirdServer (object)
Third preference for accounting exec server.
Changed property authnEnabledSsh (object)
Enable or disable SSH authentication (default: true).
Changed property authnFirstPref (object)
First preference for authentication server type.
Changed property authnFourthPref (object)
Fourth preference for authentication server type.
Changed property authnSecondPref (object)
Second preference for authentication server type.
Changed property authnThirdPref (object)
Third preference for authentication server type.
Changed property authzCommonsFirstServer (object)
First preference for authorization command server.
Changed property authzCommonsLevel (object)
Authorization command privilege level.
Changed property authzCommonsSecondServer (object)
Second preference for authorization command server.
Changed property authzCommonsThirdServer (object)
Third preference for authorization command server.
Changed property authzEnabledCommand (object)
Enable or disable command authorization (default: false).
Changed property authzEnabledExec (object)
Enable or disable exec authorization (default: false).
Changed property authzExecFirstServer (object)
First preference for authorization exec server.
Changed property authzExecSecondServer (object)
Second preference for authorization exec server.
Changed property authzExecThirdServer (object)
Third preference for authorization exec server.

Return Type:

Changed response : 400 Bad Request

Bad/malformed request

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 401 Unauthorized

Unauthorized

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 403 Forbidden

Forbidden

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 404 Not Found

Requested resource or related entity not found

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 422 Unprocessable Entity

Validation error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 500 Internal Server Error

Internal Server Error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 200 OK

OK

Changed content type : application/json
- Changed property requestId (object)
  The unique identifier for tracking this API operation request.
- Changed property response (object)
  The empty view representing an API response with no data content, used for operations that return success status without additional information.
Changed content type : application/vnd.ruckus.v1+json
- Changed property requestId (object)
  The unique identifier for tracking this API operation request.
- Changed property response (object)
  The empty view representing an API response with no data content, used for operations that return success status without additional information.

PUT /venues/{venueId}/cliTemplates/{cliTemplateId}

Associate Command Line Interface Templates

Return Type:

Changed response : 400 Bad Request

Bad/malformed request

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 401 Unauthorized

Unauthorized

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 403 Forbidden

Forbidden

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 404 Not Found

Requested resource or related entity not found

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 422 Unprocessable Entity

Validation error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 500 Internal Server Error

Internal Server Error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 202 Accepted

Accepted

Changed content type : application/json
- Changed property requestId (object)
  The unique identifier for tracking this API operation request.
- Changed property response (object)
  The empty view representing an API response with no data content, used for operations that return success status without additional information.
Changed content type : application/vnd.ruckus.v1+json
- Changed property requestId (object)
  The unique identifier for tracking this API operation request.
- Changed property response (object)
  The empty view representing an API response with no data content, used for operations that return success status without additional information.

DELETE /venues/{venueId}/cliTemplates/{cliTemplateId}

Disassociate Command Line Interface Templates

Return Type:

Changed response : 400 Bad Request

Bad/malformed request

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 401 Unauthorized

Unauthorized

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 403 Forbidden

Forbidden

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 404 Not Found

Requested resource or related entity not found

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 422 Unprocessable Entity

Validation error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 500 Internal Server Error

Internal Server Error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 202 Accepted

Accepted

Changed content type : application/json
- Changed property requestId (object)
  The unique identifier for tracking this API operation request.
- Changed property response (object)
  The empty view representing an API response with no data content, used for operations that return success status without additional information.
Changed content type : application/vnd.ruckus.v1+json
- Changed property requestId (object)
  The unique identifier for tracking this API operation request.
- Changed property response (object)
  The empty view representing an API response with no data content, used for operations that return success status without additional information.

POST /venues/{venueId}/configHistories/query

Request:

Changed content type : application/json

Changed property filterByConfigType (object)
Filter configuration history by configuration type.
Changed property limit (object)
Number of records per page (deprecated, use pageSize instead, default: 8).
Changed property page (object)
Page number for pagination.
Changed property pageSize (object)
Number of records per page for the new request format.
Changed property sortField (object)
Field to sort by (currently only supports startTime).
Changed property sortOrder (object)
Sort order (ASC or DESC).
Changed property filters (object)
Schema for filtering configuration history records by criteria.
- Changed property configType (object)
  The type of configuration for filtering results.
- Changed property filterByStatus (object)
  Filter configuration history records by status.
  Added enum values:
  - ALL
  - SUCCESS
  - FAILED
  - NOTIFY_SUCCESS
Changed property sortInfo (object)
Sort information for configuration history query (deprecated format).
- Changed property dir (object)
  Sort direction (ASC or DESC, default: DESC).
- Changed property sortColumn (object)
  Column to sort by (default: startTime).

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

Changed property filterByConfigType (object)
Filter configuration history by configuration type.
Changed property limit (object)
Number of records per page (deprecated, use pageSize instead, default: 8).
Changed property page (object)
Page number for pagination.
Changed property pageSize (object)
Number of records per page for the new request format.
Changed property sortField (object)
Field to sort by (currently only supports startTime).
Changed property sortOrder (object)
Sort order (ASC or DESC).
Changed property filters (object)
Schema for filtering configuration history records by criteria.
- Changed property configType (object)
  The type of configuration for filtering results.
- Changed property filterByStatus (object)
  Filter configuration history records by status.
  Added enum values:
  - ALL
  - SUCCESS
  - FAILED
  - NOTIFY_SUCCESS
Changed property sortInfo (object)
Sort information for configuration history query (deprecated format).
- Changed property dir (object)
  Sort direction (ASC or DESC, default: DESC).
- Changed property sortColumn (object)
  Column to sort by (default: startTime).

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

Changed property filterByConfigType (object)
Filter configuration history by configuration type.
Changed property limit (object)
Number of records per page (deprecated, use pageSize instead, default: 8).
Changed property page (object)
Page number for pagination.
Changed property pageSize (object)
Number of records per page for the new request format.
Changed property sortField (object)
Field to sort by (currently only supports startTime).
Changed property sortOrder (object)
Sort order (ASC or DESC).
Changed property filters (object)
Schema for filtering configuration history records by criteria.
- Changed property configType (object)
  The type of configuration for filtering results.
- Changed property filterByStatus (object)
  Filter configuration history records by status.
  Added enum values:
  - ALL
  - SUCCESS
  - FAILED
  - NOTIFY_SUCCESS
Changed property sortInfo (object)
Sort information for configuration history query (deprecated format).
- Changed property dir (object)
  Sort direction (ASC or DESC, default: DESC).
- Changed property sortColumn (object)
  Column to sort by (default: startTime).

Return Type:

Changed response : 200 OK

OK

Changed content type : application/json
- Changed property id (object)
  The identifier
- Changed property list (object)
  The list of venue level configuration history information records containing aggregated deployment statistics across multiple switches.
- Changed property totalCount (object)
  The total number of configuration history venue records matching the query criteria.
Changed content type : application/vnd.ruckus.v1+json
- Changed property id (object)
  The identifier
- Changed property list (object)
  The list of venue level configuration history information records containing aggregated deployment statistics across multiple switches.
- Changed property totalCount (object)
  The total number of configuration history venue records matching the query criteria.
Changed content type : application/vnd.ruckus.v1.1+json
- Changed property list (object)
  The list of venue level configuration history information records containing aggregated deployment statistics.
- Changed property totalCount (object)
  The total number of venue level configuration history records matching the query criteria.

Changed response : 400 Bad Request

Bad/malformed request

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 401 Unauthorized

Unauthorized

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 403 Forbidden

Forbidden

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 404 Not Found

Requested resource or related entity not found

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 422 Unprocessable Entity

Validation error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 500 Internal Server Error

Internal Server Error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

POST /venues/{venueId}/deviceRequests

Request:

Changed content type : application/json

Changed property deviceRequestAction (object)
The request action to the switches.
Changed property switchIdList (object)
The list of switch id.

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

Changed property deviceRequestAction (object)
The request action to the switches.
Changed property switchIdList (object)
The list of switch id.

Return Type:

Changed response : 400 Bad Request

Bad/malformed request

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 401 Unauthorized

Unauthorized

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 403 Forbidden

Forbidden

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 404 Not Found

Requested resource or related entity not found

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 422 Unprocessable Entity

Validation error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 500 Internal Server Error

Internal Server Error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 202 Accepted

Accepted

Changed content type : application/json
- Changed property requestId (object)
  The unique identifier for tracking this API operation request.
- Changed property response (object)
  The empty view representing an API response with no data content, used for operations that return success status without additional information.
Changed content type : application/vnd.ruckus.v1+json
- Changed property requestId (object)
  The unique identifier for tracking this API operation request.
- Changed property response (object)
  The empty view representing an API response with no data content, used for operations that return success status without additional information.

DELETE /venues/{venueId}/stacks/{stackSwitchSerialNumber}

Return Type:

Changed response : 400 Bad Request

Bad/malformed request

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 401 Unauthorized

Unauthorized

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 403 Forbidden

Forbidden

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 404 Not Found

Requested resource or related entity not found

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 422 Unprocessable Entity

Validation error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 500 Internal Server Error

Internal Server Error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 200 OK

OK

Changed content type : application/json
- Changed property requestId (object)
  The unique identifier for tracking this API operation request.
- Changed property response (object)
  The empty view representing an API response with no data content, used for operations that return success status without additional information.
Changed content type : application/vnd.ruckus.v1+json
- Changed property requestId (object)
  The unique identifier for tracking this API operation request.
- Changed property response (object)
  The empty view representing an API response with no data content, used for operations that return success status without additional information.

PUT /venues/{venueId}/switchFirmwares/schedules

Request:

Changed content type : application/json

Changed property date (object)
The scheduled date for the firmware upgrade operation in string format.
Changed property preDownload (object)
The flag indicating whether to pre download the firmware before the scheduled upgrade time.
Changed property switchIds (object)
The list of switch identifiers to include in the scheduled firmware upgrade.
Changed property time (object)
The scheduled time for the firmware upgrade operation in string format.
Changed property versions (object)
The set of model version pairs specifying target firmware versions for different switch models in this upgrade schedule.

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

Changed property date (object)
The scheduled date for the firmware upgrade operation in string format.
Changed property preDownload (object)
The flag indicating whether to pre download the firmware before the scheduled upgrade time.
Changed property switchIds (object)
The list of switch identifiers to include in the scheduled firmware upgrade.
Changed property time (object)
The scheduled time for the firmware upgrade operation in string format.
Changed property versions (object)
The set of model version pairs specifying target firmware versions for different switch models in this upgrade schedule.

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

Changed property date (object)
The scheduled date for the firmware upgrade operation in string format.
Changed property preDownload (object)
The flag indicating whether to pre download the firmware before the scheduled upgrade time.
Changed property switchIds (object)
The list of switch identifiers to include in the scheduled firmware upgrade.
Changed property time (object)
The scheduled time for the firmware upgrade operation in string format.
Changed property versions (object)
The set of model version pairs specifying target firmware versions for different switch models in this upgrade schedule.

Return Type:

Changed response : 400 Bad Request

Bad/malformed request

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 401 Unauthorized

Unauthorized

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 403 Forbidden

Forbidden

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 404 Not Found

Requested resource or related entity not found

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 422 Unprocessable Entity

Validation error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 500 Internal Server Error

Internal Server Error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 200 OK

OK

Changed content type : application/json
- Changed property requestId (object)
  The unique identifier for tracking this API operation request.
- Changed property response (object)
  The empty view representing an API response with no data content, used for operations that return success status without additional information.
Changed content type : application/vnd.ruckus.v1+json
- Changed property requestId (object)
  The unique identifier for tracking this API operation request.
- Changed property response (object)
  The empty view representing an API response with no data content, used for operations that return success status without additional information.
Changed content type : application/vnd.ruckus.v1.1+json
- Changed property requestId (object)
  The unique identifier for tracking this API operation request.
- Changed property response (object)
  The empty view representing an API response with no data content, used for operations that return success status without additional information.

POST /venues/{venueId}/switchFirmwares/schedules

Request:

Changed content type : application/json

Changed property date (object)
The scheduled date for the firmware upgrade operation in string format.
Changed property preDownload (object)
The flag indicating whether to pre download the firmware before the scheduled upgrade time.
Changed property switchIds (object)
The list of switch identifiers to include in the scheduled firmware upgrade.
Changed property switchVersion (object)
The target firmware version for switches with version 10 or below.
Changed property switchVersionAboveTen (object)
The target firmware version for switches with version above 10.
Changed property time (object)
The scheduled time for the firmware upgrade operation in string format.

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

Changed property date (object)
The scheduled date for the firmware upgrade operation in string format.
Changed property preDownload (object)
The flag indicating whether to pre download the firmware before the scheduled upgrade time.
Changed property switchIds (object)
The list of switch identifiers to include in the scheduled firmware upgrade.
Changed property switchVersion (object)
The target firmware version for switches with version 10 or below.
Changed property switchVersionAboveTen (object)
The target firmware version for switches with version above 10.
Changed property time (object)
The scheduled time for the firmware upgrade operation in string format.

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

Changed property date (object)
The scheduled date for the firmware upgrade operation in string format.
Changed property preDownload (object)
The flag indicating whether to pre download the firmware before the scheduled upgrade time.
Changed property switchIds (object)
The list of switch identifiers to include in the scheduled firmware upgrade.
Changed property time (object)
The scheduled time for the firmware upgrade operation in string format.
Changed property versions (object)
The set of model version pairs specifying target firmware versions for different switch models in this upgrade schedule.

Return Type:

Changed response : 400 Bad Request

Bad/malformed request

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 401 Unauthorized

Unauthorized

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 403 Forbidden

Forbidden

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 404 Not Found

Requested resource or related entity not found

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 422 Unprocessable Entity

Validation error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 500 Internal Server Error

Internal Server Error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 201 Created

Created

Changed content type : application/json
- Changed property requestId (object)
  The unique identifier for tracking this API operation request.
- Changed property response (object)
  The empty view representing an API response with no data content, used for operations that return success status without additional information.
Changed content type : application/vnd.ruckus.v1+json
- Changed property requestId (object)
  The unique identifier for tracking this API operation request.
- Changed property response (object)
  The empty view representing an API response with no data content, used for operations that return success status without additional information.
Changed content type : application/vnd.ruckus.v1.1+json
- Changed property requestId (object)
  The unique identifier for tracking this API operation request.
- Changed property response (object)
  The empty view representing an API response with no data content, used for operations that return success status without additional information.

DELETE /venues/{venueId}/switchFirmwares/schedules

Request:

Changed content type : application/json

Changed property switchIds (object)
The list of switch identifiers for which the scheduled firmware upgrade should be skipped or postponed.

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

Changed property switchIds (object)
The list of switch identifiers for which the scheduled firmware upgrade should be skipped or postponed.

Return Type:

Changed response : 400 Bad Request

Bad/malformed request

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 401 Unauthorized

Unauthorized

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 403 Forbidden

Forbidden

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 404 Not Found

Requested resource or related entity not found

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 422 Unprocessable Entity

Validation error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 500 Internal Server Error

Internal Server Error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 200 OK

OK

Changed content type : application/json
- Changed property requestId (object)
  The unique identifier for tracking this API operation request.
- Changed property response (object)
  The empty view representing an API response with no data content, used for operations that return success status without additional information.
Changed content type : application/vnd.ruckus.v1+json
- Changed property requestId (object)
  The unique identifier for tracking this API operation request.
- Changed property response (object)
  The empty view representing an API response with no data content, used for operations that return success status without additional information.

GET /venues/{venueId}/switchProfiles

Return Type:

Changed response : 400 Bad Request

Bad/malformed request

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 401 Unauthorized

Unauthorized

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 403 Forbidden

Forbidden

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 404 Not Found

Requested resource or related entity not found

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 422 Unprocessable Entity

Validation error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 500 Internal Server Error

Internal Server Error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 200 OK

OK

Changed content type : application/json
- Changed property acls (object)
  The set of Access Control List configurations included in this profile for traffic filtering.
- Changed property applyOnboardOnly (object)
  The flag indicating whether this profile should only be applied during switch onboarding.
- Changed property description (object)
  The detailed description explaining the purpose and contents of this configuration profile.
- Changed property id (object)
  The identifier
- Changed property name (object)
  The name of the configuration profile for identification and reference.
- Changed property profileType (object)
  The type of profile indicating its scope: global, venue specific, or template based.
- Changed property templateId (object)
  The identifier of the profile template used as the basis for this profile configuration.
- Changed property templateVersion (object)
  The version number of the profile template.
- Changed property trustedPorts (object)
  The set of trusted port configurations for DHCP snooping and ARP inspection security features.
- Changed property venueCount (object)
  The total number of venues where this profile is currently deployed.
- Changed property venues (object)
  The set of venue identifiers where this profile is deployed or available for use.
- Changed property vlans (object)
  The ordered set of VLAN configurations included in this profile with layer 2 security features.
- Changed property voiceVlanConfigs (object)
  The set of voice VLAN configurations for VoIP traffic prioritization across different switch models.
- Changed property venueCliTemplate (object)
  The venue CLI template view, representing CLI templates configured at the venue level for managing switch configurations across multiple devices.
  - Changed property cli (object)
    The CLI command template content containing switch configuration commands and variable placeholders.
  - Changed property id (object)
    The identifier
  - Changed property name (object)
    The unique name identifier for this venue CLI template.
  - Changed property overwrite (object)
    Indicates whether this venue CLI template should overwrite existing configurations when applied to switches.
  - Changed property switchModels (object)
    The switch model identifiers that this venue CLI template supports, defining which hardware models are compatible.
  - Changed property variables (object)
    The set of variables defined in this venue CLI template for dynamic configuration value substitution.
Changed content type : application/vnd.ruckus.v1+json
- Changed property acls (object)
  The set of Access Control List configurations included in this profile for traffic filtering.
- Changed property applyOnboardOnly (object)
  The flag indicating whether this profile should only be applied during switch onboarding.
- Changed property description (object)
  The detailed description explaining the purpose and contents of this configuration profile.
- Changed property id (object)
  The identifier
- Changed property name (object)
  The name of the configuration profile for identification and reference.
- Changed property profileType (object)
  The type of profile indicating its scope: global, venue specific, or template based.
- Changed property templateId (object)
  The identifier of the profile template used as the basis for this profile configuration.
- Changed property templateVersion (object)
  The version number of the profile template.
- Changed property trustedPorts (object)
  The set of trusted port configurations for DHCP snooping and ARP inspection security features.
- Changed property venueCount (object)
  The total number of venues where this profile is currently deployed.
- Changed property venues (object)
  The set of venue identifiers where this profile is deployed or available for use.
- Changed property vlans (object)
  The ordered set of VLAN configurations included in this profile with layer 2 security features.
- Changed property voiceVlanConfigs (object)
  The set of voice VLAN configurations for VoIP traffic prioritization across different switch models.
- Changed property venueCliTemplate (object)
  The venue CLI template view, representing CLI templates configured at the venue level for managing switch configurations across multiple devices.
  - Changed property cli (object)
    The CLI command template content containing switch configuration commands and variable placeholders.
  - Changed property id (object)
    The identifier
  - Changed property name (object)
    The unique name identifier for this venue CLI template.
  - Changed property overwrite (object)
    Indicates whether this venue CLI template should overwrite existing configurations when applied to switches.
  - Changed property switchModels (object)
    The switch model identifiers that this venue CLI template supports, defining which hardware models are compatible.
  - Changed property variables (object)
    The set of variables defined in this venue CLI template for dynamic configuration value substitution.

PUT /venues/{venueId}/switchProfiles/{switchProfileId}

Return Type:

Changed response : 400 Bad Request

Bad/malformed request

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 401 Unauthorized

Unauthorized

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 403 Forbidden

Forbidden

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 404 Not Found

Requested resource or related entity not found

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 422 Unprocessable Entity

Validation error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 500 Internal Server Error

Internal Server Error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 202 Accepted

Accepted

Changed content type : application/json
- Changed property requestId (object)
  The unique identifier for tracking this API operation request.
- Changed property response (object)
  The empty view representing an API response with no data content, used for operations that return success status without additional information.
Changed content type : application/vnd.ruckus.v1+json
- Changed property requestId (object)
  The unique identifier for tracking this API operation request.
- Changed property response (object)
  The empty view representing an API response with no data content, used for operations that return success status without additional information.

DELETE /venues/{venueId}/switchProfiles/{switchProfileId}

Return Type:

Changed response : 400 Bad Request

Bad/malformed request

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 401 Unauthorized

Unauthorized

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 403 Forbidden

Forbidden

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 404 Not Found

Requested resource or related entity not found

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 422 Unprocessable Entity

Validation error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 500 Internal Server Error

Internal Server Error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 202 Accepted

Accepted

Changed content type : application/json
- Changed property requestId (object)
  The unique identifier for tracking this API operation request.
- Changed property response (object)
  The empty view representing an API response with no data content, used for operations that return success status without additional information.
Changed content type : application/vnd.ruckus.v1+json
- Changed property requestId (object)
  The unique identifier for tracking this API operation request.
- Changed property response (object)
  The empty view representing an API response with no data content, used for operations that return success status without additional information.

GET /venues/{venueId}/switchSettings

Return Type:

Changed response : 200 OK

OK

Changed content type : application/json
- Changed property cliApplied (object)
  The flag indicating whether CLI templates have been applied to switches in this venue.
- Changed property dns (object)
  The list of DNS server IP addresses configured for name resolution at the venue level.
- Changed property id (object)
  The identifier
- Changed property name (object)
  The name of the venue representing a physical location or site in the network infrastructure.
- Changed property profileId (object)
  The set of profile identifiers associated with this venue for switch configuration management.
- Changed property switchCliProfileIds (object)
  The set of CLI profile identifiers applied to switches in this venue.
- Changed property switchLoginPassword (object)
  The password credential for logging into switches in this venue.
- Changed property switchLoginUsername (object)
  The username credential for logging into switches in this venue.
- Changed property switchProfileIds (object)
  The set of switch specific profile identifiers applied to switches in this venue.
- Changed property syslogEnabled (object)
  The flag indicating whether syslog forwarding is enabled for centralized logging of venue switches.
- Changed property syslogPrimaryServer (object)
  The IP address of the primary syslog server for receiving log messages from switches in this venue.
- Changed property syslogSecondaryServer (object)
  The IP address of the secondary syslog server for redundant log message reception.
Changed content type : application/vnd.ruckus.v1+json
- Changed property cliApplied (object)
  The flag indicating whether CLI templates have been applied to switches in this venue.
- Changed property dns (object)
  The list of DNS server IP addresses configured for name resolution at the venue level.
- Changed property id (object)
  The identifier
- Changed property name (object)
  The name of the venue representing a physical location or site in the network infrastructure.
- Changed property profileId (object)
  The set of profile identifiers associated with this venue for switch configuration management.
- Changed property switchCliProfileIds (object)
  The set of CLI profile identifiers applied to switches in this venue.
- Changed property switchLoginPassword (object)
  The password credential for logging into switches in this venue.
- Changed property switchLoginUsername (object)
  The username credential for logging into switches in this venue.
- Changed property switchProfileIds (object)
  The set of switch specific profile identifiers applied to switches in this venue.
- Changed property syslogEnabled (object)
  The flag indicating whether syslog forwarding is enabled for centralized logging of venue switches.
- Changed property syslogPrimaryServer (object)
  The IP address of the primary syslog server for receiving log messages from switches in this venue.
- Changed property syslogSecondaryServer (object)
  The IP address of the secondary syslog server for redundant log message reception.
Changed content type : application/vnd.ruckus.v1.1+json
- Changed property cliApplied (object)
  The flag indicating whether CLI templates have been applied to switches in this venue.
- Changed property dns (object)
  The list of DNS server IP addresses configured for name resolution at the venue level.
- Changed property name (object)
  The name of the venue representing a physical location or site in the network infrastructure.
- Changed property profileId (object)
  The set of profile identifiers associated with this venue for switch configuration management.
- Changed property syslogEnabled (object)
  The flag indicating whether syslog forwarding is enabled for centralized logging of venue switches.
- Changed property syslogPrimaryServer (object)
  The IP address of the primary syslog server for receiving log messages from switches in this venue.
- Changed property syslogSecondaryServer (object)
  The IP address of the secondary syslog server for redundant log message reception.

Changed response : 400 Bad Request

Bad/malformed request

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 401 Unauthorized

Unauthorized

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 403 Forbidden

Forbidden

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 404 Not Found

Requested resource or related entity not found

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 422 Unprocessable Entity

Validation error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 500 Internal Server Error

Internal Server Error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

PUT /venues/{venueId}/switchSettings

Request:

Changed content type : application/json

Changed property dns (object)
List of DNS server IP addresses for switches in this venue.
Changed property id (object)
Unique identifier for the venue.
Changed property profileId (object)
List of profile identifiers to be associated with this venue.
Changed property syslogEnabled (object)
Enable syslog for centralized logging (default: false).
Changed property syslogPrimaryServer (object)
Primary syslog server IP address or hostname.
Changed property syslogSecondaryServer (object)
Secondary syslog server IP address or hostname for redundancy.

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

Changed property dns (object)
List of DNS server IP addresses for switches in this venue.
Changed property id (object)
Unique identifier for the venue.
Changed property profileId (object)
List of profile identifiers to be associated with this venue.
Changed property syslogEnabled (object)
Enable syslog for centralized logging (default: false).
Changed property syslogPrimaryServer (object)
Primary syslog server IP address or hostname.
Changed property syslogSecondaryServer (object)
Secondary syslog server IP address or hostname for redundancy.

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

Changed property dns (object)
List of DNS server IP addresses for switches in this venue.
Changed property profileId (object)
Set of profile identifiers associated with this venue.
Changed property syslogEnabled (object)
Enable syslog for centralized logging of switches in this venue (default: false).
Changed property syslogPrimaryServer (object)
Primary syslog server IP address or hostname.
Changed property syslogSecondaryServer (object)
Secondary syslog server IP address or hostname for redundancy.

Return Type:

Changed response : 400 Bad Request

Bad/malformed request

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 401 Unauthorized

Unauthorized

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 403 Forbidden

Forbidden

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 404 Not Found

Requested resource or related entity not found

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 422 Unprocessable Entity

Validation error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 500 Internal Server Error

Internal Server Error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 200 OK

OK

Changed content type : application/json
- Changed property cliApplied (object)
  The flag indicating whether CLI templates have been applied to switches in this venue.
- Changed property dns (object)
  The list of DNS server IP addresses configured for name resolution at the venue level.
- Changed property id (object)
  The identifier
- Changed property name (object)
  The name of the venue representing a physical location or site in the network infrastructure.
- Changed property profileId (object)
  The set of profile identifiers associated with this venue for switch configuration management.
- Changed property switchCliProfileIds (object)
  The set of CLI profile identifiers applied to switches in this venue.
- Changed property switchLoginPassword (object)
  The password credential for logging into switches in this venue.
- Changed property switchLoginUsername (object)
  The username credential for logging into switches in this venue.
- Changed property switchProfileIds (object)
  The set of switch specific profile identifiers applied to switches in this venue.
- Changed property syslogEnabled (object)
  The flag indicating whether syslog forwarding is enabled for centralized logging of venue switches.
- Changed property syslogPrimaryServer (object)
  The IP address of the primary syslog server for receiving log messages from switches in this venue.
- Changed property syslogSecondaryServer (object)
  The IP address of the secondary syslog server for redundant log message reception.
Changed content type : application/vnd.ruckus.v1+json
- Changed property cliApplied (object)
  The flag indicating whether CLI templates have been applied to switches in this venue.
- Changed property dns (object)
  The list of DNS server IP addresses configured for name resolution at the venue level.
- Changed property id (object)
  The identifier
- Changed property name (object)
  The name of the venue representing a physical location or site in the network infrastructure.
- Changed property profileId (object)
  The set of profile identifiers associated with this venue for switch configuration management.
- Changed property switchCliProfileIds (object)
  The set of CLI profile identifiers applied to switches in this venue.
- Changed property switchLoginPassword (object)
  The password credential for logging into switches in this venue.
- Changed property switchLoginUsername (object)
  The username credential for logging into switches in this venue.
- Changed property switchProfileIds (object)
  The set of switch specific profile identifiers applied to switches in this venue.
- Changed property syslogEnabled (object)
  The flag indicating whether syslog forwarding is enabled for centralized logging of venue switches.
- Changed property syslogPrimaryServer (object)
  The IP address of the primary syslog server for receiving log messages from switches in this venue.
- Changed property syslogSecondaryServer (object)
  The IP address of the secondary syslog server for redundant log message reception.
Changed content type : application/vnd.ruckus.v1.1+json
- Changed property requestId (object)
  The unique identifier for tracking this API operation request.
- Changed property response (object)
  The venue view, representing a physical location or site with associated switches, profiles, and network configurations.
  - Changed property cliApplied (object)
    The flag indicating whether CLI templates have been applied to switches in this venue.
  - Changed property dns (object)
    The list of DNS server IP addresses configured for name resolution at the venue level.
  - Changed property name (object)
    The name of the venue representing a physical location or site in the network infrastructure.
  - Changed property profileId (object)
    The set of profile identifiers associated with this venue for switch configuration management.
  - Changed property syslogEnabled (object)
    The flag indicating whether syslog forwarding is enabled for centralized logging of venue switches.
  - Changed property syslogPrimaryServer (object)
    The IP address of the primary syslog server for receiving log messages from switches in this venue.
  - Changed property syslogSecondaryServer (object)
    The IP address of the secondary syslog server for redundant log message reception.

DELETE /venues/{venueId}/switchSettings

Return Type:

Changed response : 400 Bad Request

Bad/malformed request

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 401 Unauthorized

Unauthorized

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 403 Forbidden

Forbidden

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 404 Not Found

Requested resource or related entity not found

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 422 Unprocessable Entity

Validation error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 500 Internal Server Error

Internal Server Error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 200 OK

OK

Changed content type : application/json
- Changed property requestId (object)
  The unique identifier for tracking this API operation request.
- Changed property response (object)
  The result of the operation.
  - Changed property id (object)
    The identifier

GET /venues/{venueId}/switches

Return Type:

Changed response : 400 Bad Request

Bad/malformed request

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 401 Unauthorized

Unauthorized

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 403 Forbidden

Forbidden

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 404 Not Found

Requested resource or related entity not found

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 422 Unprocessable Entity

Validation error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 500 Internal Server Error

Internal Server Error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 200 OK

OK

Changed content type : application/json
- Changed property defaultGateway (object)
  The default gateway IP address for routing traffic from the switch management interface.
- Changed property description (object)
  The descriptive text providing additional information about the switch configuration or purpose.
- Changed property dhcpClientEnabled (object)
  The flag indicating whether the switch is configured as a DHCP client to obtain its management IP address.
- Changed property dhcpServerEnabled (object)
  The flag indicating whether the DHCP server feature is enabled on the switch.
- Changed property enableStack (object)
  The flag indicating whether switch stacking is enabled for combining multiple physical switches into a single logical unit.
- Changed property firmwareVersion (object)
  The current firmware version running on the switch.
- Changed property id (object)
  The identifier
- Changed property igmpSnooping (object)
  The IGMP snooping mode for multicast traffic optimization: enabled, disabled, or default.
- Changed property initialVlanId (object)
  The VLAN ID used for initial switch configuration and management access.
- Changed property ipAddress (object)
  The IPv4 address assigned to the switch management interface.
- Changed property ipAddressInterface (object)
  The specific interface identifier for the management IP address configuration.
- Changed property ipAddressInterfaceType (object)
  The interface type for the switch management IP address: VLAN interface or management port.
- Changed property ipAddressType (object)
  The IP address assignment method: static or DHCP.
- Changed property jumboMode (object)
  The flag indicating whether jumbo frame support is enabled, allowing frames larger than 1518 bytes.
- Changed property lastDataSyncTime (object)
  The timestamp in milliseconds when the last data synchronization completed for this switch.
- Changed property lastDataSyncTriggerTime (object)
  The timestamp in milliseconds when the last data synchronization was triggered for this switch.
- Changed property name (object)
  The name assigned to the ICX switch for identification in the network.
- Changed property previousMembers (object)
  The set of serial numbers for previous stack members that have been removed from the stack.
- Changed property rearModule (object)
  The model identifier of the rear expansion module installed on the switch, if applicable.
- Changed property softDeletedDate (object)
  The timestamp when the switch was soft deleted, allowing for recovery before permanent deletion.
- Changed property spanningTreePriority (object)
  The STP (Spanning Tree Protocol) bridge priority value, used in root bridge election (lower values have higher priority).
- Changed property specifiedType (object)
  The firmware image type specified for the switch: primary, secondary, or boot.
- Changed property stackConfigTimestamp (object)
  The timestamp indicating when the stack configuration was last modified.
- Changed property stackMembers (object)
  The list of member switches in a stack configuration, including their models and active status.
- Changed property subnetMask (object)
  The subnet mask for the switch management IP address.
- Changed property syncDataEndTime (object)
  The timestamp in milliseconds when the current data synchronization operation ended.
- Changed property syncDataId (object)
  The unique identifier for the current data synchronization operation.
- Changed property syncDataStartTime (object)
  The timestamp in milliseconds when the current data synchronization operation started.
- Changed property tags (object)
  The comma separated list of custom tags assigned to this switch for organization and filtering.
- Changed property trustPorts (object)
  The list of port identifiers configured as trusted ports for DHCP snooping and ARP inspection.
- Changed property venueId (object)
  The unique identifier of the venue where the switch is located.
- Changed property vlanCustomize (object)
  The flag indicating whether VLAN configurations have been customized from default settings.
- Changed property position (object)
  The switch position view, representing the physical location of a switch on a floor plan with x and y coordinates as percentages.
  - Added property xPercent (object)
    The horizontal position of the switch on the floor plan as a percentage of the total width.
  - Added property yPercent (object)
    The vertical position of the switch on the floor plan as a percentage of the total height.
  - Deleted property xpercent (object)
  - Deleted property ypercent (object)
  - Changed property floorplanId (object)
    The identifier of the floor plan where this switch is located.
  - Changed property id (object)
    The identifier
Changed content type : application/vnd.ruckus.v1+json
- Changed property defaultGateway (object)
  The default gateway IP address for routing traffic from the switch management interface.
- Changed property description (object)
  The descriptive text providing additional information about the switch configuration or purpose.
- Changed property dhcpClientEnabled (object)
  The flag indicating whether the switch is configured as a DHCP client to obtain its management IP address.
- Changed property dhcpServerEnabled (object)
  The flag indicating whether the DHCP server feature is enabled on the switch.
- Changed property enableStack (object)
  The flag indicating whether switch stacking is enabled for combining multiple physical switches into a single logical unit.
- Changed property firmwareVersion (object)
  The current firmware version running on the switch.
- Changed property id (object)
  The identifier
- Changed property igmpSnooping (object)
  The IGMP snooping mode for multicast traffic optimization: enabled, disabled, or default.
- Changed property initialVlanId (object)
  The VLAN ID used for initial switch configuration and management access.
- Changed property ipAddress (object)
  The IPv4 address assigned to the switch management interface.
- Changed property ipAddressInterface (object)
  The specific interface identifier for the management IP address configuration.
- Changed property ipAddressInterfaceType (object)
  The interface type for the switch management IP address: VLAN interface or management port.
- Changed property ipAddressType (object)
  The IP address assignment method: static or DHCP.
- Changed property jumboMode (object)
  The flag indicating whether jumbo frame support is enabled, allowing frames larger than 1518 bytes.
- Changed property lastDataSyncTime (object)
  The timestamp in milliseconds when the last data synchronization completed for this switch.
- Changed property lastDataSyncTriggerTime (object)
  The timestamp in milliseconds when the last data synchronization was triggered for this switch.
- Changed property name (object)
  The name assigned to the ICX switch for identification in the network.
- Changed property previousMembers (object)
  The set of serial numbers for previous stack members that have been removed from the stack.
- Changed property rearModule (object)
  The model identifier of the rear expansion module installed on the switch, if applicable.
- Changed property softDeletedDate (object)
  The timestamp when the switch was soft deleted, allowing for recovery before permanent deletion.
- Changed property spanningTreePriority (object)
  The STP (Spanning Tree Protocol) bridge priority value, used in root bridge election (lower values have higher priority).
- Changed property specifiedType (object)
  The firmware image type specified for the switch: primary, secondary, or boot.
- Changed property stackConfigTimestamp (object)
  The timestamp indicating when the stack configuration was last modified.
- Changed property stackMembers (object)
  The list of member switches in a stack configuration, including their models and active status.
- Changed property subnetMask (object)
  The subnet mask for the switch management IP address.
- Changed property syncDataEndTime (object)
  The timestamp in milliseconds when the current data synchronization operation ended.
- Changed property syncDataId (object)
  The unique identifier for the current data synchronization operation.
- Changed property syncDataStartTime (object)
  The timestamp in milliseconds when the current data synchronization operation started.
- Changed property tags (object)
  The comma separated list of custom tags assigned to this switch for organization and filtering.
- Changed property trustPorts (object)
  The list of port identifiers configured as trusted ports for DHCP snooping and ARP inspection.
- Changed property venueId (object)
  The unique identifier of the venue where the switch is located.
- Changed property vlanCustomize (object)
  The flag indicating whether VLAN configurations have been customized from default settings.
- Changed property position (object)
  The switch position view, representing the physical location of a switch on a floor plan with x and y coordinates as percentages.
  - Added property xPercent (object)
    The horizontal position of the switch on the floor plan as a percentage of the total width.
  - Added property yPercent (object)
    The vertical position of the switch on the floor plan as a percentage of the total height.
  - Deleted property xpercent (object)
  - Deleted property ypercent (object)
  - Changed property floorplanId (object)
    The identifier of the floor plan where this switch is located.
  - Changed property id (object)
    The identifier

POST /venues/{venueId}/switches

Return Type:

Changed response : 400 Bad Request

Bad/malformed request

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 401 Unauthorized

Unauthorized

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 403 Forbidden

Forbidden

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 404 Not Found

Requested resource or related entity not found

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 422 Unprocessable Entity

Validation error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 500 Internal Server Error

Internal Server Error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 202 Accepted

Accepted

Changed content type : application/json
- Changed property requestId (object)
  The unique identifier for tracking this API operation request.
- Changed property response (object)
  The empty view representing an API response with no data content, used for operations that return success status without additional information.
Changed content type : application/vnd.ruckus.v1+json
- Changed property requestId (object)
  The unique identifier for tracking this API operation request.
- Changed property response (object)
  The empty view representing an API response with no data content, used for operations that return success status without additional information.

DELETE /venues/{venueId}/switches

Return Type:

Changed response : 400 Bad Request

Bad/malformed request

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 401 Unauthorized

Unauthorized

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 403 Forbidden

Forbidden

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 404 Not Found

Requested resource or related entity not found

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 422 Unprocessable Entity

Validation error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 500 Internal Server Error

Internal Server Error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 202 Accepted

Accepted

Changed content type : application/json
- Changed property requestId (object)
  The unique identifier for tracking this API operation request.
- Changed property response (object)
  The empty view representing an API response with no data content, used for operations that return success status without additional information.
Changed content type : application/vnd.ruckus.v1+json
- Changed property requestId (object)
  The unique identifier for tracking this API operation request.
- Changed property response (object)
  The empty view representing an API response with no data content, used for operations that return success status without additional information.

POST /venues/{venueId}/switches/importRequests

Return Type:

Changed response : 400 Bad Request

Bad/malformed request

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 401 Unauthorized

Unauthorized

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 403 Forbidden

Forbidden

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 404 Not Found

Requested resource or related entity not found

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 422 Unprocessable Entity

Validation error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 500 Internal Server Error

Internal Server Error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 202 Accepted

Accepted

Changed content type : application/json
- Changed property requestId (object)
  The unique identifier for tracking this API operation request.
- Changed property response (object)
  The empty view representing an API response with no data content, used for operations that return success status without additional information.
Changed content type : application/vnd.ruckus.v1+json
- Changed property requestId (object)
  The unique identifier for tracking this API operation request.
- Changed property response (object)
  The empty view representing an API response with no data content, used for operations that return success status without additional information.

POST /venues/{venueId}/switches/powerCycleRequests

Return Type:

Changed response : 400 Bad Request

Bad/malformed request

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 401 Unauthorized

Unauthorized

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 403 Forbidden

Forbidden

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 404 Not Found

Requested resource or related entity not found

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 422 Unprocessable Entity

Validation error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 500 Internal Server Error

Internal Server Error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 200 OK

OK

Changed content type : application/json
- Changed property requestId (object)
  The unique identifier for tracking this API operation request.
- Changed property response (object)
  The empty view representing an API response with no data content, used for operations that return success status without additional information.
Changed content type : application/vnd.ruckus.v1+json
- Changed property requestId (object)
  The unique identifier for tracking this API operation request.
- Changed property response (object)
  The empty view representing an API response with no data content, used for operations that return success status without additional information.

GET /venues/{venueId}/switches/{switchId}

Return Type:

Changed response : 200 OK

OK

Changed content type : application/json
- Added property StackMembers_V1_1 (object)
  The list of member switches in a stack configuration, including their models and active status.
- Deleted property stackMembers (object)
- Changed property defaultGateway (object)
  The default gateway IP address for routing traffic from the switch management interface.
- Changed property description (object)
  The descriptive text providing additional information about the switch configuration or purpose.
- Changed property dhcpClientEnabled (object)
  The flag indicating whether the switch is configured as a DHCP client to obtain its management IP address.
- Changed property dhcpServerEnabled (object)
  The flag indicating whether the DHCP server feature is enabled on the switch.
- Changed property enableStack (object)
  The flag indicating whether switch stacking is enabled for combining multiple physical switches into a single logical unit.
- Changed property igmpSnooping (object)
  The IGMP snooping mode for multicast traffic optimization: enabled, disabled, or default.
- Changed property initialVlanId (object)
  The VLAN ID used for initial switch configuration and management access.
- Changed property ipAddress (object)
  The IPv4 address assigned to the switch management interface.
- Changed property ipAddressInterface (object)
  The specific interface identifier for the management IP address configuration.
- Changed property ipAddressInterfaceType (object)
  The interface type for the switch management IP address: VLAN interface or management port.
- Changed property ipAddressType (object)
  The IP address assignment method: static or DHCP.
- Changed property jumboMode (object)
  The flag indicating whether jumbo frame support is enabled, allowing frames larger than 1518 bytes.
- Changed property name (object)
  The name assigned to the ICX switch for identification in the network.
- Changed property rearModule (object)
  The model identifier of the rear expansion module installed on the switch, if applicable.
- Changed property spanningTreePriority (object)
  The STP (Spanning Tree Protocol) bridge priority value, used in root bridge election (lower values have higher priority).
- Changed property specifiedType (object)
  The firmware image type specified for the switch: primary, secondary, or boot.
- Changed property subnetMask (object)
  The subnet mask for the switch management IP address.
- Changed property vlanCustomize (object)
  The flag indicating whether VLAN configurations have been customized from default settings.
Changed content type : application/vnd.ruckus.v1+json
- Added property StackMembers_V1_1 (object)
  The list of member switches in a stack configuration, including their models and active status.
- Deleted property stackMembers (object)
- Changed property defaultGateway (object)
  The default gateway IP address for routing traffic from the switch management interface.
- Changed property description (object)
  The descriptive text providing additional information about the switch configuration or purpose.
- Changed property dhcpClientEnabled (object)
  The flag indicating whether the switch is configured as a DHCP client to obtain its management IP address.
- Changed property dhcpServerEnabled (object)
  The flag indicating whether the DHCP server feature is enabled on the switch.
- Changed property enableStack (object)
  The flag indicating whether switch stacking is enabled for combining multiple physical switches into a single logical unit.
- Changed property igmpSnooping (object)
  The IGMP snooping mode for multicast traffic optimization: enabled, disabled, or default.
- Changed property initialVlanId (object)
  The VLAN ID used for initial switch configuration and management access.
- Changed property ipAddress (object)
  The IPv4 address assigned to the switch management interface.
- Changed property ipAddressInterface (object)
  The specific interface identifier for the management IP address configuration.
- Changed property ipAddressInterfaceType (object)
  The interface type for the switch management IP address: VLAN interface or management port.
- Changed property ipAddressType (object)
  The IP address assignment method: static or DHCP.
- Changed property jumboMode (object)
  The flag indicating whether jumbo frame support is enabled, allowing frames larger than 1518 bytes.
- Changed property name (object)
  The name assigned to the ICX switch for identification in the network.
- Changed property rearModule (object)
  The model identifier of the rear expansion module installed on the switch, if applicable.
- Changed property spanningTreePriority (object)
  The STP (Spanning Tree Protocol) bridge priority value, used in root bridge election (lower values have higher priority).
- Changed property specifiedType (object)
  The firmware image type specified for the switch: primary, secondary, or boot.
- Changed property subnetMask (object)
  The subnet mask for the switch management IP address.
- Changed property vlanCustomize (object)
  The flag indicating whether VLAN configurations have been customized from default settings.

Changed response : 400 Bad Request

Bad/malformed request

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 401 Unauthorized

Unauthorized

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 403 Forbidden

Forbidden

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 404 Not Found

Requested resource or related entity not found

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 422 Unprocessable Entity

Validation error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 500 Internal Server Error

Internal Server Error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

PUT /venues/{venueId}/switches/{switchId}

Request:

Changed content type : application/json

Added property StackMembers_V1_1 (object)
The list of member switches in a stack configuration, including their models and active status.
Deleted property stackMembers (object)
Changed property defaultGateway (object)
The default gateway IP address for routing traffic from the switch management interface.
Changed property description (object)
The descriptive text providing additional information about the switch configuration or purpose.
Changed property dhcpClientEnabled (object)
The flag indicating whether the switch is configured as a DHCP client to obtain its management IP address.
Changed property dhcpServerEnabled (object)
The flag indicating whether the DHCP server feature is enabled on the switch.
Changed property enableStack (object)
The flag indicating whether switch stacking is enabled for combining multiple physical switches into a single logical unit.
Changed property igmpSnooping (object)
The IGMP snooping mode for multicast traffic optimization: enabled, disabled, or default.
Changed property initialVlanId (object)
The VLAN ID used for initial switch configuration and management access.
Changed property ipAddress (object)
The IPv4 address assigned to the switch management interface.
Changed property ipAddressInterface (object)
The specific interface identifier for the management IP address configuration.
Changed property ipAddressInterfaceType (object)
The interface type for the switch management IP address: VLAN interface or management port.
Changed property ipAddressType (object)
The IP address assignment method: static or DHCP.
Changed property jumboMode (object)
The flag indicating whether jumbo frame support is enabled, allowing frames larger than 1518 bytes.
Changed property name (object)
The name assigned to the ICX switch for identification in the network.
Changed property rearModule (object)
The model identifier of the rear expansion module installed on the switch, if applicable.
Changed property spanningTreePriority (object)
The STP (Spanning Tree Protocol) bridge priority value, used in root bridge election (lower values have higher priority).
Changed property specifiedType (object)
The firmware image type specified for the switch: primary, secondary, or boot.
Changed property subnetMask (object)
The subnet mask for the switch management IP address.
Changed property vlanCustomize (object)
The flag indicating whether VLAN configurations have been customized from default settings.

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

Added property StackMembers_V1_1 (object)
The list of member switches in a stack configuration, including their models and active status.
Deleted property stackMembers (object)
Changed property defaultGateway (object)
The default gateway IP address for routing traffic from the switch management interface.
Changed property description (object)
The descriptive text providing additional information about the switch configuration or purpose.
Changed property dhcpClientEnabled (object)
The flag indicating whether the switch is configured as a DHCP client to obtain its management IP address.
Changed property dhcpServerEnabled (object)
The flag indicating whether the DHCP server feature is enabled on the switch.
Changed property enableStack (object)
The flag indicating whether switch stacking is enabled for combining multiple physical switches into a single logical unit.
Changed property igmpSnooping (object)
The IGMP snooping mode for multicast traffic optimization: enabled, disabled, or default.
Changed property initialVlanId (object)
The VLAN ID used for initial switch configuration and management access.
Changed property ipAddress (object)
The IPv4 address assigned to the switch management interface.
Changed property ipAddressInterface (object)
The specific interface identifier for the management IP address configuration.
Changed property ipAddressInterfaceType (object)
The interface type for the switch management IP address: VLAN interface or management port.
Changed property ipAddressType (object)
The IP address assignment method: static or DHCP.
Changed property jumboMode (object)
The flag indicating whether jumbo frame support is enabled, allowing frames larger than 1518 bytes.
Changed property name (object)
The name assigned to the ICX switch for identification in the network.
Changed property rearModule (object)
The model identifier of the rear expansion module installed on the switch, if applicable.
Changed property spanningTreePriority (object)
The STP (Spanning Tree Protocol) bridge priority value, used in root bridge election (lower values have higher priority).
Changed property specifiedType (object)
The firmware image type specified for the switch: primary, secondary, or boot.
Changed property subnetMask (object)
The subnet mask for the switch management IP address.
Changed property vlanCustomize (object)
The flag indicating whether VLAN configurations have been customized from default settings.

Return Type:

Changed response : 400 Bad Request

Bad/malformed request

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 401 Unauthorized

Unauthorized

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 403 Forbidden

Forbidden

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 404 Not Found

Requested resource or related entity not found

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 422 Unprocessable Entity

Validation error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 500 Internal Server Error

Internal Server Error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 200 OK

OK

Changed content type : application/json
- Changed property requestId (object)
  The unique identifier for tracking this API operation request.
- Changed property response (object)
  The ICX switch view for API version 1_1, representing a comprehensive view of a RUCKUS ICX switch with detailed hardware, software, and configuration information.
  - Added property StackMembers_V1_1 (object)
    The list of member switches in a stack configuration, including their models and active status.
  - Deleted property stackMembers (object)
  - Changed property defaultGateway (object)
    The default gateway IP address for routing traffic from the switch management interface.
  - Changed property description (object)
    The descriptive text providing additional information about the switch configuration or purpose.
  - Changed property dhcpClientEnabled (object)
    The flag indicating whether the switch is configured as a DHCP client to obtain its management IP address.
  - Changed property dhcpServerEnabled (object)
    The flag indicating whether the DHCP server feature is enabled on the switch.
  - Changed property enableStack (object)
    The flag indicating whether switch stacking is enabled for combining multiple physical switches into a single logical unit.
  - Changed property igmpSnooping (object)
    The IGMP snooping mode for multicast traffic optimization: enabled, disabled, or default.
  - Changed property initialVlanId (object)
    The VLAN ID used for initial switch configuration and management access.
  - Changed property ipAddress (object)
    The IPv4 address assigned to the switch management interface.
  - Changed property ipAddressInterface (object)
    The specific interface identifier for the management IP address configuration.
  - Changed property ipAddressInterfaceType (object)
    The interface type for the switch management IP address: VLAN interface or management port.
  - Changed property ipAddressType (object)
    The IP address assignment method: static or DHCP.
  - Changed property jumboMode (object)
    The flag indicating whether jumbo frame support is enabled, allowing frames larger than 1518 bytes.
  - Changed property name (object)
    The name assigned to the ICX switch for identification in the network.
  - Changed property rearModule (object)
    The model identifier of the rear expansion module installed on the switch, if applicable.
  - Changed property spanningTreePriority (object)
    The STP (Spanning Tree Protocol) bridge priority value, used in root bridge election (lower values have higher priority).
  - Changed property specifiedType (object)
    The firmware image type specified for the switch: primary, secondary, or boot.
  - Changed property subnetMask (object)
    The subnet mask for the switch management IP address.
  - Changed property vlanCustomize (object)
    The flag indicating whether VLAN configurations have been customized from default settings.
Changed content type : application/vnd.ruckus.v1+json
- Changed property requestId (object)
  The unique identifier for tracking this API operation request.
- Changed property response (object)
  The ICX switch view for API version 1_1, representing a comprehensive view of a RUCKUS ICX switch with detailed hardware, software, and configuration information.
  - Added property StackMembers_V1_1 (object)
    The list of member switches in a stack configuration, including their models and active status.
  - Deleted property stackMembers (object)
  - Changed property defaultGateway (object)
    The default gateway IP address for routing traffic from the switch management interface.
  - Changed property description (object)
    The descriptive text providing additional information about the switch configuration or purpose.
  - Changed property dhcpClientEnabled (object)
    The flag indicating whether the switch is configured as a DHCP client to obtain its management IP address.
  - Changed property dhcpServerEnabled (object)
    The flag indicating whether the DHCP server feature is enabled on the switch.
  - Changed property enableStack (object)
    The flag indicating whether switch stacking is enabled for combining multiple physical switches into a single logical unit.
  - Changed property igmpSnooping (object)
    The IGMP snooping mode for multicast traffic optimization: enabled, disabled, or default.
  - Changed property initialVlanId (object)
    The VLAN ID used for initial switch configuration and management access.
  - Changed property ipAddress (object)
    The IPv4 address assigned to the switch management interface.
  - Changed property ipAddressInterface (object)
    The specific interface identifier for the management IP address configuration.
  - Changed property ipAddressInterfaceType (object)
    The interface type for the switch management IP address: VLAN interface or management port.
  - Changed property ipAddressType (object)
    The IP address assignment method: static or DHCP.
  - Changed property jumboMode (object)
    The flag indicating whether jumbo frame support is enabled, allowing frames larger than 1518 bytes.
  - Changed property name (object)
    The name assigned to the ICX switch for identification in the network.
  - Changed property rearModule (object)
    The model identifier of the rear expansion module installed on the switch, if applicable.
  - Changed property spanningTreePriority (object)
    The STP (Spanning Tree Protocol) bridge priority value, used in root bridge election (lower values have higher priority).
  - Changed property specifiedType (object)
    The firmware image type specified for the switch: primary, secondary, or boot.
  - Changed property subnetMask (object)
    The subnet mask for the switch management IP address.
  - Changed property vlanCustomize (object)
    The flag indicating whether VLAN configurations have been customized from default settings.

POST /venues/{venueId}/switches/{switchId}

Request:

Changed content type : application/json

Added property StackMembers_V1_1 (object)
The list of member switches in a stack configuration, including their models and active status.
Deleted property stackMembers (object)
Changed property defaultGateway (object)
The default gateway IP address for routing traffic from the switch management interface.
Changed property description (object)
The descriptive text providing additional information about the switch configuration or purpose.
Changed property dhcpClientEnabled (object)
The flag indicating whether the switch is configured as a DHCP client to obtain its management IP address.
Changed property dhcpServerEnabled (object)
The flag indicating whether the DHCP server feature is enabled on the switch.
Changed property enableStack (object)
The flag indicating whether switch stacking is enabled for combining multiple physical switches into a single logical unit.
Changed property igmpSnooping (object)
The IGMP snooping mode for multicast traffic optimization: enabled, disabled, or default.
Changed property initialVlanId (object)
The VLAN ID used for initial switch configuration and management access.
Changed property ipAddress (object)
The IPv4 address assigned to the switch management interface.
Changed property ipAddressInterface (object)
The specific interface identifier for the management IP address configuration.
Changed property ipAddressInterfaceType (object)
The interface type for the switch management IP address: VLAN interface or management port.
Changed property ipAddressType (object)
The IP address assignment method: static or DHCP.
Changed property jumboMode (object)
The flag indicating whether jumbo frame support is enabled, allowing frames larger than 1518 bytes.
Changed property name (object)
The name assigned to the ICX switch for identification in the network.
Changed property rearModule (object)
The model identifier of the rear expansion module installed on the switch, if applicable.
Changed property spanningTreePriority (object)
The STP (Spanning Tree Protocol) bridge priority value, used in root bridge election (lower values have higher priority).
Changed property specifiedType (object)
The firmware image type specified for the switch: primary, secondary, or boot.
Changed property subnetMask (object)
The subnet mask for the switch management IP address.
Changed property vlanCustomize (object)
The flag indicating whether VLAN configurations have been customized from default settings.

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

Added property StackMembers_V1_1 (object)
The list of member switches in a stack configuration, including their models and active status.
Deleted property stackMembers (object)
Changed property defaultGateway (object)
The default gateway IP address for routing traffic from the switch management interface.
Changed property description (object)
The descriptive text providing additional information about the switch configuration or purpose.
Changed property dhcpClientEnabled (object)
The flag indicating whether the switch is configured as a DHCP client to obtain its management IP address.
Changed property dhcpServerEnabled (object)
The flag indicating whether the DHCP server feature is enabled on the switch.
Changed property enableStack (object)
The flag indicating whether switch stacking is enabled for combining multiple physical switches into a single logical unit.
Changed property igmpSnooping (object)
The IGMP snooping mode for multicast traffic optimization: enabled, disabled, or default.
Changed property initialVlanId (object)
The VLAN ID used for initial switch configuration and management access.
Changed property ipAddress (object)
The IPv4 address assigned to the switch management interface.
Changed property ipAddressInterface (object)
The specific interface identifier for the management IP address configuration.
Changed property ipAddressInterfaceType (object)
The interface type for the switch management IP address: VLAN interface or management port.
Changed property ipAddressType (object)
The IP address assignment method: static or DHCP.
Changed property jumboMode (object)
The flag indicating whether jumbo frame support is enabled, allowing frames larger than 1518 bytes.
Changed property name (object)
The name assigned to the ICX switch for identification in the network.
Changed property rearModule (object)
The model identifier of the rear expansion module installed on the switch, if applicable.
Changed property spanningTreePriority (object)
The STP (Spanning Tree Protocol) bridge priority value, used in root bridge election (lower values have higher priority).
Changed property specifiedType (object)
The firmware image type specified for the switch: primary, secondary, or boot.
Changed property subnetMask (object)
The subnet mask for the switch management IP address.
Changed property vlanCustomize (object)
The flag indicating whether VLAN configurations have been customized from default settings.

Return Type:

Changed response : 400 Bad Request

Bad/malformed request

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 401 Unauthorized

Unauthorized

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 403 Forbidden

Forbidden

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 404 Not Found

Requested resource or related entity not found

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 422 Unprocessable Entity

Validation error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 500 Internal Server Error

Internal Server Error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 202 Accepted

Accepted

Changed content type : application/json
- Changed property requestId (object)
  The unique identifier for tracking this API operation request.
- Changed property response (object)
  The empty view representing an API response with no data content, used for operations that return success status without additional information.
Changed content type : application/vnd.ruckus.v1+json
- Changed property requestId (object)
  The unique identifier for tracking this API operation request.
- Changed property response (object)
  The empty view representing an API response with no data content, used for operations that return success status without additional information.

DELETE /venues/{venueId}/switches/{switchId}

Return Type:

Changed response : 400 Bad Request

Bad/malformed request

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 401 Unauthorized

Unauthorized

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 403 Forbidden

Forbidden

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 404 Not Found

Requested resource or related entity not found

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 422 Unprocessable Entity

Validation error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 500 Internal Server Error

Internal Server Error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 202 Accepted

Accepted

Changed content type : application/json
- Changed property requestId (object)
  The unique identifier for tracking this API operation request.
- Changed property response (object)
  The empty view representing an API response with no data content, used for operations that return success status without additional information.
Changed content type : application/vnd.ruckus.v1+json
- Changed property requestId (object)
  The unique identifier for tracking this API operation request.
- Changed property response (object)
  The empty view representing an API response with no data content, used for operations that return success status without additional information.

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

Return Type:

Changed response : 400 Bad Request

Bad/malformed request

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 401 Unauthorized

Unauthorized

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 403 Forbidden

Forbidden

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 404 Not Found

Requested resource or related entity not found

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 422 Unprocessable Entity

Validation error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 500 Internal Server Error

Internal Server Error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

POST /venues/{venueId}/switches/{switchId}/configBackups

Request:

Changed content type : application/json

Changed property name (object)
The name for this configuration backup, with a length between 1 and 64 characters and excluding double quotes.

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

Changed property name (object)
The name for this configuration backup, with a length between 1 and 64 characters and excluding double quotes.

Return Type:

Changed response : 400 Bad Request

Bad/malformed request

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 401 Unauthorized

Unauthorized

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 403 Forbidden

Forbidden

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 404 Not Found

Requested resource or related entity not found

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 422 Unprocessable Entity

Validation error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 500 Internal Server Error

Internal Server Error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 202 Accepted

Accepted

Changed content type : application/json
- Changed property requestId (object)
  The unique identifier for tracking this API operation request.
- Changed property response (object)
  The empty view representing an API response with no data content, used for operations that return success status without additional information.
Changed content type : application/vnd.ruckus.v1+json
- Changed property requestId (object)
  The unique identifier for tracking this API operation request.
- Changed property response (object)
  The empty view representing an API response with no data content, used for operations that return success status without additional information.

DELETE /venues/{venueId}/switches/{switchId}/configBackups

Return Type:

Changed response : 400 Bad Request

Bad/malformed request

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 401 Unauthorized

Unauthorized

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 403 Forbidden

Forbidden

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 404 Not Found

Requested resource or related entity not found

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 422 Unprocessable Entity

Validation error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 500 Internal Server Error

Internal Server Error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 200 OK

OK

Changed content type : application/json
- Changed property requestId (object)
  The unique identifier for tracking this API operation request.
- Changed property response (object)
  The empty view representing an API response with no data content, used for operations that return success status without additional information.
Changed content type : application/vnd.ruckus.v1+json
- Changed property requestId (object)
  The unique identifier for tracking this API operation request.
- Changed property response (object)
  The empty view representing an API response with no data content, used for operations that return success status without additional information.

POST /venues/{venueId}/switches/{switchId}/configBackups/comparisons

Request:

Changed content type : application/json

Changed property backupId1 (object)
First configuration backup id for comparison.
Changed property backupId2 (object)
Second configuration backup id for comparison.

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

Changed property backupId1 (object)
First configuration backup id for comparison.
Changed property backupId2 (object)
Second configuration backup id for comparison.

Return Type:

Changed response : 400 Bad Request

Bad/malformed request

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 401 Unauthorized

Unauthorized

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 403 Forbidden

Forbidden

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 404 Not Found

Requested resource or related entity not found

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 422 Unprocessable Entity

Validation error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 500 Internal Server Error

Internal Server Error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 200 OK

OK

Changed content type : application/json
- Changed property configBackup1 (object)
  The configuration backup content view, providing access to the actual configuration text stored in a backup.
  - Changed property config (object)
    The complete configuration content from the backup, containing all switch commands and settings in text format.
Changed content type : application/vnd.ruckus.v1+json
- Changed property configBackup1 (object)
  The configuration backup content view, providing access to the actual configuration text stored in a backup.
  - Changed property config (object)
    The complete configuration content from the backup, containing all switch commands and settings in text format.

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

Return Type:

Changed response : 200 OK

OK

Changed content type : application/json
- Changed property backupId (object)
  The unique identifier for this configuration backup.
- Changed property backupType (object)
  The type of configuration backup, such as automatic, manual, or scheduled.
- Changed property config (object)
  The complete configuration content stored in this backup.
- Changed property createdDate (object)
  The timestamp when this configuration backup was created.
- Changed property failureReason (object)
  The reason for backup or restore failure, providing diagnostic information when operations fail.
- Changed property name (object)
  The name identifier for this configuration backup.
- Changed property restoreStatus (object)
  The status of the most recent restore operation using this backup.
- Changed property restoreTimestamp (object)
  The timestamp when this configuration was last restored to a switch.
- Changed property status (object)
  The current status of this backup operation, such as completed, in progress, or failed.
- Changed property switchId (object)
  The identifier of the switch that this configuration backup belongs to.
Changed content type : application/vnd.ruckus.v1+json
- Changed property backupId (object)
  The unique identifier for this configuration backup.
- Changed property backupType (object)
  The type of configuration backup, such as automatic, manual, or scheduled.
- Changed property config (object)
  The complete configuration content stored in this backup.
- Changed property createdDate (object)
  The timestamp when this configuration backup was created.
- Changed property failureReason (object)
  The reason for backup or restore failure, providing diagnostic information when operations fail.
- Changed property name (object)
  The name identifier for this configuration backup.
- Changed property restoreStatus (object)
  The status of the most recent restore operation using this backup.
- Changed property restoreTimestamp (object)
  The timestamp when this configuration was last restored to a switch.
- Changed property status (object)
  The current status of this backup operation, such as completed, in progress, or failed.
- Changed property switchId (object)
  The identifier of the switch that this configuration backup belongs to.

Changed response : 400 Bad Request

Bad/malformed request

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 401 Unauthorized

Unauthorized

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 403 Forbidden

Forbidden

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 404 Not Found

Requested resource or related entity not found

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 422 Unprocessable Entity

Validation error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 500 Internal Server Error

Internal Server Error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

DELETE /venues/{venueId}/switches/{switchId}/configBackups/{configBackupId}

Return Type:

Changed response : 400 Bad Request

Bad/malformed request

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 401 Unauthorized

Unauthorized

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 403 Forbidden

Forbidden

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 404 Not Found

Requested resource or related entity not found

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 422 Unprocessable Entity

Validation error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 500 Internal Server Error

Internal Server Error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 200 OK

OK

Changed content type : application/json
- Changed property requestId (object)
  The unique identifier for tracking this API operation request.
- Changed property response (object)
  The empty view representing an API response with no data content, used for operations that return success status without additional information.
Changed content type : application/vnd.ruckus.v1+json
- Changed property requestId (object)
  The unique identifier for tracking this API operation request.
- Changed property response (object)
  The empty view representing an API response with no data content, used for operations that return success status without additional information.

PATCH /venues/{venueId}/switches/{switchId}/configBackups/{configBackupId}

Request:

Changed content type : application/json

Changed property configBackupAction (object)
The action to perform on the configuration backup, either restore to a switch or download for external storage.

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

Changed property configBackupAction (object)
The action to perform on the configuration backup, either restore to a switch or download for external storage.

Return Type:

Changed response : 400 Bad Request

Bad/malformed request

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 401 Unauthorized

Unauthorized

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 403 Forbidden

Forbidden

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 404 Not Found

Requested resource or related entity not found

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 422 Unprocessable Entity

Validation error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 500 Internal Server Error

Internal Server Error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 202 Accepted

Accepted

Changed content type : application/json
- Changed property requestId (object)
  The unique identifier for tracking this API operation request.
- Changed property response (object)
  The empty view representing an API response with no data content, used for operations that return success status without additional information.
Changed content type : application/vnd.ruckus.v1+json
- Changed property requestId (object)
  The unique identifier for tracking this API operation request.
- Changed property response (object)
  The empty view representing an API response with no data content, used for operations that return success status without additional information.

POST /venues/{venueId}/switches/{switchId}/deviceRequests

Sync or Reboot ICX Device

Request:

Changed content type : application/json

Changed property deviceRequestAction (object)
The request action to the switches.
Changed property switchIdList (object)
The list of switch id.

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

Changed property deviceRequestAction (object)
The request action to the switches.
Changed property switchIdList (object)
The list of switch id.

Return Type:

Changed response : 400 Bad Request

Bad/malformed request

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 401 Unauthorized

Unauthorized

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 403 Forbidden

Forbidden

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 404 Not Found

Requested resource or related entity not found

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 422 Unprocessable Entity

Validation error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 500 Internal Server Error

Internal Server Error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 202 Accepted

Accepted

Changed content type : application/json
- Changed property requestId (object)
  The unique identifier for tracking this API operation request.
- Changed property response (object)
  The empty view representing an API response with no data content, used for operations that return success status without additional information.
Changed content type : application/vnd.ruckus.v1+json
- Changed property requestId (object)
  The unique identifier for tracking this API operation request.
- Changed property response (object)
  The empty view representing an API response with no data content, used for operations that return success status without additional information.

PATCH /venues/{venueId}/switches/{switchId}/dhcpServerStates

Request:

Changed content type : application/json

Changed property state (object)
The operational state of the DHCP server, where true indicates enabled and false indicates disabled.

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

Changed property state (object)
The operational state of the DHCP server, where true indicates enabled and false indicates disabled.

Return Type:

Changed response : 400 Bad Request

Bad/malformed request

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 401 Unauthorized

Unauthorized

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 403 Forbidden

Forbidden

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 404 Not Found

Requested resource or related entity not found

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 422 Unprocessable Entity

Validation error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 500 Internal Server Error

Internal Server Error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 200 OK

OK

Changed content type : application/json
- Changed property requestId (object)
  The unique identifier for tracking this API operation request.
- Changed property response (object)
  The empty view representing an API response with no data content, used for operations that return success status without additional information.
Changed content type : application/vnd.ruckus.v1+json
- Changed property requestId (object)
  The unique identifier for tracking this API operation request.
- Changed property response (object)
  The empty view representing an API response with no data content, used for operations that return success status without additional information.

POST /venues/{venueId}/switches/{switchId}/dhcpServers

Request:

Changed content type : application/json

Changed property defaultRouterIp (object)
The default gateway IP address provided to DHCP clients.
Changed property dhcpOptions (object)
The list of additional DHCP options to be provided to clients.
Changed property excludedEnd (object)
The ending IP address of the excluded address range that will not be assigned to clients.
Changed property excludedStart (object)
The starting IP address of the excluded address range that will not be assigned to clients.
Changed property leaseDays (object)
The number of days in the DHCP lease duration.
Changed property leaseHrs (object)
The number of hours in the DHCP lease duration.
Changed property leaseMins (object)
The number of minutes in the DHCP lease duration.
Changed property poolName (object)
The name of the DHCP address pool.
Changed property subnetAddress (object)
The subnet network address for the DHCP pool.
Changed property subnetMask (object)
The subnet mask for the DHCP network.

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

Changed property defaultRouterIp (object)
The default gateway IP address provided to DHCP clients.
Changed property dhcpOptions (object)
The list of additional DHCP options to be provided to clients.
Changed property excludedEnd (object)
The ending IP address of the excluded address range that will not be assigned to clients.
Changed property excludedStart (object)
The starting IP address of the excluded address range that will not be assigned to clients.
Changed property leaseDays (object)
The number of days in the DHCP lease duration.
Changed property leaseHrs (object)
The number of hours in the DHCP lease duration.
Changed property leaseMins (object)
The number of minutes in the DHCP lease duration.
Changed property poolName (object)
The name of the DHCP address pool.
Changed property subnetAddress (object)
The subnet network address for the DHCP pool.
Changed property subnetMask (object)
The subnet mask for the DHCP network.

Return Type:

Changed response : 400 Bad Request

Bad/malformed request

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 401 Unauthorized

Unauthorized

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 403 Forbidden

Forbidden

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 404 Not Found

Requested resource or related entity not found

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 422 Unprocessable Entity

Validation error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 500 Internal Server Error

Internal Server Error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 201 Created

Created

Changed content type : application/json
- Changed property requestId (object)
  The unique identifier for tracking this API operation request.
- Changed property response (object)
  The DHCP (Dynamic Host Configuration Protocol) server view, representing a DHCP server configuration with IP address pool management and lease settings.
  - Changed property defaultRouterIp (object)
    The default gateway IP address provided to DHCP clients.
  - Changed property dhcpOptions (object)
    The list of additional DHCP options to be provided to clients.
  - Changed property excludedEnd (object)
    The ending IP address of the excluded address range that will not be assigned to clients.
  - Changed property excludedStart (object)
    The starting IP address of the excluded address range that will not be assigned to clients.
  - Changed property leaseDays (object)
    The number of days in the DHCP lease duration.
  - Changed property leaseHrs (object)
    The number of hours in the DHCP lease duration.
  - Changed property leaseMins (object)
    The number of minutes in the DHCP lease duration.
  - Changed property poolName (object)
    The name of the DHCP address pool.
  - Changed property subnetAddress (object)
    The subnet network address for the DHCP pool.
  - Changed property subnetMask (object)
    The subnet mask for the DHCP network.
Changed content type : application/vnd.ruckus.v1+json
- Changed property requestId (object)
  The unique identifier for tracking this API operation request.
- Changed property response (object)
  The DHCP (Dynamic Host Configuration Protocol) server view, representing a DHCP server configuration with IP address pool management and lease settings.
  - Changed property defaultRouterIp (object)
    The default gateway IP address provided to DHCP clients.
  - Changed property dhcpOptions (object)
    The list of additional DHCP options to be provided to clients.
  - Changed property excludedEnd (object)
    The ending IP address of the excluded address range that will not be assigned to clients.
  - Changed property excludedStart (object)
    The starting IP address of the excluded address range that will not be assigned to clients.
  - Changed property leaseDays (object)
    The number of days in the DHCP lease duration.
  - Changed property leaseHrs (object)
    The number of hours in the DHCP lease duration.
  - Changed property leaseMins (object)
    The number of minutes in the DHCP lease duration.
  - Changed property poolName (object)
    The name of the DHCP address pool.
  - Changed property subnetAddress (object)
    The subnet network address for the DHCP pool.
  - Changed property subnetMask (object)
    The subnet mask for the DHCP network.

DELETE /venues/{venueId}/switches/{switchId}/dhcpServers

Return Type:

Changed response : 400 Bad Request

Bad/malformed request

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 401 Unauthorized

Unauthorized

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 403 Forbidden

Forbidden

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 404 Not Found

Requested resource or related entity not found

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 422 Unprocessable Entity

Validation error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 500 Internal Server Error

Internal Server Error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 204 No Content

No Content

Changed content type : application/json
- Changed property requestId (object)
  The unique identifier for tracking this API operation request.
- Changed property response (object)
  The empty view representing an API response with no data content, used for operations that return success status without additional information.
Changed content type : application/vnd.ruckus.v1+json
- Changed property requestId (object)
  The unique identifier for tracking this API operation request.
- Changed property response (object)
  The empty view representing an API response with no data content, used for operations that return success status without additional information.

GET /venues/{venueId}/switches/{switchId}/dhcpServers/{dhcpServerId}

Get DHCP Server Setting

Return Type:

Changed response : 200 OK

OK

Changed content type : application/json
- Changed property defaultRouterIp (object)
  The default gateway IP address provided to DHCP clients.
- Changed property dhcpOptions (object)
  The list of additional DHCP options to be provided to clients.
- Changed property excludedEnd (object)
  The ending IP address of the excluded address range that will not be assigned to clients.
- Changed property excludedStart (object)
  The starting IP address of the excluded address range that will not be assigned to clients.
- Changed property leaseDays (object)
  The number of days in the DHCP lease duration.
- Changed property leaseHrs (object)
  The number of hours in the DHCP lease duration.
- Changed property leaseMins (object)
  The number of minutes in the DHCP lease duration.
- Changed property poolName (object)
  The name of the DHCP address pool.
- Changed property subnetAddress (object)
  The subnet network address for the DHCP pool.
- Changed property subnetMask (object)
  The subnet mask for the DHCP network.
Changed content type : application/vnd.ruckus.v1+json
- Changed property defaultRouterIp (object)
  The default gateway IP address provided to DHCP clients.
- Changed property dhcpOptions (object)
  The list of additional DHCP options to be provided to clients.
- Changed property excludedEnd (object)
  The ending IP address of the excluded address range that will not be assigned to clients.
- Changed property excludedStart (object)
  The starting IP address of the excluded address range that will not be assigned to clients.
- Changed property leaseDays (object)
  The number of days in the DHCP lease duration.
- Changed property leaseHrs (object)
  The number of hours in the DHCP lease duration.
- Changed property leaseMins (object)
  The number of minutes in the DHCP lease duration.
- Changed property poolName (object)
  The name of the DHCP address pool.
- Changed property subnetAddress (object)
  The subnet network address for the DHCP pool.
- Changed property subnetMask (object)
  The subnet mask for the DHCP network.

Changed response : 400 Bad Request

Bad/malformed request

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 401 Unauthorized

Unauthorized

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 403 Forbidden

Forbidden

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 404 Not Found

Requested resource or related entity not found

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 422 Unprocessable Entity

Validation error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 500 Internal Server Error

Internal Server Error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

PUT /venues/{venueId}/switches/{switchId}/dhcpServers/{dhcpServerId}

Update DHCP Server Setting

Request:

Changed content type : application/json

Changed property defaultRouterIp (object)
The default gateway IP address provided to DHCP clients.
Changed property dhcpOptions (object)
The list of additional DHCP options to be provided to clients.
Changed property excludedEnd (object)
The ending IP address of the excluded address range that will not be assigned to clients.
Changed property excludedStart (object)
The starting IP address of the excluded address range that will not be assigned to clients.
Changed property leaseDays (object)
The number of days in the DHCP lease duration.
Changed property leaseHrs (object)
The number of hours in the DHCP lease duration.
Changed property leaseMins (object)
The number of minutes in the DHCP lease duration.
Changed property poolName (object)
The name of the DHCP address pool.
Changed property subnetAddress (object)
The subnet network address for the DHCP pool.
Changed property subnetMask (object)
The subnet mask for the DHCP network.

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

Changed property defaultRouterIp (object)
The default gateway IP address provided to DHCP clients.
Changed property dhcpOptions (object)
The list of additional DHCP options to be provided to clients.
Changed property excludedEnd (object)
The ending IP address of the excluded address range that will not be assigned to clients.
Changed property excludedStart (object)
The starting IP address of the excluded address range that will not be assigned to clients.
Changed property leaseDays (object)
The number of days in the DHCP lease duration.
Changed property leaseHrs (object)
The number of hours in the DHCP lease duration.
Changed property leaseMins (object)
The number of minutes in the DHCP lease duration.
Changed property poolName (object)
The name of the DHCP address pool.
Changed property subnetAddress (object)
The subnet network address for the DHCP pool.
Changed property subnetMask (object)
The subnet mask for the DHCP network.

Return Type:

Changed response : 400 Bad Request

Bad/malformed request

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 401 Unauthorized

Unauthorized

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 403 Forbidden

Forbidden

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 404 Not Found

Requested resource or related entity not found

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 422 Unprocessable Entity

Validation error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 500 Internal Server Error

Internal Server Error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 200 OK

OK

Changed content type : application/json
- Changed property requestId (object)
  The unique identifier for tracking this API operation request.
- Changed property response (object)
  The DHCP (Dynamic Host Configuration Protocol) server view, representing a DHCP server configuration with IP address pool management and lease settings.
  - Changed property defaultRouterIp (object)
    The default gateway IP address provided to DHCP clients.
  - Changed property dhcpOptions (object)
    The list of additional DHCP options to be provided to clients.
  - Changed property excludedEnd (object)
    The ending IP address of the excluded address range that will not be assigned to clients.
  - Changed property excludedStart (object)
    The starting IP address of the excluded address range that will not be assigned to clients.
  - Changed property leaseDays (object)
    The number of days in the DHCP lease duration.
  - Changed property leaseHrs (object)
    The number of hours in the DHCP lease duration.
  - Changed property leaseMins (object)
    The number of minutes in the DHCP lease duration.
  - Changed property poolName (object)
    The name of the DHCP address pool.
  - Changed property subnetAddress (object)
    The subnet network address for the DHCP pool.
  - Changed property subnetMask (object)
    The subnet mask for the DHCP network.
Changed content type : application/vnd.ruckus.v1+json
- Changed property requestId (object)
  The unique identifier for tracking this API operation request.
- Changed property response (object)
  The DHCP (Dynamic Host Configuration Protocol) server view, representing a DHCP server configuration with IP address pool management and lease settings.
  - Changed property defaultRouterIp (object)
    The default gateway IP address provided to DHCP clients.
  - Changed property dhcpOptions (object)
    The list of additional DHCP options to be provided to clients.
  - Changed property excludedEnd (object)
    The ending IP address of the excluded address range that will not be assigned to clients.
  - Changed property excludedStart (object)
    The starting IP address of the excluded address range that will not be assigned to clients.
  - Changed property leaseDays (object)
    The number of days in the DHCP lease duration.
  - Changed property leaseHrs (object)
    The number of hours in the DHCP lease duration.
  - Changed property leaseMins (object)
    The number of minutes in the DHCP lease duration.
  - Changed property poolName (object)
    The name of the DHCP address pool.
  - Changed property subnetAddress (object)
    The subnet network address for the DHCP pool.
  - Changed property subnetMask (object)
    The subnet mask for the DHCP network.

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

Delete DHCP Server Setting

Return Type:

Changed response : 400 Bad Request

Bad/malformed request

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 401 Unauthorized

Unauthorized

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 403 Forbidden

Forbidden

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 404 Not Found

Requested resource or related entity not found

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 422 Unprocessable Entity

Validation error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 500 Internal Server Error

Internal Server Error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 200 OK

OK

Changed content type : application/json
- Changed property requestId (object)
  The unique identifier for tracking this API operation request.
- Changed property response (object)
  The empty view representing an API response with no data content, used for operations that return success status without additional information.
Changed content type : application/vnd.ruckus.v1+json
- Changed property requestId (object)
  The unique identifier for tracking this API operation request.
- Changed property response (object)
  The empty view representing an API response with no data content, used for operations that return success status without additional information.

GET /venues/{venueId}/switches/{switchId}/lags

Return Type:

Changed response : 400 Bad Request

Bad/malformed request

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 401 Unauthorized

Unauthorized

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 403 Forbidden

Forbidden

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 404 Not Found

Requested resource or related entity not found

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 422 Unprocessable Entity

Validation error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 500 Internal Server Error

Internal Server Error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

POST /venues/{venueId}/switches/{switchId}/lags

Return Type:

Changed response : 400 Bad Request

Bad/malformed request

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 401 Unauthorized

Unauthorized

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 403 Forbidden

Forbidden

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 404 Not Found

Requested resource or related entity not found

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 422 Unprocessable Entity

Validation error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 500 Internal Server Error

Internal Server Error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 201 Created

Created

Changed content type : application/json
- Changed property requestId (object)
  The unique identifier for tracking this API operation request.
- Changed property response (object)
  The LAG (Link Aggregation Group) view, representing a logical interface that bundles multiple physical ports for increased bandwidth and redundancy.
  - Changed property forceUpPort (object)
    The port identifier to force into an up state within the LAG.
  - Changed property lagId (object)
    The unique identifier of the LAG interface.
  - Changed property name (object)
    The name of the LAG interface.
  - Changed property ports (object)
    The set of physical port identifiers that are members of this LAG.
  - Changed property taggedVlans (object)
    The set of VLAN identifiers that are tagged on this LAG interface.
  - Changed property type (object)
    The type of LAG protocol, such as static or LACP (Link Aggregation Control Protocol).
  - Changed property untaggedVlan (object)
    The VLAN identifier for untagged traffic on this LAG interface.
Changed content type : application/vnd.ruckus.v1+json
- Changed property requestId (object)
  The unique identifier for tracking this API operation request.
- Changed property response (object)
  The LAG (Link Aggregation Group) view, representing a logical interface that bundles multiple physical ports for increased bandwidth and redundancy.
  - Changed property forceUpPort (object)
    The port identifier to force into an up state within the LAG.
  - Changed property lagId (object)
    The unique identifier of the LAG interface.
  - Changed property name (object)
    The name of the LAG interface.
  - Changed property ports (object)
    The set of physical port identifiers that are members of this LAG.
  - Changed property taggedVlans (object)
    The set of VLAN identifiers that are tagged on this LAG interface.
  - Changed property type (object)
    The type of LAG protocol, such as static or LACP (Link Aggregation Control Protocol).
  - Changed property untaggedVlan (object)
    The VLAN identifier for untagged traffic on this LAG interface.

DELETE /venues/{venueId}/switches/{switchId}/lags

Return Type:

Changed response : 400 Bad Request

Bad/malformed request

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 401 Unauthorized

Unauthorized

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 403 Forbidden

Forbidden

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 404 Not Found

Requested resource or related entity not found

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 422 Unprocessable Entity

Validation error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 500 Internal Server Error

Internal Server Error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 200 OK

OK

Changed content type : application/json
- Changed property requestId (object)
  The unique identifier for tracking this API operation request.
- Changed property response (object)
  The empty view representing an API response with no data content, used for operations that return success status without additional information.
Changed content type : application/vnd.ruckus.v1+json
- Changed property requestId (object)
  The unique identifier for tracking this API operation request.
- Changed property response (object)
  The empty view representing an API response with no data content, used for operations that return success status without additional information.

GET /venues/{venueId}/switches/{switchId}/lags/{lagId}

Return Type:

Changed response : 200 OK

OK

Changed content type : application/json
- Changed property forceUpPort (object)
  The port identifier to force into an up state within the LAG.
- Changed property lagId (object)
  The unique identifier of the LAG interface.
- Changed property name (object)
  The name of the LAG interface.
- Changed property ports (object)
  The set of physical port identifiers that are members of this LAG.
- Changed property taggedVlans (object)
  The set of VLAN identifiers that are tagged on this LAG interface.
- Changed property type (object)
  The type of LAG protocol, such as static or LACP (Link Aggregation Control Protocol).
- Changed property untaggedVlan (object)
  The VLAN identifier for untagged traffic on this LAG interface.
Changed content type : application/vnd.ruckus.v1+json
- Changed property forceUpPort (object)
  The port identifier to force into an up state within the LAG.
- Changed property lagId (object)
  The unique identifier of the LAG interface.
- Changed property name (object)
  The name of the LAG interface.
- Changed property ports (object)
  The set of physical port identifiers that are members of this LAG.
- Changed property taggedVlans (object)
  The set of VLAN identifiers that are tagged on this LAG interface.
- Changed property type (object)
  The type of LAG protocol, such as static or LACP (Link Aggregation Control Protocol).
- Changed property untaggedVlan (object)
  The VLAN identifier for untagged traffic on this LAG interface.

Changed response : 400 Bad Request

Bad/malformed request

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 401 Unauthorized

Unauthorized

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 403 Forbidden

Forbidden

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 404 Not Found

Requested resource or related entity not found

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 422 Unprocessable Entity

Validation error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 500 Internal Server Error

Internal Server Error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

PUT /venues/{venueId}/switches/{switchId}/lags/{lagId}

Request:

Changed content type : application/json

Changed property forceUpPort (object)
The port identifier to force into an up state within the LAG.
Changed property name (object)
The name of the LAG interface.
Changed property ports (object)
The set of physical port identifiers that are members of this LAG.
Changed property taggedVlans (object)
The set of VLAN identifiers that are tagged on this LAG interface.
Changed property type (object)
The type of LAG protocol, such as static or LACP (Link Aggregation Control Protocol).
Changed property untaggedVlan (object)
The VLAN identifier for untagged traffic on this LAG interface.

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

Changed property forceUpPort (object)
The port identifier to force into an up state within the LAG.
Changed property name (object)
The name of the LAG interface.
Changed property ports (object)
The set of physical port identifiers that are members of this LAG.
Changed property taggedVlans (object)
The set of VLAN identifiers that are tagged on this LAG interface.
Changed property type (object)
The type of LAG protocol, such as static or LACP (Link Aggregation Control Protocol).
Changed property untaggedVlan (object)
The VLAN identifier for untagged traffic on this LAG interface.

Return Type:

Changed response : 400 Bad Request

Bad/malformed request

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 401 Unauthorized

Unauthorized

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 403 Forbidden

Forbidden

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 404 Not Found

Requested resource or related entity not found

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 422 Unprocessable Entity

Validation error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 500 Internal Server Error

Internal Server Error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 200 OK

OK

Changed content type : application/json
- Changed property requestId (object)
  The unique identifier for tracking this API operation request.
- Changed property response (object)
  The LAG (Link Aggregation Group) view, representing a logical interface that bundles multiple physical ports for increased bandwidth and redundancy.
  - Changed property forceUpPort (object)
    The port identifier to force into an up state within the LAG.
  - Changed property lagId (object)
    The unique identifier of the LAG interface.
  - Changed property name (object)
    The name of the LAG interface.
  - Changed property ports (object)
    The set of physical port identifiers that are members of this LAG.
  - Changed property taggedVlans (object)
    The set of VLAN identifiers that are tagged on this LAG interface.
  - Changed property type (object)
    The type of LAG protocol, such as static or LACP (Link Aggregation Control Protocol).
  - Changed property untaggedVlan (object)
    The VLAN identifier for untagged traffic on this LAG interface.
Changed content type : application/vnd.ruckus.v1+json
- Changed property requestId (object)
  The unique identifier for tracking this API operation request.
- Changed property response (object)
  The LAG (Link Aggregation Group) view, representing a logical interface that bundles multiple physical ports for increased bandwidth and redundancy.
  - Changed property forceUpPort (object)
    The port identifier to force into an up state within the LAG.
  - Changed property lagId (object)
    The unique identifier of the LAG interface.
  - Changed property name (object)
    The name of the LAG interface.
  - Changed property ports (object)
    The set of physical port identifiers that are members of this LAG.
  - Changed property taggedVlans (object)
    The set of VLAN identifiers that are tagged on this LAG interface.
  - Changed property type (object)
    The type of LAG protocol, such as static or LACP (Link Aggregation Control Protocol).
  - Changed property untaggedVlan (object)
    The VLAN identifier for untagged traffic on this LAG interface.

DELETE /venues/{venueId}/switches/{switchId}/lags/{lagId}

Return Type:

Changed response : 400 Bad Request

Bad/malformed request

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 401 Unauthorized

Unauthorized

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 403 Forbidden

Forbidden

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 404 Not Found

Requested resource or related entity not found

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 422 Unprocessable Entity

Validation error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 500 Internal Server Error

Internal Server Error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 200 OK

OK

Changed content type : application/json
- Changed property requestId (object)
  The unique identifier for tracking this API operation request.
- Changed property response (object)
  The empty view representing an API response with no data content, used for operations that return success status without additional information.
Changed content type : application/vnd.ruckus.v1+json
- Changed property requestId (object)
  The unique identifier for tracking this API operation request.
- Changed property response (object)
  The empty view representing an API response with no data content, used for operations that return success status without additional information.

PUT /venues/{venueId}/switches/{switchId}/positions

Request:

Changed content type : application/json

Changed property floorPlanId (object)
The unique identifier of the floor plan where the switch is located.
Changed property xPercent (object)
The horizontal position of the switch on the floor plan as a percentage of the total width, ranging from 0.0 to 100.0.
Changed property yPercent (object)
The vertical position of the switch on the floor plan as a percentage of the total height, ranging from 0.0 to 100.0.

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

Changed property floorPlanId (object)
The unique identifier of the floor plan where the switch is located.
Changed property xPercent (object)
The horizontal position of the switch on the floor plan as a percentage of the total width, ranging from 0.0 to 100.0.
Changed property yPercent (object)
The vertical position of the switch on the floor plan as a percentage of the total height, ranging from 0.0 to 100.0.

Return Type:

Changed response : 400 Bad Request

Bad/malformed request

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 401 Unauthorized

Unauthorized

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 403 Forbidden

Forbidden

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 404 Not Found

Requested resource or related entity not found

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 422 Unprocessable Entity

Validation error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 500 Internal Server Error

Internal Server Error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 202 Accepted

Accepted

Changed content type : application/json
- Changed property requestId (object)
  The unique identifier for tracking this API operation request.
- Changed property response (object)
  The empty view representing an API response with no data content, used for operations that return success status without additional information.
Changed content type : application/vnd.ruckus.v1+json
- Changed property requestId (object)
  The unique identifier for tracking this API operation request.
- Changed property response (object)
  The empty view representing an API response with no data content, used for operations that return success status without additional information.

GET /venues/{venueId}/switches/{switchId}/staticRoutes

Return Type:

Changed response : 400 Bad Request

Bad/malformed request

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 401 Unauthorized

Unauthorized

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 403 Forbidden

Forbidden

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 404 Not Found

Requested resource or related entity not found

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 422 Unprocessable Entity

Validation error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 500 Internal Server Error

Internal Server Error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

POST /venues/{venueId}/switches/{switchId}/staticRoutes

Return Type:

Changed response : 400 Bad Request

Bad/malformed request

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 401 Unauthorized

Unauthorized

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 403 Forbidden

Forbidden

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 404 Not Found

Requested resource or related entity not found

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 422 Unprocessable Entity

Validation error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 500 Internal Server Error

Internal Server Error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 201 Created

Created

Changed content type : application/json
- Changed property requestId (object)
  The unique identifier for tracking this API operation request.
- Changed property response (object)
  The static route view, representing a manually configured IP route with destination network, next hop gateway, and administrative distance.
  New required properties:
  - destinationIp
  - nextHop
  - Changed property adminDistance (object)
    The administrative distance value for route preference, with lower values having higher priority.
  - Changed property destinationIp (object)
    The destination IP address in CIDR notation. For IPv4: '192.168.10.0/24', For IPv6: '2001:db8::/32'.
  - Changed property nextHop (object)
    The IP address of the next hop gateway to route traffic. For IPv4: '192.168.1.1', For IPv6: '2001:db8::1'.
Changed content type : application/vnd.ruckus.v1+json
- Changed property requestId (object)
  The unique identifier for tracking this API operation request.
- Changed property response (object)
  The static route view, representing a manually configured IP route with destination network, next hop gateway, and administrative distance.
  New required properties:
  - destinationIp
  - nextHop
  - Changed property adminDistance (object)
    The administrative distance value for route preference, with lower values having higher priority.
  - Changed property destinationIp (object)
    The destination IP address in CIDR notation. For IPv4: '192.168.10.0/24', For IPv6: '2001:db8::/32'.
  - Changed property nextHop (object)
    The IP address of the next hop gateway to route traffic. For IPv4: '192.168.1.1', For IPv6: '2001:db8::1'.

DELETE /venues/{venueId}/switches/{switchId}/staticRoutes

Return Type:

Changed response : 400 Bad Request

Bad/malformed request

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 401 Unauthorized

Unauthorized

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 403 Forbidden

Forbidden

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 404 Not Found

Requested resource or related entity not found

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 422 Unprocessable Entity

Validation error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 500 Internal Server Error

Internal Server Error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 200 OK

OK

Changed content type : application/json
- Changed property requestId (object)
  The unique identifier for tracking this API operation request.
- Changed property response (object)
  The empty view representing an API response with no data content, used for operations that return success status without additional information.
Changed content type : application/vnd.ruckus.v1+json
- Changed property requestId (object)
  The unique identifier for tracking this API operation request.
- Changed property response (object)
  The empty view representing an API response with no data content, used for operations that return success status without additional information.

GET /venues/{venueId}/switches/{switchId}/staticRoutes/{staticRouteId}

Return Type:

Changed response : 200 OK

OK

Changed content type : application/json
New required properties:
- destinationIp
- nextHop
- Changed property adminDistance (object)
  The administrative distance value for route preference, with lower values having higher priority.
- Changed property destinationIp (object)
  The destination IP address in CIDR notation. For IPv4: '192.168.10.0/24', For IPv6: '2001:db8::/32'.
- Changed property nextHop (object)
  The IP address of the next hop gateway to route traffic. For IPv4: '192.168.1.1', For IPv6: '2001:db8::1'.
Changed content type : application/vnd.ruckus.v1+json
New required properties:
- destinationIp
- nextHop
- Changed property adminDistance (object)
  The administrative distance value for route preference, with lower values having higher priority.
- Changed property destinationIp (object)
  The destination IP address in CIDR notation. For IPv4: '192.168.10.0/24', For IPv6: '2001:db8::/32'.
- Changed property nextHop (object)
  The IP address of the next hop gateway to route traffic. For IPv4: '192.168.1.1', For IPv6: '2001:db8::1'.

Changed response : 400 Bad Request

Bad/malformed request

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 401 Unauthorized

Unauthorized

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 403 Forbidden

Forbidden

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 404 Not Found

Requested resource or related entity not found

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 422 Unprocessable Entity

Validation error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 500 Internal Server Error

Internal Server Error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

PUT /venues/{venueId}/switches/{switchId}/staticRoutes/{staticRouteId}

Request:

Changed content type : application/json

New required properties:

destinationIp
nextHop

Changed property adminDistance (object)
The administrative distance value for route preference, with lower values having higher priority.
Changed property destinationIp (object)
The destination IP address in CIDR notation. For IPv4: '192.168.10.0/24', For IPv6: '2001:db8::/32'.
Changed property nextHop (object)
The IP address of the next hop gateway to route traffic. For IPv4: '192.168.1.1', For IPv6: '2001:db8::1'.

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

New required properties:

destinationIp
nextHop

Changed property adminDistance (object)
The administrative distance value for route preference, with lower values having higher priority.
Changed property destinationIp (object)
The destination IP address in CIDR notation. For IPv4: '192.168.10.0/24', For IPv6: '2001:db8::/32'.
Changed property nextHop (object)
The IP address of the next hop gateway to route traffic. For IPv4: '192.168.1.1', For IPv6: '2001:db8::1'.

Return Type:

Changed response : 400 Bad Request

Bad/malformed request

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 401 Unauthorized

Unauthorized

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 403 Forbidden

Forbidden

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 404 Not Found

Requested resource or related entity not found

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 422 Unprocessable Entity

Validation error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 500 Internal Server Error

Internal Server Error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 200 OK

OK

Changed content type : application/json
- Changed property requestId (object)
  The unique identifier for tracking this API operation request.
- Changed property response (object)
  The static route view, representing a manually configured IP route with destination network, next hop gateway, and administrative distance.
  New required properties:
  - destinationIp
  - nextHop
  - Changed property adminDistance (object)
    The administrative distance value for route preference, with lower values having higher priority.
  - Changed property destinationIp (object)
    The destination IP address in CIDR notation. For IPv4: '192.168.10.0/24', For IPv6: '2001:db8::/32'.
  - Changed property nextHop (object)
    The IP address of the next hop gateway to route traffic. For IPv4: '192.168.1.1', For IPv6: '2001:db8::1'.
Changed content type : application/vnd.ruckus.v1+json
- Changed property requestId (object)
  The unique identifier for tracking this API operation request.
- Changed property response (object)
  The static route view, representing a manually configured IP route with destination network, next hop gateway, and administrative distance.
  New required properties:
  - destinationIp
  - nextHop
  - Changed property adminDistance (object)
    The administrative distance value for route preference, with lower values having higher priority.
  - Changed property destinationIp (object)
    The destination IP address in CIDR notation. For IPv4: '192.168.10.0/24', For IPv6: '2001:db8::/32'.
  - Changed property nextHop (object)
    The IP address of the next hop gateway to route traffic. For IPv4: '192.168.1.1', For IPv6: '2001:db8::1'.

DELETE /venues/{venueId}/switches/{switchId}/staticRoutes/{staticRouteId}

Return Type:

Changed response : 400 Bad Request

Bad/malformed request

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 401 Unauthorized

Unauthorized

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 403 Forbidden

Forbidden

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 404 Not Found

Requested resource or related entity not found

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 422 Unprocessable Entity

Validation error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 500 Internal Server Error

Internal Server Error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 200 OK

OK

Changed content type : application/json
- Changed property requestId (object)
  The unique identifier for tracking this API operation request.
- Changed property response (object)
  The empty view representing an API response with no data content, used for operations that return success status without additional information.
Changed content type : application/vnd.ruckus.v1+json
- Changed property requestId (object)
  The unique identifier for tracking this API operation request.
- Changed property response (object)
  The empty view representing an API response with no data content, used for operations that return success status without additional information.

GET /venues/{venueId}/switches/{switchId}/vePorts

Return Type:

Changed response : 400 Bad Request

Bad/malformed request

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 401 Unauthorized

Unauthorized

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 403 Forbidden

Forbidden

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 404 Not Found

Requested resource or related entity not found

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 422 Unprocessable Entity

Validation error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 500 Internal Server Error

Internal Server Error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

POST /venues/{venueId}/switches/{switchId}/vePorts

Return Type:

Changed response : 400 Bad Request

Bad/malformed request

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 401 Unauthorized

Unauthorized

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 403 Forbidden

Forbidden

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 404 Not Found

Requested resource or related entity not found

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 422 Unprocessable Entity

Validation error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 500 Internal Server Error

Internal Server Error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 201 Created

Created

Changed content type : application/json
- Changed property requestId (object)
  The unique identifier for tracking this API operation request.
- Changed property response (object)
  The virtual ethernet port view, representing a layer 3 virtual interface configuration with IP addressing and routing capabilities.
  - Changed property connectedVe (object)
    The flag indicating whether this VE interface is connected and operational.
  - Changed property deviceStatus (object)
    The operational status of the device associated with this VE interface.
  - Changed property dhcpRelayAgent (object)
    The IP address of the DHCP relay agent for forwarding DHCP requests across subnets.
  - Changed property egressAclName (object)
    The name of the Access Control List applied to egress traffic on this VE interface.
  - Changed property ingressAclName (object)
    The name of the Access Control List applied to ingress traffic on this VE interface.
  - Changed property ipAddress (object)
    The IPv4 address assigned to this virtual ethernet interface.
  - Changed property ipAddressType (object)
    The IP address assignment method for this VE interface: static or dynamic.
  - Changed property ipSubnetMask (object)
    The subnet mask for the IP address of this virtual ethernet interface.
  - Changed property name (object)
    The descriptive name assigned to the virtual ethernet interface.
  - Changed property ospfArea (object)
    The OSPF area identifier for routing protocol configuration on this VE interface.
  - Changed property switchId (object)
    The identifier of the switch where this VE interface is configured.
  - Changed property switchName (object)
    The name of the switch where this VE interface is configured.
  - Changed property syncedSwitchConfig (object)
    The flag indicating whether the VE interface configuration has been synchronized with the switch.
  - Changed property veId (object)
    The virtual ethernet interface identifier, used as the VE interface number.
  - Changed property vlanId (object)
    The VLAN ID associated with this virtual ethernet interface for layer 3 routing.
  - Changed property vsixEgressAclName (object)
    The name of the VSIX ACL applied to egress traffic for virtual switch integration.
  - Changed property vsixIngressAclName (object)
    The name of the VSIX ACL applied to ingress traffic for virtual switch integration.
Changed content type : application/vnd.ruckus.v1+json
- Changed property requestId (object)
  The unique identifier for tracking this API operation request.
- Changed property response (object)
  The virtual ethernet port view, representing a layer 3 virtual interface configuration with IP addressing and routing capabilities.
  - Changed property connectedVe (object)
    The flag indicating whether this VE interface is connected and operational.
  - Changed property deviceStatus (object)
    The operational status of the device associated with this VE interface.
  - Changed property dhcpRelayAgent (object)
    The IP address of the DHCP relay agent for forwarding DHCP requests across subnets.
  - Changed property egressAclName (object)
    The name of the Access Control List applied to egress traffic on this VE interface.
  - Changed property ingressAclName (object)
    The name of the Access Control List applied to ingress traffic on this VE interface.
  - Changed property ipAddress (object)
    The IPv4 address assigned to this virtual ethernet interface.
  - Changed property ipAddressType (object)
    The IP address assignment method for this VE interface: static or dynamic.
  - Changed property ipSubnetMask (object)
    The subnet mask for the IP address of this virtual ethernet interface.
  - Changed property name (object)
    The descriptive name assigned to the virtual ethernet interface.
  - Changed property ospfArea (object)
    The OSPF area identifier for routing protocol configuration on this VE interface.
  - Changed property switchId (object)
    The identifier of the switch where this VE interface is configured.
  - Changed property switchName (object)
    The name of the switch where this VE interface is configured.
  - Changed property syncedSwitchConfig (object)
    The flag indicating whether the VE interface configuration has been synchronized with the switch.
  - Changed property veId (object)
    The virtual ethernet interface identifier, used as the VE interface number.
  - Changed property vlanId (object)
    The VLAN ID associated with this virtual ethernet interface for layer 3 routing.
  - Changed property vsixEgressAclName (object)
    The name of the VSIX ACL applied to egress traffic for virtual switch integration.
  - Changed property vsixIngressAclName (object)
    The name of the VSIX ACL applied to ingress traffic for virtual switch integration.

DELETE /venues/{venueId}/switches/{switchId}/vePorts

Return Type:

Changed response : 400 Bad Request

Bad/malformed request

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 401 Unauthorized

Unauthorized

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 403 Forbidden

Forbidden

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 404 Not Found

Requested resource or related entity not found

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 422 Unprocessable Entity

Validation error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 500 Internal Server Error

Internal Server Error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 200 OK

OK

Changed content type : application/json
- Changed property requestId (object)
  The unique identifier for tracking this API operation request.
- Changed property response (object)
  The empty view representing an API response with no data content, used for operations that return success status without additional information.
Changed content type : application/vnd.ruckus.v1+json
- Changed property requestId (object)
  The unique identifier for tracking this API operation request.
- Changed property response (object)
  The empty view representing an API response with no data content, used for operations that return success status without additional information.

GET /venues/{venueId}/switches/{switchId}/vePorts/{vePortId}

Return Type:

Changed response : 200 OK

OK

Changed content type : application/json
- Changed property connectedVe (object)
  The flag indicating whether this VE interface is connected and operational.
- Changed property deviceStatus (object)
  The operational status of the device associated with this VE interface.
- Changed property dhcpRelayAgent (object)
  The IP address of the DHCP relay agent for forwarding DHCP requests across subnets.
- Changed property egressAclName (object)
  The name of the Access Control List applied to egress traffic on this VE interface.
- Changed property ingressAclName (object)
  The name of the Access Control List applied to ingress traffic on this VE interface.
- Changed property ipAddress (object)
  The IPv4 address assigned to this virtual ethernet interface.
- Changed property ipAddressType (object)
  The IP address assignment method for this VE interface: static or dynamic.
- Changed property ipSubnetMask (object)
  The subnet mask for the IP address of this virtual ethernet interface.
- Changed property name (object)
  The descriptive name assigned to the virtual ethernet interface.
- Changed property ospfArea (object)
  The OSPF area identifier for routing protocol configuration on this VE interface.
- Changed property switchId (object)
  The identifier of the switch where this VE interface is configured.
- Changed property switchName (object)
  The name of the switch where this VE interface is configured.
- Changed property syncedSwitchConfig (object)
  The flag indicating whether the VE interface configuration has been synchronized with the switch.
- Changed property veId (object)
  The virtual ethernet interface identifier, used as the VE interface number.
- Changed property vlanId (object)
  The VLAN ID associated with this virtual ethernet interface for layer 3 routing.
- Changed property vsixEgressAclName (object)
  The name of the VSIX ACL applied to egress traffic for virtual switch integration.
- Changed property vsixIngressAclName (object)
  The name of the VSIX ACL applied to ingress traffic for virtual switch integration.
Changed content type : application/vnd.ruckus.v1+json
- Changed property connectedVe (object)
  The flag indicating whether this VE interface is connected and operational.
- Changed property deviceStatus (object)
  The operational status of the device associated with this VE interface.
- Changed property dhcpRelayAgent (object)
  The IP address of the DHCP relay agent for forwarding DHCP requests across subnets.
- Changed property egressAclName (object)
  The name of the Access Control List applied to egress traffic on this VE interface.
- Changed property ingressAclName (object)
  The name of the Access Control List applied to ingress traffic on this VE interface.
- Changed property ipAddress (object)
  The IPv4 address assigned to this virtual ethernet interface.
- Changed property ipAddressType (object)
  The IP address assignment method for this VE interface: static or dynamic.
- Changed property ipSubnetMask (object)
  The subnet mask for the IP address of this virtual ethernet interface.
- Changed property name (object)
  The descriptive name assigned to the virtual ethernet interface.
- Changed property ospfArea (object)
  The OSPF area identifier for routing protocol configuration on this VE interface.
- Changed property switchId (object)
  The identifier of the switch where this VE interface is configured.
- Changed property switchName (object)
  The name of the switch where this VE interface is configured.
- Changed property syncedSwitchConfig (object)
  The flag indicating whether the VE interface configuration has been synchronized with the switch.
- Changed property veId (object)
  The virtual ethernet interface identifier, used as the VE interface number.
- Changed property vlanId (object)
  The VLAN ID associated with this virtual ethernet interface for layer 3 routing.
- Changed property vsixEgressAclName (object)
  The name of the VSIX ACL applied to egress traffic for virtual switch integration.
- Changed property vsixIngressAclName (object)
  The name of the VSIX ACL applied to ingress traffic for virtual switch integration.

Changed response : 400 Bad Request

Bad/malformed request

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 401 Unauthorized

Unauthorized

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 403 Forbidden

Forbidden

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 404 Not Found

Requested resource or related entity not found

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 422 Unprocessable Entity

Validation error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 500 Internal Server Error

Internal Server Error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

PUT /venues/{venueId}/switches/{switchId}/vePorts/{vePortId}

Request:

Changed content type : application/json

Changed property dhcpRelayAgent (object)
The IP address of the DHCP relay agent for forwarding DHCP requests across subnets.
Changed property egressAcl (object)
The name of the Access Control List applied to egress traffic on this VE interface.
Changed property ingressAcl (object)
The name of the Access Control List applied to ingress traffic on this VE interface.
Changed property ipAddress (object)
The IPv4 address assigned to this virtual ethernet interface.
Changed property ipAddressType (object)
The IP address assignment method for this VE interface: static or dynamic.
Changed property ipSubnetMask (object)
The subnet mask for the IP address of this virtual ethernet interface.
Changed property name (object)
The descriptive name assigned to the virtual ethernet interface.
Changed property ospfArea (object)
The OSPF area identifier for routing protocol configuration on this VE interface.
Changed property veId (object)
The virtual ethernet interface identifier, used as the VE interface number.
Changed property vlanId (object)
The VLAN ID associated with this virtual ethernet interface for layer 3 routing.

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

Changed property dhcpRelayAgent (object)
The IP address of the DHCP relay agent for forwarding DHCP requests across subnets.
Changed property egressAcl (object)
The name of the Access Control List applied to egress traffic on this VE interface.
Changed property ingressAcl (object)
The name of the Access Control List applied to ingress traffic on this VE interface.
Changed property ipAddress (object)
The IPv4 address assigned to this virtual ethernet interface.
Changed property ipAddressType (object)
The IP address assignment method for this VE interface: static or dynamic.
Changed property ipSubnetMask (object)
The subnet mask for the IP address of this virtual ethernet interface.
Changed property name (object)
The descriptive name assigned to the virtual ethernet interface.
Changed property ospfArea (object)
The OSPF area identifier for routing protocol configuration on this VE interface.
Changed property veId (object)
The virtual ethernet interface identifier, used as the VE interface number.
Changed property vlanId (object)
The VLAN ID associated with this virtual ethernet interface for layer 3 routing.

Return Type:

Changed response : 400 Bad Request

Bad/malformed request

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 401 Unauthorized

Unauthorized

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 403 Forbidden

Forbidden

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 404 Not Found

Requested resource or related entity not found

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 422 Unprocessable Entity

Validation error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 500 Internal Server Error

Internal Server Error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 200 OK

OK

Changed content type : application/json
- Changed property requestId (object)
  The unique identifier for tracking this API operation request.
- Changed property response (object)
  The virtual ethernet port view, representing a layer 3 virtual interface configuration with IP addressing and routing capabilities.
  - Changed property connectedVe (object)
    The flag indicating whether this VE interface is connected and operational.
  - Changed property deviceStatus (object)
    The operational status of the device associated with this VE interface.
  - Changed property dhcpRelayAgent (object)
    The IP address of the DHCP relay agent for forwarding DHCP requests across subnets.
  - Changed property egressAclName (object)
    The name of the Access Control List applied to egress traffic on this VE interface.
  - Changed property ingressAclName (object)
    The name of the Access Control List applied to ingress traffic on this VE interface.
  - Changed property ipAddress (object)
    The IPv4 address assigned to this virtual ethernet interface.
  - Changed property ipAddressType (object)
    The IP address assignment method for this VE interface: static or dynamic.
  - Changed property ipSubnetMask (object)
    The subnet mask for the IP address of this virtual ethernet interface.
  - Changed property name (object)
    The descriptive name assigned to the virtual ethernet interface.
  - Changed property ospfArea (object)
    The OSPF area identifier for routing protocol configuration on this VE interface.
  - Changed property switchId (object)
    The identifier of the switch where this VE interface is configured.
  - Changed property switchName (object)
    The name of the switch where this VE interface is configured.
  - Changed property syncedSwitchConfig (object)
    The flag indicating whether the VE interface configuration has been synchronized with the switch.
  - Changed property veId (object)
    The virtual ethernet interface identifier, used as the VE interface number.
  - Changed property vlanId (object)
    The VLAN ID associated with this virtual ethernet interface for layer 3 routing.
  - Changed property vsixEgressAclName (object)
    The name of the VSIX ACL applied to egress traffic for virtual switch integration.
  - Changed property vsixIngressAclName (object)
    The name of the VSIX ACL applied to ingress traffic for virtual switch integration.
Changed content type : application/vnd.ruckus.v1+json
- Changed property requestId (object)
  The unique identifier for tracking this API operation request.
- Changed property response (object)
  The virtual ethernet port view, representing a layer 3 virtual interface configuration with IP addressing and routing capabilities.
  - Changed property connectedVe (object)
    The flag indicating whether this VE interface is connected and operational.
  - Changed property deviceStatus (object)
    The operational status of the device associated with this VE interface.
  - Changed property dhcpRelayAgent (object)
    The IP address of the DHCP relay agent for forwarding DHCP requests across subnets.
  - Changed property egressAclName (object)
    The name of the Access Control List applied to egress traffic on this VE interface.
  - Changed property ingressAclName (object)
    The name of the Access Control List applied to ingress traffic on this VE interface.
  - Changed property ipAddress (object)
    The IPv4 address assigned to this virtual ethernet interface.
  - Changed property ipAddressType (object)
    The IP address assignment method for this VE interface: static or dynamic.
  - Changed property ipSubnetMask (object)
    The subnet mask for the IP address of this virtual ethernet interface.
  - Changed property name (object)
    The descriptive name assigned to the virtual ethernet interface.
  - Changed property ospfArea (object)
    The OSPF area identifier for routing protocol configuration on this VE interface.
  - Changed property switchId (object)
    The identifier of the switch where this VE interface is configured.
  - Changed property switchName (object)
    The name of the switch where this VE interface is configured.
  - Changed property syncedSwitchConfig (object)
    The flag indicating whether the VE interface configuration has been synchronized with the switch.
  - Changed property veId (object)
    The virtual ethernet interface identifier, used as the VE interface number.
  - Changed property vlanId (object)
    The VLAN ID associated with this virtual ethernet interface for layer 3 routing.
  - Changed property vsixEgressAclName (object)
    The name of the VSIX ACL applied to egress traffic for virtual switch integration.
  - Changed property vsixIngressAclName (object)
    The name of the VSIX ACL applied to ingress traffic for virtual switch integration.

DELETE /venues/{venueId}/switches/{switchId}/vePorts/{vePortId}

Return Type:

Changed response : 400 Bad Request

Bad/malformed request

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 401 Unauthorized

Unauthorized

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 403 Forbidden

Forbidden

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 404 Not Found

Requested resource or related entity not found

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 422 Unprocessable Entity

Validation error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 500 Internal Server Error

Internal Server Error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 200 OK

OK

Changed content type : application/json
- Changed property requestId (object)
  The unique identifier for tracking this API operation request.
- Changed property response (object)
  The empty view representing an API response with no data content, used for operations that return success status without additional information.
Changed content type : application/vnd.ruckus.v1+json
- Changed property requestId (object)
  The unique identifier for tracking this API operation request.
- Changed property response (object)
  The empty view representing an API response with no data content, used for operations that return success status without additional information.

GET /venues/{venueId}/switches/{switchId}/vlans

Get VLAN VE Ports

Return Type:

Changed response : 200 OK

OK

Changed content type : application/json
- Changed property id (object)
  The identifier
- Changed property usedByVePort (object)
  The flag indicating whether this VLAN is associated with a VE (virtual Ethernet) interface for layer 3 routing.
- Changed property vlanId (object)
  The VLAN identifier, uniquely identifying this VLAN.
- Changed property vlanName (object)
  The descriptive name assigned to this VLAN for identification purposes.
Changed content type : application/vnd.ruckus.v1+json
- Changed property id (object)
  The identifier
- Changed property usedByVePort (object)
  The flag indicating whether this VLAN is associated with a VE (virtual Ethernet) interface for layer 3 routing.
- Changed property vlanId (object)
  The VLAN identifier, uniquely identifying this VLAN.
- Changed property vlanName (object)
  The descriptive name assigned to this VLAN for identification purposes.

Changed response : 400 Bad Request

Bad/malformed request

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 401 Unauthorized

Unauthorized

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 403 Forbidden

Forbidden

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 404 Not Found

Requested resource or related entity not found

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 422 Unprocessable Entity

Validation error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 500 Internal Server Error

Internal Server Error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

POST /venues/{venueId}/switches/{switchId}/vlans

Request:

Changed content type : application/json

Changed property arpInspection (object)
The flag indicating whether ARP inspection is enabled for this VLAN to prevent ARP spoofing attacks.
Changed property enableAsDefaultVlan (object)
The flag indicating whether this VLAN should be configured as the default VLAN for the switch.
Changed property igmpSnooping (object)
The IGMP snooping mode for this VLAN to optimize multicast traffic delivery.
Changed property ipv4DhcpSnooping (object)
The flag indicating whether IPv4 DHCP snooping is enabled for this VLAN to prevent rogue DHCP servers.
Changed property multicastVersion (object)
The IGMP version number used for multicast group management in this VLAN.
Changed property spanningTreeProtocol (object)
STP (Spanning Tree Protocol) variant enabled for this VLAN.
Changed property switchVlanPortModels (object)
The set of port model configurations specific to this VLAN on different switch models in a stack.
Changed property vlanId (object)
The VLAN identifier, ranging from 1 to 4095, uniquely identifying this VLAN on the switch.
Changed property vlanName (object)
The descriptive name assigned to this VLAN, limited to 32 characters.

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

Changed property arpInspection (object)
The flag indicating whether ARP inspection is enabled for this VLAN to prevent ARP spoofing attacks.
Changed property enableAsDefaultVlan (object)
The flag indicating whether this VLAN should be configured as the default VLAN for the switch.
Changed property igmpSnooping (object)
The IGMP snooping mode for this VLAN to optimize multicast traffic delivery.
Changed property ipv4DhcpSnooping (object)
The flag indicating whether IPv4 DHCP snooping is enabled for this VLAN to prevent rogue DHCP servers.
Changed property multicastVersion (object)
The IGMP version number used for multicast group management in this VLAN.
Changed property spanningTreeProtocol (object)
STP (Spanning Tree Protocol) variant enabled for this VLAN.
Changed property switchVlanPortModels (object)
The set of port model configurations specific to this VLAN on different switch models in a stack.
Changed property vlanId (object)
The VLAN identifier, ranging from 1 to 4095, uniquely identifying this VLAN on the switch.
Changed property vlanName (object)
The descriptive name assigned to this VLAN, limited to 32 characters.

Return Type:

Changed response : 400 Bad Request

Bad/malformed request

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 401 Unauthorized

Unauthorized

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 403 Forbidden

Forbidden

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 404 Not Found

Requested resource or related entity not found

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 422 Unprocessable Entity

Validation error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 500 Internal Server Error

Internal Server Error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 201 Created

Created

Changed content type : application/json
- Changed property requestId (object)
  The unique identifier for tracking this API operation request.
- Changed property response (object)
  The switch VLAN view, representing a VLAN configuration on a specific switch including port assignments, Layer 2 security features, and authentication settings.
  - Changed property arpInspection (object)
    The flag indicating whether ARP inspection is enabled for this VLAN to prevent ARP spoofing attacks.
  - Changed property enableAsDefaultVlan (object)
    The flag indicating whether this VLAN is configured as the default VLAN for the switch.
  - Changed property igmpSnooping (object)
    The IGMP snooping mode for this VLAN to optimize multicast traffic delivery.
  - Changed property ipv4DhcpSnooping (object)
    The flag indicating whether IPv4 DHCP snooping is enabled for this VLAN to prevent rogue DHCP servers.
  - Changed property isAuthDefaultVlan (object)
    The flag indicating whether this VLAN is configured as the authentication default VLAN for 802.1X.
  - Changed property isAuthVlan (object)
    The flag indicating whether this VLAN is used for authentication purposes such as guest, restricted, or critical VLANs.
  - Changed property multicastVersion (object)
    The IGMP version number used for multicast group management in this VLAN.
  - Changed property spanningTreeProtocol (object)
    The STP (Spanning Tree Protocol) variant enabled for this VLAN.
  - Changed property switchVlanPortModels (object)
    The set of port model configurations specific to this VLAN on different switch models in a stack.
  - Changed property taggedPorts (object)
    The comma separated list of port identifiers configured as tagged (trunk) ports for this VLAN.
  - Changed property untaggedPorts (object)
    The comma separated list of port identifiers configured as untagged (access) ports for this VLAN.
  - Changed property usedByVePort (object)
    The flag indicating whether this VLAN is associated with a VE (Virtual Ethernet) interface for layer 3 routing.
  - Changed property vlanId (object)
    The VLAN identifier, ranging from 1 to 4095, uniquely identifying this VLAN on the switch.
  - Changed property vlanName (object)
    The descriptive name assigned to this VLAN for identification purposes.
Changed content type : application/vnd.ruckus.v1+json
- Changed property requestId (object)
  The unique identifier for tracking this API operation request.
- Changed property response (object)
  The switch VLAN view, representing a VLAN configuration on a specific switch including port assignments, Layer 2 security features, and authentication settings.
  - Changed property arpInspection (object)
    The flag indicating whether ARP inspection is enabled for this VLAN to prevent ARP spoofing attacks.
  - Changed property enableAsDefaultVlan (object)
    The flag indicating whether this VLAN is configured as the default VLAN for the switch.
  - Changed property igmpSnooping (object)
    The IGMP snooping mode for this VLAN to optimize multicast traffic delivery.
  - Changed property ipv4DhcpSnooping (object)
    The flag indicating whether IPv4 DHCP snooping is enabled for this VLAN to prevent rogue DHCP servers.
  - Changed property isAuthDefaultVlan (object)
    The flag indicating whether this VLAN is configured as the authentication default VLAN for 802.1X.
  - Changed property isAuthVlan (object)
    The flag indicating whether this VLAN is used for authentication purposes such as guest, restricted, or critical VLANs.
  - Changed property multicastVersion (object)
    The IGMP version number used for multicast group management in this VLAN.
  - Changed property spanningTreeProtocol (object)
    The STP (Spanning Tree Protocol) variant enabled for this VLAN.
  - Changed property switchVlanPortModels (object)
    The set of port model configurations specific to this VLAN on different switch models in a stack.
  - Changed property taggedPorts (object)
    The comma separated list of port identifiers configured as tagged (trunk) ports for this VLAN.
  - Changed property untaggedPorts (object)
    The comma separated list of port identifiers configured as untagged (access) ports for this VLAN.
  - Changed property usedByVePort (object)
    The flag indicating whether this VLAN is associated with a VE (Virtual Ethernet) interface for layer 3 routing.
  - Changed property vlanId (object)
    The VLAN identifier, ranging from 1 to 4095, uniquely identifying this VLAN on the switch.
  - Changed property vlanName (object)
    The descriptive name assigned to this VLAN for identification purposes.

DELETE /venues/{venueId}/switches/{switchId}/vlans

Return Type:

Changed response : 400 Bad Request

Bad/malformed request

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 401 Unauthorized

Unauthorized

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 403 Forbidden

Forbidden

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 404 Not Found

Requested resource or related entity not found

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 422 Unprocessable Entity

Validation error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 500 Internal Server Error

Internal Server Error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 200 OK

OK

Changed content type : application/json
- Changed property requestId (object)
  The unique identifier for tracking this API operation request.
- Changed property response (object)
  The empty view representing an API response with no data content, used for operations that return success status without additional information.
Changed content type : application/vnd.ruckus.v1+json
- Changed property requestId (object)
  The unique identifier for tracking this API operation request.
- Changed property response (object)
  The empty view representing an API response with no data content, used for operations that return success status without additional information.

GET /venues/{venueId}/switches/{switchId}/vlans/{vlanId}

Return Type:

Changed response : 200 OK

OK

Changed content type : application/json
- Changed property arpInspection (object)
  The flag indicating whether ARP inspection is enabled for this VLAN to prevent ARP spoofing attacks.
- Changed property enableAsDefaultVlan (object)
  The flag indicating whether this VLAN is configured as the default VLAN for the switch.
- Changed property igmpSnooping (object)
  The IGMP snooping mode for this VLAN to optimize multicast traffic delivery.
- Changed property ipv4DhcpSnooping (object)
  The flag indicating whether IPv4 DHCP snooping is enabled for this VLAN to prevent rogue DHCP servers.
- Changed property isAuthDefaultVlan (object)
  The flag indicating whether this VLAN is configured as the authentication default VLAN for 802.1X.
- Changed property isAuthVlan (object)
  The flag indicating whether this VLAN is used for authentication purposes such as guest, restricted, or critical VLANs.
- Changed property multicastVersion (object)
  The IGMP version number used for multicast group management in this VLAN.
- Changed property spanningTreeProtocol (object)
  The STP (Spanning Tree Protocol) variant enabled for this VLAN.
- Changed property switchVlanPortModels (object)
  The set of port model configurations specific to this VLAN on different switch models in a stack.
- Changed property taggedPorts (object)
  The comma separated list of port identifiers configured as tagged (trunk) ports for this VLAN.
- Changed property untaggedPorts (object)
  The comma separated list of port identifiers configured as untagged (access) ports for this VLAN.
- Changed property usedByVePort (object)
  The flag indicating whether this VLAN is associated with a VE (Virtual Ethernet) interface for layer 3 routing.
- Changed property vlanId (object)
  The VLAN identifier, ranging from 1 to 4095, uniquely identifying this VLAN on the switch.
- Changed property vlanName (object)
  The descriptive name assigned to this VLAN for identification purposes.
Changed content type : application/vnd.ruckus.v1+json
- Changed property arpInspection (object)
  The flag indicating whether ARP inspection is enabled for this VLAN to prevent ARP spoofing attacks.
- Changed property enableAsDefaultVlan (object)
  The flag indicating whether this VLAN is configured as the default VLAN for the switch.
- Changed property igmpSnooping (object)
  The IGMP snooping mode for this VLAN to optimize multicast traffic delivery.
- Changed property ipv4DhcpSnooping (object)
  The flag indicating whether IPv4 DHCP snooping is enabled for this VLAN to prevent rogue DHCP servers.
- Changed property isAuthDefaultVlan (object)
  The flag indicating whether this VLAN is configured as the authentication default VLAN for 802.1X.
- Changed property isAuthVlan (object)
  The flag indicating whether this VLAN is used for authentication purposes such as guest, restricted, or critical VLANs.
- Changed property multicastVersion (object)
  The IGMP version number used for multicast group management in this VLAN.
- Changed property spanningTreeProtocol (object)
  The STP (Spanning Tree Protocol) variant enabled for this VLAN.
- Changed property switchVlanPortModels (object)
  The set of port model configurations specific to this VLAN on different switch models in a stack.
- Changed property taggedPorts (object)
  The comma separated list of port identifiers configured as tagged (trunk) ports for this VLAN.
- Changed property untaggedPorts (object)
  The comma separated list of port identifiers configured as untagged (access) ports for this VLAN.
- Changed property usedByVePort (object)
  The flag indicating whether this VLAN is associated with a VE (Virtual Ethernet) interface for layer 3 routing.
- Changed property vlanId (object)
  The VLAN identifier, ranging from 1 to 4095, uniquely identifying this VLAN on the switch.
- Changed property vlanName (object)
  The descriptive name assigned to this VLAN for identification purposes.

Changed response : 400 Bad Request

Bad/malformed request

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 401 Unauthorized

Unauthorized

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 403 Forbidden

Forbidden

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 404 Not Found

Requested resource or related entity not found

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 422 Unprocessable Entity

Validation error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 500 Internal Server Error

Internal Server Error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

PUT /venues/{venueId}/switches/{switchId}/vlans/{vlanId}

Request:

Changed content type : application/json

Changed property arpInspection (object)
The flag indicating whether ARP inspection is enabled for this VLAN to prevent ARP spoofing attacks.
Changed property enableAsDefaultVlan (object)
The flag indicating whether this VLAN should be configured as the default VLAN for the switch.
Changed property igmpSnooping (object)
The IGMP snooping mode for this VLAN to optimize multicast traffic delivery.
Changed property ipv4DhcpSnooping (object)
The flag indicating whether IPv4 DHCP snooping is enabled for this VLAN to prevent rogue DHCP servers.
Changed property multicastVersion (object)
The IGMP version number used for multicast group management in this VLAN.
Changed property spanningTreeProtocol (object)
STP (Spanning Tree Protocol) variant enabled for this VLAN.
Changed property switchVlanPortModels (object)
The set of port model configurations specific to this VLAN on different switch models in a stack.
Changed property vlanId (object)
The VLAN identifier, ranging from 1 to 4095, uniquely identifying this VLAN on the switch.
Changed property vlanName (object)
The descriptive name assigned to this VLAN, limited to 32 characters.

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

Changed property arpInspection (object)
The flag indicating whether ARP inspection is enabled for this VLAN to prevent ARP spoofing attacks.
Changed property enableAsDefaultVlan (object)
The flag indicating whether this VLAN should be configured as the default VLAN for the switch.
Changed property igmpSnooping (object)
The IGMP snooping mode for this VLAN to optimize multicast traffic delivery.
Changed property ipv4DhcpSnooping (object)
The flag indicating whether IPv4 DHCP snooping is enabled for this VLAN to prevent rogue DHCP servers.
Changed property multicastVersion (object)
The IGMP version number used for multicast group management in this VLAN.
Changed property spanningTreeProtocol (object)
STP (Spanning Tree Protocol) variant enabled for this VLAN.
Changed property switchVlanPortModels (object)
The set of port model configurations specific to this VLAN on different switch models in a stack.
Changed property vlanId (object)
The VLAN identifier, ranging from 1 to 4095, uniquely identifying this VLAN on the switch.
Changed property vlanName (object)
The descriptive name assigned to this VLAN, limited to 32 characters.

Return Type:

Changed response : 400 Bad Request

Bad/malformed request

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 401 Unauthorized

Unauthorized

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 403 Forbidden

Forbidden

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 404 Not Found

Requested resource or related entity not found

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 422 Unprocessable Entity

Validation error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 500 Internal Server Error

Internal Server Error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 200 OK

OK

Changed content type : application/json
- Changed property requestId (object)
  The unique identifier for tracking this API operation request.
- Changed property response (object)
  The switch VLAN view, representing a VLAN configuration on a specific switch including port assignments, Layer 2 security features, and authentication settings.
  - Changed property arpInspection (object)
    The flag indicating whether ARP inspection is enabled for this VLAN to prevent ARP spoofing attacks.
  - Changed property enableAsDefaultVlan (object)
    The flag indicating whether this VLAN is configured as the default VLAN for the switch.
  - Changed property igmpSnooping (object)
    The IGMP snooping mode for this VLAN to optimize multicast traffic delivery.
  - Changed property ipv4DhcpSnooping (object)
    The flag indicating whether IPv4 DHCP snooping is enabled for this VLAN to prevent rogue DHCP servers.
  - Changed property isAuthDefaultVlan (object)
    The flag indicating whether this VLAN is configured as the authentication default VLAN for 802.1X.
  - Changed property isAuthVlan (object)
    The flag indicating whether this VLAN is used for authentication purposes such as guest, restricted, or critical VLANs.
  - Changed property multicastVersion (object)
    The IGMP version number used for multicast group management in this VLAN.
  - Changed property spanningTreeProtocol (object)
    The STP (Spanning Tree Protocol) variant enabled for this VLAN.
  - Changed property switchVlanPortModels (object)
    The set of port model configurations specific to this VLAN on different switch models in a stack.
  - Changed property taggedPorts (object)
    The comma separated list of port identifiers configured as tagged (trunk) ports for this VLAN.
  - Changed property untaggedPorts (object)
    The comma separated list of port identifiers configured as untagged (access) ports for this VLAN.
  - Changed property usedByVePort (object)
    The flag indicating whether this VLAN is associated with a VE (Virtual Ethernet) interface for layer 3 routing.
  - Changed property vlanId (object)
    The VLAN identifier, ranging from 1 to 4095, uniquely identifying this VLAN on the switch.
  - Changed property vlanName (object)
    The descriptive name assigned to this VLAN for identification purposes.
Changed content type : application/vnd.ruckus.v1+json
- Changed property requestId (object)
  The unique identifier for tracking this API operation request.
- Changed property response (object)
  The switch VLAN view, representing a VLAN configuration on a specific switch including port assignments, Layer 2 security features, and authentication settings.
  - Changed property arpInspection (object)
    The flag indicating whether ARP inspection is enabled for this VLAN to prevent ARP spoofing attacks.
  - Changed property enableAsDefaultVlan (object)
    The flag indicating whether this VLAN is configured as the default VLAN for the switch.
  - Changed property igmpSnooping (object)
    The IGMP snooping mode for this VLAN to optimize multicast traffic delivery.
  - Changed property ipv4DhcpSnooping (object)
    The flag indicating whether IPv4 DHCP snooping is enabled for this VLAN to prevent rogue DHCP servers.
  - Changed property isAuthDefaultVlan (object)
    The flag indicating whether this VLAN is configured as the authentication default VLAN for 802.1X.
  - Changed property isAuthVlan (object)
    The flag indicating whether this VLAN is used for authentication purposes such as guest, restricted, or critical VLANs.
  - Changed property multicastVersion (object)
    The IGMP version number used for multicast group management in this VLAN.
  - Changed property spanningTreeProtocol (object)
    The STP (Spanning Tree Protocol) variant enabled for this VLAN.
  - Changed property switchVlanPortModels (object)
    The set of port model configurations specific to this VLAN on different switch models in a stack.
  - Changed property taggedPorts (object)
    The comma separated list of port identifiers configured as tagged (trunk) ports for this VLAN.
  - Changed property untaggedPorts (object)
    The comma separated list of port identifiers configured as untagged (access) ports for this VLAN.
  - Changed property usedByVePort (object)
    The flag indicating whether this VLAN is associated with a VE (Virtual Ethernet) interface for layer 3 routing.
  - Changed property vlanId (object)
    The VLAN identifier, ranging from 1 to 4095, uniquely identifying this VLAN on the switch.
  - Changed property vlanName (object)
    The descriptive name assigned to this VLAN for identification purposes.

DELETE /venues/{venueId}/switches/{switchId}/vlans/{vlanId}

Return Type:

Changed response : 400 Bad Request

Bad/malformed request

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 401 Unauthorized

Unauthorized

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 403 Forbidden

Forbidden

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 404 Not Found

Requested resource or related entity not found

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 422 Unprocessable Entity

Validation error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 500 Internal Server Error

Internal Server Error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 200 OK

OK

Changed content type : application/json
- Changed property requestId (object)
  The unique identifier for tracking this API operation request.
- Changed property response (object)
  The empty view representing an API response with no data content, used for operations that return success status without additional information.
Changed content type : application/vnd.ruckus.v1+json
- Changed property requestId (object)
  The unique identifier for tracking this API operation request.
- Changed property response (object)
  The empty view representing an API response with no data content, used for operations that return success status without additional information.

POST /venues/{venueId}/transactions/{transactionId}/configHistDetails

Request:

Changed content type : application/json

Deleted property orderBy (object)
Changed property filterByConfigType (object)
The configuration type filter to limit results to specific types such as VLAN, ACL, or port configurations.
Changed property filterByStatus (object)
The status filter to limit results to configuration deployments with specific status values such as success, failed, or in progress.
Changed property limit (object)
The maximum number of configuration history records to return per page, defaulting to 8.
Changed property page (object)
The page number for pagination, starting from 1, defaulting to 1.
Changed property pageSize (object)
The page size for pagination in the new request format, superseding the limit parameter when provided.
Changed property sortField (object)
The sort column for ordering configuration history records in the new request format.
Changed property sortOrder (object)
The sort order direction, either ascending or descending, for the new request format.
Changed property filters (object)
Schema for filtering configuration history records by criteria.
- Changed property configType (object)
  The type of configuration for filtering results.
- Changed property filterByStatus (object)
  Filter configuration history records by status.
  Added enum values:
  - ALL
  - SUCCESS
  - FAILED
  - NOTIFY_SUCCESS
Changed property sortInfo (object)
Schema for sorting configuration history details by column and direction.
- Changed property dir (object)
  The sort direction, ascending or descending.
- Changed property sortColumn (object)
  The column name used for sorting results.

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

Deleted property orderBy (object)
Changed property filterByConfigType (object)
The configuration type filter to limit results to specific types such as VLAN, ACL, or port configurations.
Changed property filterByStatus (object)
The status filter to limit results to configuration deployments with specific status values such as success, failed, or in progress.
Changed property limit (object)
The maximum number of configuration history records to return per page, defaulting to 8.
Changed property page (object)
The page number for pagination, starting from 1, defaulting to 1.
Changed property pageSize (object)
The page size for pagination in the new request format, superseding the limit parameter when provided.
Changed property sortField (object)
The sort column for ordering configuration history records in the new request format.
Changed property sortOrder (object)
The sort order direction, either ascending or descending, for the new request format.
Changed property filters (object)
Schema for filtering configuration history records by criteria.
- Changed property configType (object)
  The type of configuration for filtering results.
- Changed property filterByStatus (object)
  Filter configuration history records by status.
  Added enum values:
  - ALL
  - SUCCESS
  - FAILED
  - NOTIFY_SUCCESS
Changed property sortInfo (object)
Schema for sorting configuration history details by column and direction.
- Changed property dir (object)
  The sort direction, ascending or descending.
- Changed property sortColumn (object)
  The column name used for sorting results.

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

Changed property filterByStatus (object)
The status filter to limit results to configuration deployments with specific status values.
Changed property limit (object)
The maximum number of configuration history records to return, defaulting to 8.
Changed property sortInfo (object)
Schema for sorting configuration history details by column and direction.
- Changed property dir (object)
  The sort direction, ascending or descending.
- Changed property sortColumn (object)
  The column name used for sorting results.

Return Type:

Changed response : 200 OK

OK

Changed content type : application/json
- Changed property id (object)
  The identifier
- Changed property list (object)
  The list of configuration history information records containing deployment details and status.
- Changed property totalCount (object)
  The total number of configuration history records matching the query criteria.
Changed content type : application/vnd.ruckus.v1+json
- Changed property id (object)
  The identifier
- Changed property list (object)
  The list of configuration history information records containing deployment details and status.
- Changed property totalCount (object)
  The total number of configuration history records matching the query criteria.
Changed content type : application/vnd.ruckus.v1.1+json
- Changed property list (object)
  The list of configuration history information records containing deployment details and status.
- Changed property totalCount (object)
  The total number of configuration history records matching the query criteria.

Changed response : 400 Bad Request

Bad/malformed request

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 401 Unauthorized

Unauthorized

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 403 Forbidden

Forbidden

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 404 Not Found

Requested resource or related entity not found

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 422 Unprocessable Entity

Validation error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 500 Internal Server Error

Internal Server Error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

GET /venues/{venueId}/vlans

Return Type:

Changed response : 200 OK

OK

Changed content type : application/json
- Changed property arpInspection (object)
  The flag indicating whether ARP inspection is enabled for this VLAN to prevent ARP spoofing attacks.
- Changed property arpInspectionTrustPort (object)
  The comma separated list of port identifiers trusted for ARP inspection, bypassing ARP validation.
- Changed property id (object)
  The identifier
- Changed property igmpSnooping (object)
  The IGMP snooping mode for this VLAN to optimize multicast traffic delivery.
- Changed property ipv4DhcpSnooping (object)
  The flag indicating whether IPv4 DHCP snooping is enabled for this VLAN to prevent rogue DHCP servers.
- Changed property ipv4DhcpSnoopingTrustPort (object)
  The comma separated list of port identifiers trusted for DHCP snooping, allowing DHCP server responses.
- Changed property multicastVersion (object)
  The IGMP version number used for multicast group management in this VLAN.
- Changed property rootBridgeFamilyId (object)
  The switch family identifier for the root bridge in spanning tree topology.
- Changed property spanningTreePriority (object)
  The STP (Spanning Tree Protocol) bridge priority value for this VLAN, used in root bridge election.
- Changed property spanningTreeProtocol (object)
  The STP (Spanning Tree Protocol) variant enabled for this VLAN.
- Changed property switchFamilyModels (object)
  The set of switch family models with specific configurations for this VLAN across different hardware types.
- Changed property vlanId (object)
  The VLAN identifier, ranging from 1 to 4095, uniquely identifying this VLAN.
- Changed property vlanName (object)
  The descriptive name assigned to this VLAN for identification purposes.
Changed content type : application/vnd.ruckus.v1+json
- Changed property arpInspection (object)
  The flag indicating whether ARP inspection is enabled for this VLAN to prevent ARP spoofing attacks.
- Changed property arpInspectionTrustPort (object)
  The comma separated list of port identifiers trusted for ARP inspection, bypassing ARP validation.
- Changed property id (object)
  The identifier
- Changed property igmpSnooping (object)
  The IGMP snooping mode for this VLAN to optimize multicast traffic delivery.
- Changed property ipv4DhcpSnooping (object)
  The flag indicating whether IPv4 DHCP snooping is enabled for this VLAN to prevent rogue DHCP servers.
- Changed property ipv4DhcpSnoopingTrustPort (object)
  The comma separated list of port identifiers trusted for DHCP snooping, allowing DHCP server responses.
- Changed property multicastVersion (object)
  The IGMP version number used for multicast group management in this VLAN.
- Changed property rootBridgeFamilyId (object)
  The switch family identifier for the root bridge in spanning tree topology.
- Changed property spanningTreePriority (object)
  The STP (Spanning Tree Protocol) bridge priority value for this VLAN, used in root bridge election.
- Changed property spanningTreeProtocol (object)
  The STP (Spanning Tree Protocol) variant enabled for this VLAN.
- Changed property switchFamilyModels (object)
  The set of switch family models with specific configurations for this VLAN across different hardware types.
- Changed property vlanId (object)
  The VLAN identifier, ranging from 1 to 4095, uniquely identifying this VLAN.
- Changed property vlanName (object)
  The descriptive name assigned to this VLAN for identification purposes.

Changed response : 400 Bad Request

Bad/malformed request

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 401 Unauthorized

Unauthorized

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 403 Forbidden

Forbidden

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 404 Not Found

Requested resource or related entity not found

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 422 Unprocessable Entity

Validation error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 500 Internal Server Error

Internal Server Error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

POST /venues/{venueId}/vlans

Return Type:

Changed response : 400 Bad Request

Bad/malformed request

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 401 Unauthorized

Unauthorized

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 403 Forbidden

Forbidden

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 404 Not Found

Requested resource or related entity not found

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 422 Unprocessable Entity

Validation error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 500 Internal Server Error

Internal Server Error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 201 Created

Created

Changed content type : application/json
- Changed property requestId (object)
  The unique identifier for tracking this API operation request.
- Changed property response (object)
  The empty view representing an API response with no data content, used for operations that return success status without additional information.
Changed content type : application/vnd.ruckus.v1+json
- Changed property requestId (object)
  The unique identifier for tracking this API operation request.
- Changed property response (object)
  The empty view representing an API response with no data content, used for operations that return success status without additional information.

POST /webAuthPageTemplates

Request:

Changed content type : application/json

Changed property id (object)
Unique identifier for the web auth page template (maximum 37 characters).
Changed property name (object)
Template name for identification (maximum 32 characters, required).
Changed property tag (object)
Tag for categorizing or grouping templates (maximum 255 characters).
Changed property tenantId (object)
The unique identifier of the tenant.
Changed property webAuthCustomBottom (object)
Custom text displayed at the bottom section of the login page (maximum 255 characters).
Changed property webAuthCustomLoginButton (object)
Custom text for the login button (maximum 32 characters).
Changed property webAuthCustomTitle (object)
Custom title text displayed at the top of the login page (maximum 128 characters).
Changed property webAuthCustomTop (object)
Custom text displayed at the top section of the login page (maximum 255 characters).
Changed property webAuthPasswordLabel (object)
Custom label text for the password input field (maximum 32 characters).

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

Changed property id (object)
Unique identifier for the web auth page template (maximum 37 characters).
Changed property name (object)
Template name for identification (maximum 32 characters, required).
Changed property tag (object)
Tag for categorizing or grouping templates (maximum 255 characters).
Changed property tenantId (object)
The unique identifier of the tenant.
Changed property webAuthCustomBottom (object)
Custom text displayed at the bottom section of the login page (maximum 255 characters).
Changed property webAuthCustomLoginButton (object)
Custom text for the login button (maximum 32 characters).
Changed property webAuthCustomTitle (object)
Custom title text displayed at the top of the login page (maximum 128 characters).
Changed property webAuthCustomTop (object)
Custom text displayed at the top section of the login page (maximum 255 characters).
Changed property webAuthPasswordLabel (object)
Custom label text for the password input field (maximum 32 characters).

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

Changed property name (object)
The unique name of the web authentication page template.
Changed property switchCount (object)
The total number of switches where this web authentication page template is currently applied.
Changed property venueCount (object)
The total number of venues where this web authentication page template is currently applied.
Changed property webAuthCustomBottom (object)
The custom text or HTML content displayed at the bottom section of the web authentication page.
Changed property webAuthCustomLoginButton (object)
The custom label text for the login button on the web authentication page.
Changed property webAuthCustomTitle (object)
The custom title text displayed at the top of the web authentication page.
Changed property webAuthCustomTop (object)
The custom text or HTML content displayed at the top section of the web authentication page.
Changed property webAuthPasswordLabel (object)
The custom label text for the password input field on the web authentication page.

Return Type:

Changed response : 200 OK

OK

Changed content type : application/json
- Added property SwitchAndVenue_V1 (object)
  The list of switches and venues where this Web Authentication page template is deployed.
- Added property WebAuthPageTemplateList_V1 (object)
  The list of Web Authentication page template instances for batch operations or nested template management.
- Deleted property switchVenueInfos (object)
- Deleted property webAuthPageTemplateViewList (object)
- Changed property id (object)
  The unique identifier of the Web Authentication page template.
- Changed property name (object)
  The name of the Web Authentication page template for identification.
- Changed property switchCount (object)
  The number of switches where this Web Authentication page template is applied.
- Changed property tag (object)
  The tag or label used for categorizing and filtering the Web Authentication page template.
- Changed property venueCount (object)
  The number of venues where this Web Authentication page template is applied.
- Changed property webAuthCustomBottom (object)
  The custom HTML or text content displayed at the bottom section of the Web Authentication login page.
- Changed property webAuthCustomLoginButton (object)
  The custom text for the login button on the Web Authentication page.
- Changed property webAuthCustomTitle (object)
  The custom title text displayed at the top of the Web Authentication login page.
- Changed property webAuthCustomTop (object)
  The custom HTML or text content displayed at the top section of the Web Authentication login page.
- Changed property webAuthPasswordLabel (object)
  The custom label text for the password field on the Web Authentication login page.
- Changed property webAuthUserIdLabel (object)
  The custom label text for the username field on the Web Authentication login page.
Changed content type : application/vnd.ruckus.v1+json
- Added property SwitchAndVenue_V1 (object)
  The list of switches and venues where this Web Authentication page template is deployed.
- Added property WebAuthPageTemplateList_V1 (object)
  The list of Web Authentication page template instances for batch operations or nested template management.
- Deleted property switchVenueInfos (object)
- Deleted property webAuthPageTemplateViewList (object)
- Changed property id (object)
  The unique identifier of the Web Authentication page template.
- Changed property name (object)
  The name of the Web Authentication page template for identification.
- Changed property switchCount (object)
  The number of switches where this Web Authentication page template is applied.
- Changed property tag (object)
  The tag or label used for categorizing and filtering the Web Authentication page template.
- Changed property venueCount (object)
  The number of venues where this Web Authentication page template is applied.
- Changed property webAuthCustomBottom (object)
  The custom HTML or text content displayed at the bottom section of the Web Authentication login page.
- Changed property webAuthCustomLoginButton (object)
  The custom text for the login button on the Web Authentication page.
- Changed property webAuthCustomTitle (object)
  The custom title text displayed at the top of the Web Authentication login page.
- Changed property webAuthCustomTop (object)
  The custom HTML or text content displayed at the top section of the Web Authentication login page.
- Changed property webAuthPasswordLabel (object)
  The custom label text for the password field on the Web Authentication login page.
- Changed property webAuthUserIdLabel (object)
  The custom label text for the username field on the Web Authentication login page.

Changed response : 400 Bad Request

Bad/malformed request

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 401 Unauthorized

Unauthorized

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 403 Forbidden

Forbidden

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 404 Not Found

Requested resource or related entity not found

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 422 Unprocessable Entity

Validation error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 500 Internal Server Error

Internal Server Error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 201 Created

Created

Changed content type : application/vnd.ruckus.v1.1+json
- Changed property requestId (object)
  The unique identifier for tracking this API operation request.
- Changed property response (object)
  The web authentication page template view, representing a web authentication portal template with labels, titles, and usage statistics.
  - Changed property name (object)
    The unique name of the web authentication page template.
  - Changed property switchCount (object)
    The total number of switches where this web authentication page template is currently applied.
  - Changed property venueCount (object)
    The total number of venues where this web authentication page template is currently applied.
  - Changed property webAuthCustomBottom (object)
    The custom text or HTML content displayed at the bottom section of the web authentication page.
  - Changed property webAuthCustomLoginButton (object)
    The custom label text for the login button on the web authentication page.
  - Changed property webAuthCustomTitle (object)
    The custom title text displayed at the top of the web authentication page.
  - Changed property webAuthCustomTop (object)
    The custom text or HTML content displayed at the top section of the web authentication page.
  - Changed property webAuthPasswordLabel (object)
    The custom label text for the password input field on the web authentication page.

GET /webAuthPageTemplates/{templateId}

Return Type:

Changed response : 200 OK

OK

Changed content type : application/json
- Added property SwitchAndVenue_V1 (object)
  The list of switches and venues where this Web Authentication page template is deployed.
- Added property WebAuthPageTemplateList_V1 (object)
  The list of Web Authentication page template instances for batch operations or nested template management.
- Deleted property switchVenueInfos (object)
- Deleted property webAuthPageTemplateViewList (object)
- Changed property id (object)
  The unique identifier of the Web Authentication page template.
- Changed property name (object)
  The name of the Web Authentication page template for identification.
- Changed property switchCount (object)
  The number of switches where this Web Authentication page template is applied.
- Changed property tag (object)
  The tag or label used for categorizing and filtering the Web Authentication page template.
- Changed property venueCount (object)
  The number of venues where this Web Authentication page template is applied.
- Changed property webAuthCustomBottom (object)
  The custom HTML or text content displayed at the bottom section of the Web Authentication login page.
- Changed property webAuthCustomLoginButton (object)
  The custom text for the login button on the Web Authentication page.
- Changed property webAuthCustomTitle (object)
  The custom title text displayed at the top of the Web Authentication login page.
- Changed property webAuthCustomTop (object)
  The custom HTML or text content displayed at the top section of the Web Authentication login page.
- Changed property webAuthPasswordLabel (object)
  The custom label text for the password field on the Web Authentication login page.
- Changed property webAuthUserIdLabel (object)
  The custom label text for the username field on the Web Authentication login page.
Changed content type : application/vnd.ruckus.v1+json
- Added property SwitchAndVenue_V1 (object)
  The list of switches and venues where this Web Authentication page template is deployed.
- Added property WebAuthPageTemplateList_V1 (object)
  The list of Web Authentication page template instances for batch operations or nested template management.
- Deleted property switchVenueInfos (object)
- Deleted property webAuthPageTemplateViewList (object)
- Changed property id (object)
  The unique identifier of the Web Authentication page template.
- Changed property name (object)
  The name of the Web Authentication page template for identification.
- Changed property switchCount (object)
  The number of switches where this Web Authentication page template is applied.
- Changed property tag (object)
  The tag or label used for categorizing and filtering the Web Authentication page template.
- Changed property venueCount (object)
  The number of venues where this Web Authentication page template is applied.
- Changed property webAuthCustomBottom (object)
  The custom HTML or text content displayed at the bottom section of the Web Authentication login page.
- Changed property webAuthCustomLoginButton (object)
  The custom text for the login button on the Web Authentication page.
- Changed property webAuthCustomTitle (object)
  The custom title text displayed at the top of the Web Authentication login page.
- Changed property webAuthCustomTop (object)
  The custom HTML or text content displayed at the top section of the Web Authentication login page.
- Changed property webAuthPasswordLabel (object)
  The custom label text for the password field on the Web Authentication login page.
- Changed property webAuthUserIdLabel (object)
  The custom label text for the username field on the Web Authentication login page.
Changed content type : application/vnd.ruckus.v1.1+json
- Changed property name (object)
  The unique name of the web authentication page template.
- Changed property switchCount (object)
  The total number of switches where this web authentication page template is currently applied.
- Changed property venueCount (object)
  The total number of venues where this web authentication page template is currently applied.
- Changed property webAuthCustomBottom (object)
  The custom text or HTML content displayed at the bottom section of the web authentication page.
- Changed property webAuthCustomLoginButton (object)
  The custom label text for the login button on the web authentication page.
- Changed property webAuthCustomTitle (object)
  The custom title text displayed at the top of the web authentication page.
- Changed property webAuthCustomTop (object)
  The custom text or HTML content displayed at the top section of the web authentication page.
- Changed property webAuthPasswordLabel (object)
  The custom label text for the password input field on the web authentication page.

Changed response : 400 Bad Request

Bad/malformed request

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 401 Unauthorized

Unauthorized

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 403 Forbidden

Forbidden

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 404 Not Found

Requested resource or related entity not found

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 422 Unprocessable Entity

Validation error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 500 Internal Server Error

Internal Server Error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

PUT /webAuthPageTemplates/{templateId}

Request:

Changed content type : application/json

Changed property id (object)
Unique identifier for the web auth page template (maximum 37 characters).
Changed property name (object)
Template name for identification (maximum 32 characters, required).
Changed property tag (object)
Tag for categorizing or grouping templates (maximum 255 characters).
Changed property tenantId (object)
The unique identifier of the tenant.
Changed property webAuthCustomBottom (object)
Custom text displayed at the bottom section of the login page (maximum 255 characters).
Changed property webAuthCustomLoginButton (object)
Custom text for the login button (maximum 32 characters).
Changed property webAuthCustomTitle (object)
Custom title text displayed at the top of the login page (maximum 128 characters).
Changed property webAuthCustomTop (object)
Custom text displayed at the top section of the login page (maximum 255 characters).
Changed property webAuthPasswordLabel (object)
Custom label text for the password input field (maximum 32 characters).

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

Changed property id (object)
Unique identifier for the web auth page template (maximum 37 characters).
Changed property name (object)
Template name for identification (maximum 32 characters, required).
Changed property tag (object)
Tag for categorizing or grouping templates (maximum 255 characters).
Changed property tenantId (object)
The unique identifier of the tenant.
Changed property webAuthCustomBottom (object)
Custom text displayed at the bottom section of the login page (maximum 255 characters).
Changed property webAuthCustomLoginButton (object)
Custom text for the login button (maximum 32 characters).
Changed property webAuthCustomTitle (object)
Custom title text displayed at the top of the login page (maximum 128 characters).
Changed property webAuthCustomTop (object)
Custom text displayed at the top section of the login page (maximum 255 characters).
Changed property webAuthPasswordLabel (object)
Custom label text for the password input field (maximum 32 characters).

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

Changed property name (object)
The unique name of the web authentication page template.
Changed property switchCount (object)
The total number of switches where this web authentication page template is currently applied.
Changed property venueCount (object)
The total number of venues where this web authentication page template is currently applied.
Changed property webAuthCustomBottom (object)
The custom text or HTML content displayed at the bottom section of the web authentication page.
Changed property webAuthCustomLoginButton (object)
The custom label text for the login button on the web authentication page.
Changed property webAuthCustomTitle (object)
The custom title text displayed at the top of the web authentication page.
Changed property webAuthCustomTop (object)
The custom text or HTML content displayed at the top section of the web authentication page.
Changed property webAuthPasswordLabel (object)
The custom label text for the password input field on the web authentication page.

Return Type:

Changed response : 400 Bad Request

Bad/malformed request

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 401 Unauthorized

Unauthorized

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 403 Forbidden

Forbidden

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 404 Not Found

Requested resource or related entity not found

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 422 Unprocessable Entity

Validation error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 500 Internal Server Error

Internal Server Error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 200 OK

OK

Changed content type : application/json
- Added property SwitchAndVenue_V1 (object)
  The list of switches and venues where this Web Authentication page template is deployed.
- Added property WebAuthPageTemplateList_V1 (object)
  The list of Web Authentication page template instances for batch operations or nested template management.
- Deleted property switchVenueInfos (object)
- Deleted property webAuthPageTemplateViewList (object)
- Changed property id (object)
  The unique identifier of the Web Authentication page template.
- Changed property name (object)
  The name of the Web Authentication page template for identification.
- Changed property switchCount (object)
  The number of switches where this Web Authentication page template is applied.
- Changed property tag (object)
  The tag or label used for categorizing and filtering the Web Authentication page template.
- Changed property venueCount (object)
  The number of venues where this Web Authentication page template is applied.
- Changed property webAuthCustomBottom (object)
  The custom HTML or text content displayed at the bottom section of the Web Authentication login page.
- Changed property webAuthCustomLoginButton (object)
  The custom text for the login button on the Web Authentication page.
- Changed property webAuthCustomTitle (object)
  The custom title text displayed at the top of the Web Authentication login page.
- Changed property webAuthCustomTop (object)
  The custom HTML or text content displayed at the top section of the Web Authentication login page.
- Changed property webAuthPasswordLabel (object)
  The custom label text for the password field on the Web Authentication login page.
- Changed property webAuthUserIdLabel (object)
  The custom label text for the username field on the Web Authentication login page.
Changed content type : application/vnd.ruckus.v1+json
- Added property SwitchAndVenue_V1 (object)
  The list of switches and venues where this Web Authentication page template is deployed.
- Added property WebAuthPageTemplateList_V1 (object)
  The list of Web Authentication page template instances for batch operations or nested template management.
- Deleted property switchVenueInfos (object)
- Deleted property webAuthPageTemplateViewList (object)
- Changed property id (object)
  The unique identifier of the Web Authentication page template.
- Changed property name (object)
  The name of the Web Authentication page template for identification.
- Changed property switchCount (object)
  The number of switches where this Web Authentication page template is applied.
- Changed property tag (object)
  The tag or label used for categorizing and filtering the Web Authentication page template.
- Changed property venueCount (object)
  The number of venues where this Web Authentication page template is applied.
- Changed property webAuthCustomBottom (object)
  The custom HTML or text content displayed at the bottom section of the Web Authentication login page.
- Changed property webAuthCustomLoginButton (object)
  The custom text for the login button on the Web Authentication page.
- Changed property webAuthCustomTitle (object)
  The custom title text displayed at the top of the Web Authentication login page.
- Changed property webAuthCustomTop (object)
  The custom HTML or text content displayed at the top section of the Web Authentication login page.
- Changed property webAuthPasswordLabel (object)
  The custom label text for the password field on the Web Authentication login page.
- Changed property webAuthUserIdLabel (object)
  The custom label text for the username field on the Web Authentication login page.
Changed content type : application/vnd.ruckus.v1.1+json
- Changed property requestId (object)
  The unique identifier for tracking this API operation request.
- Changed property response (object)
  The web authentication page template view, representing a web authentication portal template with labels, titles, and usage statistics.
  - Changed property name (object)
    The unique name of the web authentication page template.
  - Changed property switchCount (object)
    The total number of switches where this web authentication page template is currently applied.
  - Changed property venueCount (object)
    The total number of venues where this web authentication page template is currently applied.
  - Changed property webAuthCustomBottom (object)
    The custom text or HTML content displayed at the bottom section of the web authentication page.
  - Changed property webAuthCustomLoginButton (object)
    The custom label text for the login button on the web authentication page.
  - Changed property webAuthCustomTitle (object)
    The custom title text displayed at the top of the web authentication page.
  - Changed property webAuthCustomTop (object)
    The custom text or HTML content displayed at the top section of the web authentication page.
  - Changed property webAuthPasswordLabel (object)
    The custom label text for the password input field on the web authentication page.

DELETE /webAuthPageTemplates/{templateId}

Return Type:

Changed response : 400 Bad Request

Bad/malformed request

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 401 Unauthorized

Unauthorized

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 403 Forbidden

Forbidden

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 404 Not Found

Requested resource or related entity not found

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 422 Unprocessable Entity

Validation error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 500 Internal Server Error

Internal Server Error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 200 OK

OK

Changed content type : application/json
- Changed property requestId (object)
  The unique identifier for tracking this API operation request.
- Changed property response (object)
  The empty view representing an API response with no data content, used for operations that return success status without additional information.
Changed content type : application/vnd.ruckus.v1+json
- Changed property requestId (object)
  The unique identifier for tracking this API operation request.
- Changed property response (object)
  The empty view representing an API response with no data content, used for operations that return success status without additional information.
Changed content type : application/vnd.ruckus.v1.1+json
- Changed property requestId (object)
  The unique identifier for tracking this API operation request.
- Changed property response (object)
  The empty view representing an API response with no data content, used for operations that return success status without additional information.

POST /venues/switchFirmwares/schedules/query

Request:

Changed content type : application/json

Changed property firmwareType (object)
The firmware type to filter venues, such as primary or recovery firmware.
Changed property firmwareVersion (object)
The firmware version to filter venues by their current or target firmware version.
Changed property search (object)
The search term for filtering venues by name or identifier.
Changed property updateAvailable (object)
The flag indicating whether to filter venues that have firmware updates available.

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

Changed property firmwareType (object)
The firmware type to filter venues, such as primary or recovery firmware.
Changed property firmwareVersion (object)
The firmware version to filter venues by their current or target firmware version.
Changed property search (object)
The search term for filtering venues by name or identifier.
Changed property updateAvailable (object)
The flag indicating whether to filter venues that have firmware updates available.

Return Type:

Changed response : 400 Bad Request

Bad/malformed request

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 401 Unauthorized

Unauthorized

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 403 Forbidden

Forbidden

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 404 Not Found

Requested resource or related entity not found

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 422 Unprocessable Entity

Validation error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 500 Internal Server Error

Internal Server Error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 200 OK

OK

Changed content type : application/json
- Changed property aboveTenSwitchCount (object)
  The number of switches running firmware version 10.0.0 or above in this venue.
- Changed property availableVersions (object)
  The list of available firmware versions that can be deployed to switches in this venue.
- Changed property id (object)
  The unique identifier of the venue.
- Changed property lastScheduleUpdateTime (object)
  The timestamp of the last update to the upgrade schedule.
- Changed property name (object)
  The name of the venue where firmware upgrades are being managed.
- Changed property preDownload (object)
  The flag indicating whether firmware pre download is enabled for switches in this venue.
- Changed property scheduleCount (object)
  The total number of upgrade schedules configured for this venue.
- Changed property status (object)
  The current status of venue wide firmware upgrade operations.
- Changed property switchCount (object)
  The total number of switches in this venue that are subject to firmware upgrades.
- Changed property upgradeVenueViewList (object)
  The list of upgrade venue views for batch operations or nested venue management.
- Changed property switchFirmwareVersion (object)
  Schema containing switch version information and attributes.
  New optional properties:
  - id
  - Deleted property id (object)
  - Deleted property tenant (object)
  - Changed property category (object)
    The category classification of the firmware version.
  - Changed property name (object)
    The firmware version name identifier for the switch.
- Changed property nextSchedule (object)
  The upgrade schedule view, representing a planned firmware upgrade operation with time window and target versions for different firmware baselines.
  - Changed property id (object)
    The identifier
  - Changed property timeSlot (object)
    The schedule time slot view, representing a time window for scheduled operations with start and end time stamps including timezone information.
    - Changed property endDateTime (object)
      The end date and time for the scheduled operation with timezone information.
    - Changed property id (object)
      The identifier
    - Changed property startDateTime (object)
      The start date and time for the scheduled operation with timezone information.
Changed content type : application/vnd.ruckus.v1+json
- Changed property aboveTenSwitchCount (object)
  The number of switches running firmware version 10.0.0 or above in this venue.
- Changed property availableVersions (object)
  The list of available firmware versions that can be deployed to switches in this venue.
- Changed property id (object)
  The unique identifier of the venue.
- Changed property lastScheduleUpdateTime (object)
  The timestamp of the last update to the upgrade schedule.
- Changed property name (object)
  The name of the venue where firmware upgrades are being managed.
- Changed property preDownload (object)
  The flag indicating whether firmware pre download is enabled for switches in this venue.
- Changed property scheduleCount (object)
  The total number of upgrade schedules configured for this venue.
- Changed property status (object)
  The current status of venue wide firmware upgrade operations.
- Changed property switchCount (object)
  The total number of switches in this venue that are subject to firmware upgrades.
- Changed property upgradeVenueViewList (object)
  The list of upgrade venue views for batch operations or nested venue management.
- Changed property switchFirmwareVersion (object)
  Schema containing switch version information and attributes.
  New optional properties:
  - id
  - Deleted property id (object)
  - Deleted property tenant (object)
  - Changed property category (object)
    The category classification of the firmware version.
  - Changed property name (object)
    The firmware version name identifier for the switch.
- Changed property nextSchedule (object)
  The upgrade schedule view, representing a planned firmware upgrade operation with time window and target versions for different firmware baselines.
  - Changed property id (object)
    The identifier
  - Changed property timeSlot (object)
    The schedule time slot view, representing a time window for scheduled operations with start and end time stamps including timezone information.
    - Changed property endDateTime (object)
      The end date and time for the scheduled operation with timezone information.
    - Changed property id (object)
      The identifier
    - Changed property startDateTime (object)
      The start date and time for the scheduled operation with timezone information.

POST /venues/switchFirmwares/switches/schedules/query

Request:

Changed content type : application/json

Changed property search (object)
The search term for filtering switches by name, MAC address, or identifier.
Changed property venueIdList (object)
The list of venue identifiers to filter switches by their associated venues.

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

Changed property search (object)
The search term for filtering switches by name, MAC address, or identifier.
Changed property venueIdList (object)
The list of venue identifiers to filter switches by their associated venues.

Return Type:

Changed response : 400 Bad Request

Bad/malformed request

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 401 Unauthorized

Unauthorized

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 403 Forbidden

Forbidden

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 404 Not Found

Requested resource or related entity not found

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 422 Unprocessable Entity

Validation error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 500 Internal Server Error

Internal Server Error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 200 OK

OK

Changed content type : application/json
- Changed property currentFirmware (object)
  The current firmware version running on the switch.
- Changed property id (object)
  The identifier
- Changed property isStack (object)
  The flag indicating whether this is a stacked switch configuration.
- Changed property isSwitchLevelSchedule (object)
  The flag indicating whether the upgrade schedule is configured at the switch level rather than venue level.
- Changed property model (object)
  The model name or identifier of the ICX switch.
- Changed property preDownload (object)
  The flag indicating whether firmware pre download is enabled for this switch.
- Changed property switchId (object)
  The unique identifier of the switch to be upgraded.
- Changed property switchName (object)
  The name of the switch for identification in the upgrade process.
- Changed property upgradeSwitchViewList (object)
  The list of upgrade switch views for batch operations or nested switch management.
- Changed property venueId (object)
  The unique identifier of the venue where this switch is located.
- Changed property venueName (object)
  The name of the venue where this switch is located.
- Changed property availableVersion (object)
  Schema containing switch version information and attributes.
  New optional properties:
  - id
  - Deleted property id (object)
  - Deleted property tenant (object)
  - Changed property category (object)
    The category classification of the firmware version.
  - Changed property name (object)
    The firmware version name identifier for the switch.
- Changed property switchNextSchedule (object)
  The upgrade schedule view, representing a planned firmware upgrade operation with time window and target versions for different firmware baselines.
  - Changed property id (object)
    The identifier
  - Changed property timeSlot (object)
    The schedule time slot view, representing a time window for scheduled operations with start and end time stamps including timezone information.
    - Changed property endDateTime (object)
      The end date and time for the scheduled operation with timezone information.
    - Changed property id (object)
      The identifier
    - Changed property startDateTime (object)
      The start date and time for the scheduled operation with timezone information.
Changed content type : application/vnd.ruckus.v1+json
- Changed property currentFirmware (object)
  The current firmware version running on the switch.
- Changed property id (object)
  The identifier
- Changed property isStack (object)
  The flag indicating whether this is a stacked switch configuration.
- Changed property isSwitchLevelSchedule (object)
  The flag indicating whether the upgrade schedule is configured at the switch level rather than venue level.
- Changed property model (object)
  The model name or identifier of the ICX switch.
- Changed property preDownload (object)
  The flag indicating whether firmware pre download is enabled for this switch.
- Changed property switchId (object)
  The unique identifier of the switch to be upgraded.
- Changed property switchName (object)
  The name of the switch for identification in the upgrade process.
- Changed property upgradeSwitchViewList (object)
  The list of upgrade switch views for batch operations or nested switch management.
- Changed property venueId (object)
  The unique identifier of the venue where this switch is located.
- Changed property venueName (object)
  The name of the venue where this switch is located.
- Changed property availableVersion (object)
  Schema containing switch version information and attributes.
  New optional properties:
  - id
  - Deleted property id (object)
  - Deleted property tenant (object)
  - Changed property category (object)
    The category classification of the firmware version.
  - Changed property name (object)
    The firmware version name identifier for the switch.
- Changed property switchNextSchedule (object)
  The upgrade schedule view, representing a planned firmware upgrade operation with time window and target versions for different firmware baselines.
  - Changed property id (object)
    The identifier
  - Changed property timeSlot (object)
    The schedule time slot view, representing a time window for scheduled operations with start and end time stamps including timezone information.
    - Changed property endDateTime (object)
      The end date and time for the scheduled operation with timezone information.
    - Changed property id (object)
      The identifier
    - Changed property startDateTime (object)
      The start date and time for the scheduled operation with timezone information.

POST /venues/{venueId}/switches/portSettings

Return Type:

Changed response : 400 Bad Request

Bad/malformed request

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 401 Unauthorized

Unauthorized

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 403 Forbidden

Forbidden

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 404 Not Found

Requested resource or related entity not found

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 422 Unprocessable Entity

Validation error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 500 Internal Server Error

Internal Server Error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

PUT /venues/{venueId}/switches/portSettings

Return Type:

Changed response : 400 Bad Request

Bad/malformed request

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 401 Unauthorized

Unauthorized

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 403 Forbidden

Forbidden

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 404 Not Found

Requested resource or related entity not found

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 422 Unprocessable Entity

Validation error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 500 Internal Server Error

Internal Server Error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 200 OK

OK

Changed content type : application/json
- Changed property requestId (object)
  The unique identifier for tracking this API operation request.
- Changed property response (object)
  The port view, representing a switch port configuration with comprehensive settings including VLANs, PoE, security features, authentication, and protocol configurations.
  - Changed property adminPtToPt (object)
    The RSTP (Rapid Spanning Tree Protocol) point-to-point MAC mode.
  - Changed property arpInspectionTrust (object)
    The flag indicating whether this port is trusted for ARP inspection, bypassing ARP validation.
  - Changed property authDefaultVlan (object)
    The VLAN ID to assign authenticated users when no specific VLAN is provided by the AAA server.
  - Changed property authFailAction (object)
    The action to take when authentication fails: restricted VLAN, drop, or block.
  - Changed property authTimeoutAction (object)
    The action to take when authentication times out: same as auth fail or critical VLAN.
  - Changed property authenticationCustomize (object)
    The flag indicating whether port specific authentication settings override the profile defaults.
  - Changed property authenticationProfileId (object)
    The identifier of the authentication profile applied to this port for access control.
  - Changed property authenticationType (object)
    The authentication method type configured for this port, such as 802.1X, MAC authentication, or Web authentication.
  - Changed property changeAuthOrder (object)
    The flag indicating whether the authentication method order has been modified from defaults.
  - Changed property criticalVlan (object)
    The VLAN ID for critical users requiring network access during AAA server failure.
  - Changed property dhcpSnoopingTrust (object)
    The flag indicating whether this port is trusted for DHCP snooping, allowing DHCP server responses.
  - Changed property dot1xPortControl (object)
    The 802.1X port control mode determining authentication requirements: auto, force authorized, or force unauthorized.
  - Changed property egressAcl (object)
    The name of the Access Control List applied to egress (outgoing) traffic on this port.
  - Changed property enableAuthPorts (object)
    The list of port identifiers where authentication is enabled, displayed in the UI.
  - Changed property flexibleAuthenticationEnabled (object)
    The flag indicating whether flexible authentication with multiple methods is enabled on this port.
  - Changed property guestVlan (object)
    The VLAN ID for guest users who bypass authentication.
  - Changed property ignoreFields (object)
    The comma separated list of field names to ignore during update operations.
  - Changed property ingressAcl (object)
    The name of the Access Control List applied to ingress (incoming) traffic on this port.
  - Changed property ipsg (object)
    The flag indicating whether IP source guard is enabled for additional layer 2 security.
  - Changed property lldpEnable (object)
    The flag indicating whether LLDP (Link Layer Discovery Protocol) is enabled on this port.
  - Changed property lldpQos (object)
    The set of LLDP (Link Layer Discovery Protocol) QoS (Quality of Service) configurations for network priority advertising.
  - Changed property name (object)
    The descriptive name or label assigned to the port for identification purposes.
  - Changed property poeBudget (object)
    The PoE power budget allocated to this port in watts.
  - Changed property poeCapability (object)
    The flag indicating whether this port has PoE (Power over Ethernet) hardware capability.
  - Changed property poeClass (object)
    The PoE (Power over Ethernet) class indicating the maximum power level supported by the connected device.
  - Changed property poeEnable (object)
    The flag indicating whether PoE (Power over Ethernet) is enabled on this port.
  - Changed property poePriority (object)
    The PoE priority level for power allocation, with lower values indicating higher priority.
  - Changed property portEnable (object)
    The flag indicating whether the port is administratively enabled for traffic forwarding.
  - Changed property portProtected (object)
    The flag indicating whether the port is configured as a protected port, preventing communication with other protected ports.
  - Changed property portSecurity (object)
    The flag indicating whether port security is enabled to restrict MAC addresses allowed on this port.
  - Changed property portSecurityMaxEntries (object)
    The maximum number of MAC addresses allowed when port security is enabled.
  - Changed property portSpeed (object)
    The configured speed setting for the port, such as auto negotiation or specific speed values.
  - Changed property ports (object)
    The set of port identifiers when performing batch operations on multiple ports.
  - Changed property profileAuthDefaultVlan (object)
    The authentication default VLAN ID configured at the profile level for reference in the UI.
  - Changed property profileName (object)
    The name of the profile applied to this port, displayed in the UI for reference.
  - Changed property restrictedVlan (object)
    The VLAN ID for users who fail authorization after successful authentication.
  - Changed property revert (object)
    The flag indicating whether to revert port configuration to profile defaults.
  - Changed property rstpAdminEdgePort (object)
    The flag indicating whether this port is configured as an edge port in RSTP (Rapid Spanning Tree Protocol).
  - Changed property shouldAlertAaaAndRadiusNotApply (object)
    The flag indicating whether to alert users when AAA and RADIUS configurations cannot be applied to the switch.
  - Changed property stpBpduGuard (object)
    Indicates whether STP (Spanning Tree Protocol) BPDU (Bridge Protocol Data Unit) guard is enabled. When enabled, the port is disabled if BPDU frames are received.
  - Changed property stpRootGuard (object)
    The flag indicating whether STP (Spanning Tree Protocol) root guard is enabled to prevent the port from becoming a root port.
  - Changed property switchLevelAuthDefaultVlan (object)
    The authentication default VLAN ID configured at the switch level for reference in the UI.
  - Changed property switchMac (object)
    The MAC address of the switch to which this port belongs, used for UI identification.
  - Changed property switchMacAcl (object)
    The name of the MAC based ACL (Access Control List) applied to this port for layer 2 filtering.
  - Changed property switchPortProfileId (object)
    The identifier of the switch port profile configuration applied to this port.
  - Changed property taggedVlans (object)
    The ordered set of VLAN IDs configured as tagged VLANs on this port for 802.1Q trunking.
  - Changed property tags (object)
    The comma separated list of custom tags assigned to this port for organization and filtering.
  - Changed property untaggedVlan (object)
    The VLAN ID configured as the untagged (native) VLAN for this port.
  - Changed property voiceVlan (object)
    The VLAN ID designated for voice traffic, typically used for VoIP devices.
  - Changed property vsixEgressAcl (object)
    The name of the VSIX ACL applied to egress traffic for virtual switch integration.
  - Changed property vsixIngressAcl (object)
    The name of the VSIX ACL applied to ingress traffic for virtual switch integration.
  - Changed property poeScheduler (object)
    The scheduler view, representing a time-based schedule with weekly patterns for automated task execution.
    - Changed property fri (object)
      Friday schedule pattern as a 24-character string where each character represents an hour of the day.
    - Changed property mon (object)
      Monday schedule pattern as a 24-character string where each character represents an hour of the day.
    - Changed property sat (object)
      Saturday schedule pattern as a 24-character string where each character represents an hour of the day.
    - Changed property sun (object)
      Sunday schedule pattern as a 24-character string where each character represents an hour of the day.
    - Changed property thu (object)
      Thursday schedule pattern as a 24-character string where each character represents an hour of the day.
    - Changed property tue (object)
      Tuesday schedule pattern as a 24-character string where each character represents an hour of the day.
    - Changed property type (object)
      The type of scheduler defining the execution pattern.
    - Changed property wed (object)
      Wednesday schedule pattern as a 24-character string where each character represents an hour of the day.
Changed content type : application/vnd.ruckus.v1+json
- Changed property requestId (object)
  The unique identifier for tracking this API operation request.
- Changed property response (object)
  The port view, representing a switch port configuration with comprehensive settings including VLANs, PoE, security features, authentication, and protocol configurations.
  - Changed property adminPtToPt (object)
    The RSTP (Rapid Spanning Tree Protocol) point-to-point MAC mode.
  - Changed property arpInspectionTrust (object)
    The flag indicating whether this port is trusted for ARP inspection, bypassing ARP validation.
  - Changed property authDefaultVlan (object)
    The VLAN ID to assign authenticated users when no specific VLAN is provided by the AAA server.
  - Changed property authFailAction (object)
    The action to take when authentication fails: restricted VLAN, drop, or block.
  - Changed property authTimeoutAction (object)
    The action to take when authentication times out: same as auth fail or critical VLAN.
  - Changed property authenticationCustomize (object)
    The flag indicating whether port specific authentication settings override the profile defaults.
  - Changed property authenticationProfileId (object)
    The identifier of the authentication profile applied to this port for access control.
  - Changed property authenticationType (object)
    The authentication method type configured for this port, such as 802.1X, MAC authentication, or Web authentication.
  - Changed property changeAuthOrder (object)
    The flag indicating whether the authentication method order has been modified from defaults.
  - Changed property criticalVlan (object)
    The VLAN ID for critical users requiring network access during AAA server failure.
  - Changed property dhcpSnoopingTrust (object)
    The flag indicating whether this port is trusted for DHCP snooping, allowing DHCP server responses.
  - Changed property dot1xPortControl (object)
    The 802.1X port control mode determining authentication requirements: auto, force authorized, or force unauthorized.
  - Changed property egressAcl (object)
    The name of the Access Control List applied to egress (outgoing) traffic on this port.
  - Changed property enableAuthPorts (object)
    The list of port identifiers where authentication is enabled, displayed in the UI.
  - Changed property flexibleAuthenticationEnabled (object)
    The flag indicating whether flexible authentication with multiple methods is enabled on this port.
  - Changed property guestVlan (object)
    The VLAN ID for guest users who bypass authentication.
  - Changed property ignoreFields (object)
    The comma separated list of field names to ignore during update operations.
  - Changed property ingressAcl (object)
    The name of the Access Control List applied to ingress (incoming) traffic on this port.
  - Changed property ipsg (object)
    The flag indicating whether IP source guard is enabled for additional layer 2 security.
  - Changed property lldpEnable (object)
    The flag indicating whether LLDP (Link Layer Discovery Protocol) is enabled on this port.
  - Changed property lldpQos (object)
    The set of LLDP (Link Layer Discovery Protocol) QoS (Quality of Service) configurations for network priority advertising.
  - Changed property name (object)
    The descriptive name or label assigned to the port for identification purposes.
  - Changed property poeBudget (object)
    The PoE power budget allocated to this port in watts.
  - Changed property poeCapability (object)
    The flag indicating whether this port has PoE (Power over Ethernet) hardware capability.
  - Changed property poeClass (object)
    The PoE (Power over Ethernet) class indicating the maximum power level supported by the connected device.
  - Changed property poeEnable (object)
    The flag indicating whether PoE (Power over Ethernet) is enabled on this port.
  - Changed property poePriority (object)
    The PoE priority level for power allocation, with lower values indicating higher priority.
  - Changed property portEnable (object)
    The flag indicating whether the port is administratively enabled for traffic forwarding.
  - Changed property portProtected (object)
    The flag indicating whether the port is configured as a protected port, preventing communication with other protected ports.
  - Changed property portSecurity (object)
    The flag indicating whether port security is enabled to restrict MAC addresses allowed on this port.
  - Changed property portSecurityMaxEntries (object)
    The maximum number of MAC addresses allowed when port security is enabled.
  - Changed property portSpeed (object)
    The configured speed setting for the port, such as auto negotiation or specific speed values.
  - Changed property ports (object)
    The set of port identifiers when performing batch operations on multiple ports.
  - Changed property profileAuthDefaultVlan (object)
    The authentication default VLAN ID configured at the profile level for reference in the UI.
  - Changed property profileName (object)
    The name of the profile applied to this port, displayed in the UI for reference.
  - Changed property restrictedVlan (object)
    The VLAN ID for users who fail authorization after successful authentication.
  - Changed property revert (object)
    The flag indicating whether to revert port configuration to profile defaults.
  - Changed property rstpAdminEdgePort (object)
    The flag indicating whether this port is configured as an edge port in RSTP (Rapid Spanning Tree Protocol).
  - Changed property shouldAlertAaaAndRadiusNotApply (object)
    The flag indicating whether to alert users when AAA and RADIUS configurations cannot be applied to the switch.
  - Changed property stpBpduGuard (object)
    Indicates whether STP (Spanning Tree Protocol) BPDU (Bridge Protocol Data Unit) guard is enabled. When enabled, the port is disabled if BPDU frames are received.
  - Changed property stpRootGuard (object)
    The flag indicating whether STP (Spanning Tree Protocol) root guard is enabled to prevent the port from becoming a root port.
  - Changed property switchLevelAuthDefaultVlan (object)
    The authentication default VLAN ID configured at the switch level for reference in the UI.
  - Changed property switchMac (object)
    The MAC address of the switch to which this port belongs, used for UI identification.
  - Changed property switchMacAcl (object)
    The name of the MAC based ACL (Access Control List) applied to this port for layer 2 filtering.
  - Changed property switchPortProfileId (object)
    The identifier of the switch port profile configuration applied to this port.
  - Changed property taggedVlans (object)
    The ordered set of VLAN IDs configured as tagged VLANs on this port for 802.1Q trunking.
  - Changed property tags (object)
    The comma separated list of custom tags assigned to this port for organization and filtering.
  - Changed property untaggedVlan (object)
    The VLAN ID configured as the untagged (native) VLAN for this port.
  - Changed property voiceVlan (object)
    The VLAN ID designated for voice traffic, typically used for VoIP devices.
  - Changed property vsixEgressAcl (object)
    The name of the VSIX ACL applied to egress traffic for virtual switch integration.
  - Changed property vsixIngressAcl (object)
    The name of the VSIX ACL applied to ingress traffic for virtual switch integration.
  - Changed property poeScheduler (object)
    The scheduler view, representing a time-based schedule with weekly patterns for automated task execution.
    - Changed property fri (object)
      Friday schedule pattern as a 24-character string where each character represents an hour of the day.
    - Changed property mon (object)
      Monday schedule pattern as a 24-character string where each character represents an hour of the day.
    - Changed property sat (object)
      Saturday schedule pattern as a 24-character string where each character represents an hour of the day.
    - Changed property sun (object)
      Sunday schedule pattern as a 24-character string where each character represents an hour of the day.
    - Changed property thu (object)
      Thursday schedule pattern as a 24-character string where each character represents an hour of the day.
    - Changed property tue (object)
      Tuesday schedule pattern as a 24-character string where each character represents an hour of the day.
    - Changed property type (object)
      The type of scheduler defining the execution pattern.
    - Changed property wed (object)
      Wednesday schedule pattern as a 24-character string where each character represents an hour of the day.

GET /venues/{venueId}/switches/{switchId}/portSettings

Return Type:

Changed response : 400 Bad Request

Bad/malformed request

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 401 Unauthorized

Unauthorized

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 403 Forbidden

Forbidden

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 404 Not Found

Requested resource or related entity not found

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 422 Unprocessable Entity

Validation error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 500 Internal Server Error

Internal Server Error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

POST /venues/{venueId}/switches/{switchId}/portSettings

Return Type:

Changed response : 400 Bad Request

Bad/malformed request

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 401 Unauthorized

Unauthorized

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 403 Forbidden

Forbidden

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 404 Not Found

Requested resource or related entity not found

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 422 Unprocessable Entity

Validation error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 500 Internal Server Error

Internal Server Error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

PUT /venues/{venueId}/switches/{switchId}/portSettings

Request:

Changed content type : application/json

Changed property adminPtToPt (object)
The RSTP (Rapid Spanning Tree Protocol) point-to-point MAC mode.
Changed property arpInspectionTrust (object)
The flag indicating whether this port is trusted for ARP inspection, bypassing ARP validation.
Changed property authDefaultVlan (object)
The VLAN ID to assign authenticated users when no specific VLAN is provided by the AAA server.
Changed property authFailAction (object)
The action to take when authentication fails: restricted VLAN, drop, or block.
Changed property authTimeoutAction (object)
The action to take when authentication times out: same as auth fail or critical VLAN.
Changed property authenticationCustomize (object)
The flag indicating whether port specific authentication settings override the profile defaults.
Changed property authenticationProfileId (object)
The identifier of the authentication profile applied to this port for access control.
Changed property authenticationType (object)
The authentication method type configured for this port, such as 802.1X, MAC authentication, or Web authentication.
Changed property changeAuthOrder (object)
The flag indicating whether the authentication method order has been modified from defaults.
Changed property criticalVlan (object)
The VLAN ID for critical users requiring network access during AAA server failure.
Changed property dhcpSnoopingTrust (object)
The flag indicating whether this port is trusted for DHCP snooping, allowing DHCP server responses.
Changed property dot1xPortControl (object)
The 802.1X port control mode determining authentication requirements: auto, force authorized, or force unauthorized.
Changed property egressAcl (object)
The name of the Access Control List applied to egress (outgoing) traffic on this port.
Changed property flexibleAuthenticationEnabled (object)
The flag indicating whether flexible authentication with multiple methods is enabled on this port.
Changed property guestVlan (object)
The VLAN ID for guest users who bypass authentication.
Changed property ignoreFields (object)
The comma separated list of field names to ignore during update operations.
Changed property ingressAcl (object)
The name of the Access Control List applied to ingress (incoming) traffic on this port.
Changed property ipsg (object)
The flag indicating whether IP source guard is enabled for additional layer 2 security.
Changed property lldpEnable (object)
The flag indicating whether LLDP (Link Layer Discovery Protocol) is enabled on this port.
Changed property lldpQos (object)
The set of LLDP (Link Layer Discovery Protocol) QoS (Quality of Service) configurations for network priority advertising.
Changed property name (object)
The descriptive name or label assigned to the port for identification purposes.
Changed property poeBudget (object)
The PoE power budget allocated to this port in watts.
Changed property poeCapability (object)
The flag indicating whether this port has PoE (Power over Ethernet) hardware capability.
Changed property poeClass (object)
The PoE (Power over Ethernet) class indicating the maximum power level supported by the connected device.
Changed property poeEnable (object)
The flag indicating whether PoE (Power over Ethernet) is enabled on this port.
Changed property poePriority (object)
The PoE priority level for power allocation, with lower values indicating higher priority.
Changed property portEnable (object)
The flag indicating whether the port is administratively enabled for traffic forwarding.
Changed property portProtected (object)
The flag indicating whether the port is configured as a protected port, preventing communication with other protected ports.
Changed property portSecurity (object)
The flag indicating whether port security is enabled to restrict MAC addresses allowed on this port.
Changed property portSecurityMaxEntries (object)
The maximum number of MAC addresses allowed when port security is enabled.
Changed property portSpeed (object)
The configured speed setting for the port, such as auto negotiation or specific speed values.
Changed property ports (object)
The set of port identifiers when performing batch operations on multiple ports.
Changed property restrictedVlan (object)
The VLAN ID for users who fail authorization after successful authentication.
Changed property revert (object)
The flag indicating whether to revert port configuration to profile defaults.
Changed property rstpAdminEdgePort (object)
The flag indicating whether this port is configured as an edge port in RSTP (Rapid Spanning Tree Protocol).
Changed property stpBpduGuard (object)
Enable STP (Spanning Tree Protocol) BPDU (Bridge Protocol Data Unit) guard to automatically disable the port when BPDU frames are received.
Changed property stpRootGuard (object)
The flag indicating whether STP (Spanning Tree Protocol) root guard is enabled to prevent the port from becoming a root port.
Changed property switchMacAcl (object)
The name of the MAC based ACL (Access Control List) applied to this port for layer 2 filtering.
Changed property switchPortProfileId (object)
The identifier of the switch port profile configuration applied to this port.
Changed property taggedVlans (object)
The set of VLAN IDs configured as tagged VLANs on this port for 802.1Q trunking.
Changed property tags (object)
The comma separated list of custom tags assigned to this port for organization and filtering.
Changed property untaggedVlan (object)
The VLAN ID configured as the untagged (native) VLAN for this port.
Changed property voiceVlan (object)
The VLAN ID designated for voice traffic, typically used for VoIP devices.
Changed property poeScheduler (object)
The scheduler view, representing a time-based schedule with weekly patterns for automated task execution.
- Changed property fri (object)
  Friday schedule pattern as a 24-character string where each character represents an hour of the day.
- Changed property mon (object)
  Monday schedule pattern as a 24-character string where each character represents an hour of the day.
- Changed property sat (object)
  Saturday schedule pattern as a 24-character string where each character represents an hour of the day.
- Changed property sun (object)
  Sunday schedule pattern as a 24-character string where each character represents an hour of the day.
- Changed property thu (object)
  Thursday schedule pattern as a 24-character string where each character represents an hour of the day.
- Changed property tue (object)
  Tuesday schedule pattern as a 24-character string where each character represents an hour of the day.
- Changed property type (object)
  The type of scheduler defining the execution pattern.
- Changed property wed (object)
  Wednesday schedule pattern as a 24-character string where each character represents an hour of the day.

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

Changed property adminPtToPt (object)
The RSTP (Rapid Spanning Tree Protocol) point-to-point MAC mode.
Changed property arpInspectionTrust (object)
The flag indicating whether this port is trusted for ARP inspection, bypassing ARP validation.
Changed property authDefaultVlan (object)
The VLAN ID to assign authenticated users when no specific VLAN is provided by the AAA server.
Changed property authFailAction (object)
The action to take when authentication fails: restricted VLAN, drop, or block.
Changed property authTimeoutAction (object)
The action to take when authentication times out: same as auth fail or critical VLAN.
Changed property authenticationCustomize (object)
The flag indicating whether port specific authentication settings override the profile defaults.
Changed property authenticationProfileId (object)
The identifier of the authentication profile applied to this port for access control.
Changed property authenticationType (object)
The authentication method type configured for this port, such as 802.1X, MAC authentication, or Web authentication.
Changed property changeAuthOrder (object)
The flag indicating whether the authentication method order has been modified from defaults.
Changed property criticalVlan (object)
The VLAN ID for critical users requiring network access during AAA server failure.
Changed property dhcpSnoopingTrust (object)
The flag indicating whether this port is trusted for DHCP snooping, allowing DHCP server responses.
Changed property dot1xPortControl (object)
The 802.1X port control mode determining authentication requirements: auto, force authorized, or force unauthorized.
Changed property egressAcl (object)
The name of the Access Control List applied to egress (outgoing) traffic on this port.
Changed property flexibleAuthenticationEnabled (object)
The flag indicating whether flexible authentication with multiple methods is enabled on this port.
Changed property guestVlan (object)
The VLAN ID for guest users who bypass authentication.
Changed property ignoreFields (object)
The comma separated list of field names to ignore during update operations.
Changed property ingressAcl (object)
The name of the Access Control List applied to ingress (incoming) traffic on this port.
Changed property ipsg (object)
The flag indicating whether IP source guard is enabled for additional layer 2 security.
Changed property lldpEnable (object)
The flag indicating whether LLDP (Link Layer Discovery Protocol) is enabled on this port.
Changed property lldpQos (object)
The set of LLDP (Link Layer Discovery Protocol) QoS (Quality of Service) configurations for network priority advertising.
Changed property name (object)
The descriptive name or label assigned to the port for identification purposes.
Changed property poeBudget (object)
The PoE power budget allocated to this port in watts.
Changed property poeCapability (object)
The flag indicating whether this port has PoE (Power over Ethernet) hardware capability.
Changed property poeClass (object)
The PoE (Power over Ethernet) class indicating the maximum power level supported by the connected device.
Changed property poeEnable (object)
The flag indicating whether PoE (Power over Ethernet) is enabled on this port.
Changed property poePriority (object)
The PoE priority level for power allocation, with lower values indicating higher priority.
Changed property portEnable (object)
The flag indicating whether the port is administratively enabled for traffic forwarding.
Changed property portProtected (object)
The flag indicating whether the port is configured as a protected port, preventing communication with other protected ports.
Changed property portSecurity (object)
The flag indicating whether port security is enabled to restrict MAC addresses allowed on this port.
Changed property portSecurityMaxEntries (object)
The maximum number of MAC addresses allowed when port security is enabled.
Changed property portSpeed (object)
The configured speed setting for the port, such as auto negotiation or specific speed values.
Changed property ports (object)
The set of port identifiers when performing batch operations on multiple ports.
Changed property restrictedVlan (object)
The VLAN ID for users who fail authorization after successful authentication.
Changed property revert (object)
The flag indicating whether to revert port configuration to profile defaults.
Changed property rstpAdminEdgePort (object)
The flag indicating whether this port is configured as an edge port in RSTP (Rapid Spanning Tree Protocol).
Changed property stpBpduGuard (object)
Enable STP (Spanning Tree Protocol) BPDU (Bridge Protocol Data Unit) guard to automatically disable the port when BPDU frames are received.
Changed property stpRootGuard (object)
The flag indicating whether STP (Spanning Tree Protocol) root guard is enabled to prevent the port from becoming a root port.
Changed property switchMacAcl (object)
The name of the MAC based ACL (Access Control List) applied to this port for layer 2 filtering.
Changed property switchPortProfileId (object)
The identifier of the switch port profile configuration applied to this port.
Changed property taggedVlans (object)
The set of VLAN IDs configured as tagged VLANs on this port for 802.1Q trunking.
Changed property tags (object)
The comma separated list of custom tags assigned to this port for organization and filtering.
Changed property untaggedVlan (object)
The VLAN ID configured as the untagged (native) VLAN for this port.
Changed property voiceVlan (object)
The VLAN ID designated for voice traffic, typically used for VoIP devices.
Changed property poeScheduler (object)
The scheduler view, representing a time-based schedule with weekly patterns for automated task execution.
- Changed property fri (object)
  Friday schedule pattern as a 24-character string where each character represents an hour of the day.
- Changed property mon (object)
  Monday schedule pattern as a 24-character string where each character represents an hour of the day.
- Changed property sat (object)
  Saturday schedule pattern as a 24-character string where each character represents an hour of the day.
- Changed property sun (object)
  Sunday schedule pattern as a 24-character string where each character represents an hour of the day.
- Changed property thu (object)
  Thursday schedule pattern as a 24-character string where each character represents an hour of the day.
- Changed property tue (object)
  Tuesday schedule pattern as a 24-character string where each character represents an hour of the day.
- Changed property type (object)
  The type of scheduler defining the execution pattern.
- Changed property wed (object)
  Wednesday schedule pattern as a 24-character string where each character represents an hour of the day.

Return Type:

Changed response : 400 Bad Request

Bad/malformed request

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 401 Unauthorized

Unauthorized

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 403 Forbidden

Forbidden

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 404 Not Found

Requested resource or related entity not found

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 422 Unprocessable Entity

Validation error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 500 Internal Server Error

Internal Server Error

Changed content type : application/json
- Changed property downloadUrl (object)
  The download url of the import file.
- Changed property errors (object)
  The list of error messages.
- Changed property requestId (object)
  The unique identifier for tracking this request.

Changed response : 200 OK

OK

Changed content type : application/json
- Changed property requestId (object)
  The unique identifier for tracking this API operation request.
- Changed property response (object)
  The port view, representing a switch port configuration with comprehensive settings including VLANs, PoE, security features, authentication, and protocol configurations.
  - Changed property adminPtToPt (object)
    The RSTP (Rapid Spanning Tree Protocol) point-to-point MAC mode.
  - Changed property arpInspectionTrust (object)
    The flag indicating whether this port is trusted for ARP inspection, bypassing ARP validation.
  - Changed property authDefaultVlan (object)
    The VLAN ID to assign authenticated users when no specific VLAN is provided by the AAA server.
  - Changed property authFailAction (object)
    The action to take when authentication fails: restricted VLAN, drop, or block.
  - Changed property authTimeoutAction (object)
    The action to take when authentication times out: same as auth fail or critical VLAN.
  - Changed property authenticationCustomize (object)
    The flag indicating whether port specific authentication settings override the profile defaults.
  - Changed property authenticationProfileId (object)
    The identifier of the authentication profile applied to this port for access control.
  - Changed property authenticationType (object)
    The authentication method type configured for this port, such as 802.1X, MAC authentication, or Web authentication.
  - Changed property changeAuthOrder (object)
    The flag indicating whether the authentication method order has been modified from defaults.
  - Changed property criticalVlan (object)
    The VLAN ID for critical users requiring network access during AAA server failure.
  - Changed property dhcpSnoopingTrust (object)
    The flag indicating whether this port is trusted for DHCP snooping, allowing DHCP server responses.
  - Changed property dot1xPortControl (object)
    The 802.1X port control mode determining authentication requirements: auto, force authorized, or force unauthorized.
  - Changed property egressAcl (object)
    The name of the Access Control List applied to egress (outgoing) traffic on this port.
  - Changed property enableAuthPorts (object)
    The list of port identifiers where authentication is enabled, displayed in the UI.
  - Changed property flexibleAuthenticationEnabled (object)
    The flag indicating whether flexible authentication with multiple methods is enabled on this port.
  - Changed property guestVlan (object)
    The VLAN ID for guest users who bypass authentication.
  - Changed property ignoreFields (object)
    The comma separated list of field names to ignore during update operations.
  - Changed property ingressAcl (object)
    The name of the Access Control List applied to ingress (incoming) traffic on this port.
  - Changed property ipsg (object)
    The flag indicating whether IP source guard is enabled for additional layer 2 security.
  - Changed property lldpEnable (object)
    The flag indicating whether LLDP (Link Layer Discovery Protocol) is enabled on this port.
  - Changed property lldpQos (object)
    The set of LLDP (Link Layer Discovery Protocol) QoS (Quality of Service) configurations for network priority advertising.
  - Changed property name (object)
    The descriptive name or label assigned to the port for identification purposes.
  - Changed property poeBudget (object)
    The PoE power budget allocated to this port in watts.
  - Changed property poeCapability (object)
    The flag indicating whether this port has PoE (Power over Ethernet) hardware capability.
  - Changed property poeClass (object)
    The PoE (Power over Ethernet) class indicating the maximum power level supported by the connected device.
  - Changed property poeEnable (object)
    The flag indicating whether PoE (Power over Ethernet) is enabled on this port.
  - Changed property poePriority (object)
    The PoE priority level for power allocation, with lower values indicating higher priority.
  - Changed property portEnable (object)
    The flag indicating whether the port is administratively enabled for traffic forwarding.
  - Changed property portProtected (object)
    The flag indicating whether the port is configured as a protected port, preventing communication with other protected ports.
  - Changed property portSecurity (object)
    The flag indicating whether port security is enabled to restrict MAC addresses allowed on this port.
  - Changed property portSecurityMaxEntries (object)
    The maximum number of MAC addresses allowed when port security is enabled.
  - Changed property portSpeed (object)
    The configured speed setting for the port, such as auto negotiation or specific speed values.
  - Changed property ports (object)
    The set of port identifiers when performing batch operations on multiple ports.
  - Changed property profileAuthDefaultVlan (object)
    The authentication default VLAN ID configured at the profile level for reference in the UI.
  - Changed property profileName (object)
    The name of the profile applied to this port, displayed in the UI for reference.
  - Changed property restrictedVlan (object)
    The VLAN ID for users who fail authorization after successful authentication.
  - Changed property revert (object)
    The flag indicating whether to revert port configuration to profile defaults.
  - Changed property rstpAdminEdgePort (object)
    The flag indicating whether this port is configured as an edge port in RSTP (Rapid Spanning Tree Protocol).
  - Changed property shouldAlertAaaAndRadiusNotApply (object)
    The flag indicating whether to alert users when AAA and RADIUS configurations cannot be applied to the switch.
  - Changed property stpBpduGuard (object)
    Indicates whether STP (Spanning Tree Protocol) BPDU (Bridge Protocol Data Unit) guard is enabled. When enabled, the port is disabled if BPDU frames are received.
  - Changed property stpRootGuard (object)
    The flag indicating whether STP (Spanning Tree Protocol) root guard is enabled to prevent the port from becoming a root port.
  - Changed property switchLevelAuthDefaultVlan (object)
    The authentication default VLAN ID configured at the switch level for reference in the UI.
  - Changed property switchMac (object)
    The MAC address of the switch to which this port belongs, used for UI identification.
  - Changed property switchMacAcl (object)
    The name of the MAC based ACL (Access Control List) applied to this port for layer 2 filtering.
  - Changed property switchPortProfileId (object)
    The identifier of the switch port profile configuration applied to this port.
  - Changed property taggedVlans (object)
    The ordered set of VLAN IDs configured as tagged VLANs on this port for 802.1Q trunking.
  - Changed property tags (object)
    The comma separated list of custom tags assigned to this port for organization and filtering.
  - Changed property untaggedVlan (object)
    The VLAN ID configured as the untagged (native) VLAN for this port.
  - Changed property voiceVlan (object)
    The VLAN ID designated for voice traffic, typically used for VoIP devices.
  - Changed property vsixEgressAcl (object)
    The name of the VSIX ACL applied to egress traffic for virtual switch integration.
  - Changed property vsixIngressAcl (object)
    The name of the VSIX ACL applied to ingress traffic for virtual switch integration.
  - Changed property poeScheduler (object)
    The scheduler view, representing a time-based schedule with weekly patterns for automated task execution.
    - Changed property fri (object)
      Friday schedule pattern as a 24-character string where each character represents an hour of the day.
    - Changed property mon (object)
      Monday schedule pattern as a 24-character string where each character represents an hour of the day.
    - Changed property sat (object)
      Saturday schedule pattern as a 24-character string where each character represents an hour of the day.
    - Changed property sun (object)
      Sunday schedule pattern as a 24-character string where each character represents an hour of the day.
    - Changed property thu (object)
      Thursday schedule pattern as a 24-character string where each character represents an hour of the day.
    - Changed property tue (object)
      Tuesday schedule pattern as a 24-character string where each character represents an hour of the day.
    - Changed property type (object)
      The type of scheduler defining the execution pattern.
    - Changed property wed (object)
      Wednesday schedule pattern as a 24-character string where each character represents an hour of the day.
Changed content type : application/vnd.ruckus.v1+json
- Changed property requestId (object)
  The unique identifier for tracking this API operation request.
- Changed property response (object)
  The port view, representing a switch port configuration with comprehensive settings including VLANs, PoE, security features, authentication, and protocol configurations.
  - Changed property adminPtToPt (object)
    The RSTP (Rapid Spanning Tree Protocol) point-to-point MAC mode.
  - Changed property arpInspectionTrust (object)
    The flag indicating whether this port is trusted for ARP inspection, bypassing ARP validation.
  - Changed property authDefaultVlan (object)
    The VLAN ID to assign authenticated users when no specific VLAN is provided by the AAA server.
  - Changed property authFailAction (object)
    The action to take when authentication fails: restricted VLAN, drop, or block.
  - Changed property authTimeoutAction (object)
    The action to take when authentication times out: same as auth fail or critical VLAN.
  - Changed property authenticationCustomize (object)
    The flag indicating whether port specific authentication settings override the profile defaults.
  - Changed property authenticationProfileId (object)
    The identifier of the authentication profile applied to this port for access control.
  - Changed property authenticationType (object)
    The authentication method type configured for this port, such as 802.1X, MAC authentication, or Web authentication.
  - Changed property changeAuthOrder (object)
    The flag indicating whether the authentication method order has been modified from defaults.
  - Changed property criticalVlan (object)
    The VLAN ID for critical users requiring network access during AAA server failure.
  - Changed property dhcpSnoopingTrust (object)
    The flag indicating whether this port is trusted for DHCP snooping, allowing DHCP server responses.
  - Changed property dot1xPortControl (object)
    The 802.1X port control mode determining authentication requirements: auto, force authorized, or force unauthorized.
  - Changed property egressAcl (object)
    The name of the Access Control List applied to egress (outgoing) traffic on this port.
  - Changed property enableAuthPorts (object)
    The list of port identifiers where authentication is enabled, displayed in the UI.
  - Changed property flexibleAuthenticationEnabled (object)
    The flag indicating whether flexible authentication with multiple methods is enabled on this port.
  - Changed property guestVlan (object)
    The VLAN ID for guest users who bypass authentication.
  - Changed property ignoreFields (object)
    The comma separated list of field names to ignore during update operations.
  - Changed property ingressAcl (object)
    The name of the Access Control List applied to ingress (incoming) traffic on this port.
  - Changed property ipsg (object)
    The flag indicating whether IP source guard is enabled for additional layer 2 security.
  - Changed property lldpEnable (object)
    The flag indicating whether LLDP (Link Layer Discovery Protocol) is enabled on this port.
  - Changed property lldpQos (object)
    The set of LLDP (Link Layer Discovery Protocol) QoS (Quality of Service) configurations for network priority advertising.
  - Changed property name (object)
    The descriptive name or label assigned to the port for identification purposes.
  - Changed property poeBudget (object)
    The PoE power budget allocated to this port in watts.
  - Changed property poeCapability (object)
    The flag indicating whether this port has PoE (Power over Ethernet) hardware capability.
  - Changed property poeClass (object)
    The PoE (Power over Ethernet) class indicating the maximum power level supported by the connected device.
  - Changed property poeEnable (object)
    The flag indicating whether PoE (Power over Ethernet) is enabled on this port.
  - Changed property poePriority (object)
    The PoE priority level for power allocation, with lower values indicating higher priority.
  - Changed property portEnable (object)
    The flag indicating whether the port is administratively enabled for traffic forwarding.
  - Changed property portProtected (object)
    The flag indicating whether the port is configured as a protected port, preventing communication with other protected ports.
  - Changed property portSecurity (object)
    The flag indicating whether port security is enabled to restrict MAC addresses allowed on this port.
  - Changed property portSecurityMaxEntries (object)
    The maximum number of MAC addresses allowed when port security is enabled.
  - Changed property portSpeed (object)
    The configured speed setting for the port, such as auto negotiation or specific speed values.
  - Changed property ports (object)
    The set of port identifiers when performing batch operations on multiple ports.
  - Changed property profileAuthDefaultVlan (object)
    The authentication default VLAN ID configured at the profile level for reference in the UI.
  - Changed property profileName (object)
    The name of the profile applied to this port, displayed in the UI for reference.
  - Changed property restrictedVlan (object)
    The VLAN ID for users who fail authorization after successful authentication.
  - Changed property revert (object)
    The flag indicating whether to revert port configuration to profile defaults.
  - Changed property rstpAdminEdgePort (object)
    The flag indicating whether this port is configured as an edge port in RSTP (Rapid Spanning Tree Protocol).
  - Changed property shouldAlertAaaAndRadiusNotApply (object)
    The flag indicating whether to alert users when AAA and RADIUS configurations cannot be applied to the switch.
  - Changed property stpBpduGuard (object)
    Indicates whether STP (Spanning Tree Protocol) BPDU (Bridge Protocol Data Unit) guard is enabled. When enabled, the port is disabled if BPDU frames are received.
  - Changed property stpRootGuard (object)
    The flag indicating whether STP (Spanning Tree Protocol) root guard is enabled to prevent the port from becoming a root port.
  - Changed property switchLevelAuthDefaultVlan (object)
    The authentication default VLAN ID configured at the switch level for reference in the UI.
  - Changed property switchMac (object)
    The MAC address of the switch to which this port belongs, used for UI identification.
  - Changed property switchMacAcl (object)
    The name of the MAC based ACL (Access Control List) applied to this port for layer 2 filtering.
  - Changed property switchPortProfileId (object)
    The identifier of the switch port profile configuration applied to this port.
  - Changed property taggedVlans (object)
    The ordered set of VLAN IDs configured as tagged VLANs on this port for 802.1Q trunking.
  - Changed property tags (object)
    The comma separated list of custom tags assigned to this port for organization and filtering.
  - Changed property untaggedVlan (object)
    The VLAN ID configured as the untagged (native) VLAN for this port.
  - Changed property voiceVlan (object)
    The VLAN ID designated for voice traffic, typically used for VoIP devices.
  - Changed property vsixEgressAcl (object)
    The name of the VSIX ACL applied to egress traffic for virtual switch integration.
  - Changed property vsixIngressAcl (object)
    The name of the VSIX ACL applied to ingress traffic for virtual switch integration.
  - Changed property poeScheduler (object)
    The scheduler view, representing a time-based schedule with weekly patterns for automated task execution.
    - Changed property fri (object)
      Friday schedule pattern as a 24-character string where each character represents an hour of the day.
    - Changed property mon (object)
      Monday schedule pattern as a 24-character string where each character represents an hour of the day.
    - Changed property sat (object)
      Saturday schedule pattern as a 24-character string where each character represents an hour of the day.
    - Changed property sun (object)
      Sunday schedule pattern as a 24-character string where each character represents an hour of the day.
    - Changed property thu (object)
      Thursday schedule pattern as a 24-character string where each character represents an hour of the day.
    - Changed property tue (object)
      Tuesday schedule pattern as a 24-character string where each character represents an hour of the day.
    - Changed property type (object)
      The type of scheduler defining the execution pattern.
    - Changed property wed (object)
      Wednesday schedule pattern as a 24-character string where each character represents an hour of the day.