Skip to content
/
Associate Switch Profile...

Switch Service API & Model Documentation (0.3.4)

Overview

Rate Limit

For the Switch REST API the following will be true:

  • Limits are applied to each tenant.
  • A maximum of 20 calls can be made per second.
  • Each second 10 calls will be returned to be used.
Download OpenAPI description
Download PDF
Overview
License

RUCKUS Cloud Privacy Policy

Terms of Service

Languages
Servers
Asian region

https://api.asia.ruckus.cloud/

European region

https://api.eu.ruckus.cloud/

North American region

https://api.ruckus.cloud/

AAA Server

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

Operations

AAA Setting

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

Operations

Command-Line Interface Template

Manage command-line interface templates.

Operations

Configuration History

Retrieve configuration history.

Operations

DHCP Server

Manage ICX DHCP servers.

Operations

ICX Switch

Manage ICX Switches.

Operations

Import Switch

Import Switches.

Operations

LAG

Manage LAGs (link aggregation groups).

Operations

Profile

Manage switch profiles.

Operations

Associate Switch Profile to Venue

Request

Associate a switch profile to a venue.

Security
jwtAuth
Path
venueIdstringrequired
switchProfileIdstringrequired
No request payload

Responses

Accepted

Body
requestIdstring
responseobject(EmptyView)
Response
{
  "requestId": "string",
  "response": {
    "id": "string"
  }
}

Disassociate Switch Profile to Venue

Request

Disassociate a switch profile to a venue.

Security
jwtAuth
Path
venueIdstringrequired
switchProfileIdstringrequired
No request payload

Responses

Accepted

Body
requestIdstring
responseobject(EmptyView)
Response
{
  "requestId": "string",
  "response": {
    "id": "string"
  }
}

Get Switch Profile

Request

Get a regular switch profile or command-line interface profile.

Security
jwtAuth
Path
switchProfileIdstringrequired
No request payload

Responses

OK

Body
idstring
namestring
descriptionstring
aclsArray of objects(AclView)unique
vlansArray of objects(VlanView)unique
voiceVlanConfigsArray of objects(VoiceVlanConfigView)unique
trustedPortsArray of objects(TrustedPortView)unique
profileTypestring
Enum"Regular""CLI"
venueCliTemplateobject(AcxVenueCliTemplateView)
venuesArray of stringsunique
venueCountinteger(int64)
templateIdstring
templateVersioninteger(int64)
applyOnboardOnlyboolean
Response
{
  "id": "string",
  "name": "string",
  "description": "string",
  "acls": [
    { … }
  ],
  "vlans": [
    { … }
  ],
  "voiceVlanConfigs": [
    { … }
  ],
  "trustedPorts": [
    { … }
  ],
  "profileType": "Regular",
  "venueCliTemplate": {
    "id": "string",
    "name": "string",
    "cli": "string",
    "switchModels": "string",
    "variables": [ … ],
    "overwrite": true
  },
  "venues": [
    "string"
  ],
  "venueCount": 0,
  "templateId": "string",
  "templateVersion": 0,
  "applyOnboardOnly": true
}

Update Switch Profile

Request

Update a regular switch profile or command-line interface profile. Use activity API with request id to get the status update.

Security
jwtAuth
Path
switchProfileIdstringrequired
Body
required
namestring^.{1,64}$
descriptionstring
venuesArray of strings
idstring
aclsArray of objects(AclBo)unique
profileTypestring
Enum"Regular""CLI"
vlansArray of objects(VlanBo)unique
voiceVlanConfigsArray of objects(VoiceVlanConfigBo)unique
trustedPortsArray of objects(TrustedPortBo)unique
venueCliTemplateobject(AcxVenueCliTemplateBo)
isTemplateboolean
templateIdstring
templateVersioninteger(int64)
applyOnboardOnlyboolean
portProfileMappingsArray of objects(PortProfileAndProfileMappingBo)unique
{
  "name": "string",
  "description": "string",
  "venues": [
    "string"
  ],
  "id": "string",
  "acls": [
    { … }
  ],
  "profileType": "Regular",
  "vlans": [
    { … }
  ],
  "voiceVlanConfigs": [
    { … }
  ],
  "trustedPorts": [
    { … }
  ],
  "venueCliTemplate": {
    "id": "string",
    "name": "string",
    "cli": "string",
    "switchModels": "string",
    "variables": [ … ],
    "overwrite": true,
    "customizedSerialSet": [ … ]
  },
  "isTemplate": true,
  "templateId": "string",
  "templateVersion": 0,
  "applyOnboardOnly": true,
  "portProfileMappings": [
    { … }
  ]
}

Responses

OK

Body
requestIdstring
responseobject(EmptyView)
Response
{
  "requestId": "string",
  "response": {
    "id": "string"
  }
}

Delete Switch Profile

Request

Delete a regular switch profile or command-line interface profile.

Security
jwtAuth
Path
switchProfileIdstringrequired
No request payload

Responses

OK

Body
requestIdstring
responseobject(EmptyView)
Response
{
  "requestId": "string",
  "response": {
    "id": "string"
  }
}

Add Switch Profile

Request

Add a regular switch profile or command-line interface profile. Use activity API with request id to get the status update.

Security
jwtAuth
Body
required
namestring^.{1,64}$
descriptionstring
venuesArray of strings
idstring
aclsArray of objects(AclBo)unique
profileTypestring
Enum"Regular""CLI"
vlansArray of objects(VlanBo)unique
voiceVlanConfigsArray of objects(VoiceVlanConfigBo)unique
trustedPortsArray of objects(TrustedPortBo)unique
venueCliTemplateobject(AcxVenueCliTemplateBo)
isTemplateboolean
templateIdstring
templateVersioninteger(int64)
applyOnboardOnlyboolean
portProfileMappingsArray of objects(PortProfileAndProfileMappingBo)unique
{
  "name": "string",
  "description": "string",
  "venues": [
    "string"
  ],
  "id": "string",
  "acls": [
    { … }
  ],
  "profileType": "Regular",
  "vlans": [
    { … }
  ],
  "voiceVlanConfigs": [
    { … }
  ],
  "trustedPorts": [
    { … }
  ],
  "venueCliTemplate": {
    "id": "string",
    "name": "string",
    "cli": "string",
    "switchModels": "string",
    "variables": [ … ],
    "overwrite": true,
    "customizedSerialSet": [ … ]
  },
  "isTemplate": true,
  "templateId": "string",
  "templateVersion": 0,
  "applyOnboardOnly": true,
  "portProfileMappings": [
    { … }
  ]
}

Responses

OK

Body
requestIdstring
responseobject(EmptyView)
Response
{
  "requestId": "string",
  "response": {
    "id": "string"
  }
}

Query Switch Profiles

Request

List the regular switch profiles or command-line interface profiles.

Security
jwtAuth
Body
required
fieldsArray of strings
pageinteger(int32)
pageSizeinteger(int32)
sortFieldstring
sortOrderstring
Enum"ASC""DESC"
filtersobject
searchStringstring
searchTargetFieldsArray of strings
filterTypestringDeprecated
{
  "fields": [
    "string"
  ],
  "page": 0,
  "pageSize": 0,
  "sortField": "string",
  "sortOrder": "ASC",
  "filterType": "string",
  "filters": {
    "property1": [ … ],
    "property2": [ … ]
  },
  "searchString": "string",
  "searchTargetFields": [
    "string"
  ]
}

Responses

OK

Body
idstring
dataArray of objects
fieldsArray of strings
pageinteger(int32)
totalCountinteger(int64)
totalPagesinteger(int32)
Response
{
  "id": "string",
  "data": [
    {}
  ],
  "fields": [
    "string"
  ],
  "page": 0,
  "totalCount": 0,
  "totalPages": 0
}

Get Switch Profiles

Request

Get regular switch profiles or command-line interface profiles of the venue.

Security
jwtAuth
Path
venueIdstringrequired
No request payload

Responses

OK

Body
idstring
namestring
descriptionstring
aclsArray of objects(AclView)unique
vlansArray of objects(VlanView)unique
voiceVlanConfigsArray of objects(VoiceVlanConfigView)unique
trustedPortsArray of objects(TrustedPortView)unique
profileTypestring
Enum"Regular""CLI"
venueCliTemplateobject(AcxVenueCliTemplateView)
venuesArray of stringsunique
venueCountinteger(int64)
templateIdstring
templateVersioninteger(int64)
applyOnboardOnlyboolean
Response
{
  "id": "string",
  "name": "string",
  "description": "string",
  "acls": [
    { … }
  ],
  "vlans": [
    { … }
  ],
  "voiceVlanConfigs": [
    { … }
  ],
  "trustedPorts": [
    { … }
  ],
  "profileType": "Regular",
  "venueCliTemplate": {
    "id": "string",
    "name": "string",
    "cli": "string",
    "switchModels": "string",
    "variables": [ … ],
    "overwrite": true
  },
  "venues": [
    "string"
  ],
  "venueCount": 0,
  "templateId": "string",
  "templateVersion": 0,
  "applyOnboardOnly": true
}

Profile Template

Manage switch profile templates.

Operations

Profile VLAN

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

Operations

Switch Access Control List

Manage ACLs (access control lists).

Operations

Switch Configuration Backup

Manage configuration backups.

Operations

Switch Firmware Upgrade

Manage firmware upgrade.

Operations

Switch Ports

Manage Ports.

Operations

Switch Static Routes

Manage static routes.

Operations

Switch VLAN

Manage VLANs (virtual local area networks).

Operations

Switch Virtual Ethernet

Manage VE (virtual ethernet) port settings.

Operations

Venue Switch Setting

Manage a switch's venue-level settings.

Operations

Venue Template AAA Server

Manage Venue Template AAA (authentication, authorization, and accounting) Servers.

Operations

Venue Template AAA Setting

Manage Venue Template AAA (authentication, authorization, and accounting) Settings.

Operations

Venue Template Switch Setting

Manage switch settings of venue template.

Operations

Web Authentication Page Template

Manage web authentication page template.

Operations