Skip to content
/
Activate Wi-Fi Network Te...

Wi-Fi API and Model Documentation (17.3.3.195)

https://support.ruckuswireless.com/ruckus-cloud-wifi-legal-terms-and-conditions

Overview

Rate Limit

For the Wifi REST API the following will be true:

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

RUCKUS Cloud Privacy Policy

Languages
Servers
Asian region

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

European region

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

North American region

https://api.ruckus.cloud/

Wi-Fi Network Template

Manage Wi-Fi network template profiles.

Operations

Deactivate Wi-Fi Network Template On Venue Template

Request

Use this API to delete a relationship between Wi-Fi network template and venue template.

Path
venueIdstringrequired

Venue ID

wifiNetworkIdstringrequired

Wi-Fi Network ID

No request payload

Responses

Accepted

Body
requestIdstring
Response
{
  "requestId": "string"
}

Activate Wi-Fi Network Template On Venue Template

Request

Use this API to build a relationship between Wi-Fi network template and venue template.

Path
venueIdstringrequired

Venue ID

wifiNetworkIdstringrequired

Wi-Fi Network ID

Body
isAllApGroupsboolean
Default true
{
  "isAllApGroups": true
}

Responses

Accepted

Body
requestIdstring
Response
{
  "requestId": "string"
}

Get Venue Wi-Fi Network Template Settings

Request

Get Wi-Fi network template settings on this venue template.

Path
venueIdstringrequired

Venue ID

wifiNetworkIdstringrequired

Wi-Fi Network ID

No request payload

Responses

OK

Body
allApGroupsRadioTypesArray of strings
Items Enum"2.4-GHz""5-GHz""6-GHz"
allApGroupsVlanIdinteger(int32)[ 1 .. 4094 ]
isAllApGroupsboolean
Default true
schedulerobject(NetworkVenueScheduler)

Network-Venue scheduler

Response
{
  "allApGroupsRadioTypes": [
    "2.4-GHz"
  ],
  "allApGroupsVlanId": 1,
  "isAllApGroups": true,
  "scheduler": {
    "fri": "string",
    "mon": "string",
    "sat": "string",
    "sun": "string",
    "thu": "string",
    "tue": "string",
    "type": "ALWAYS_ON",
    "wed": "string"
  }
}

Update Venue Wi-Fi Network Template Settings

Request

Update Wi-Fi network template settings on this venue template.

Path
venueIdstringrequired

Venue ID

wifiNetworkIdstringrequired

Wi-Fi Network ID

Body
required
allApGroupsRadioTypesArray of strings
Items Enum"2.4-GHz""5-GHz""6-GHz"
allApGroupsVlanIdinteger(int32)[ 1 .. 4094 ]
isAllApGroupsboolean
Default true
schedulerobject(NetworkVenueScheduler)

Network-Venue scheduler

{
  "allApGroupsRadioTypes": [
    "2.4-GHz"
  ],
  "allApGroupsVlanId": 1,
  "isAllApGroups": true,
  "scheduler": {
    "fri": "string",
    "mon": "string",
    "sat": "string",
    "sun": "string",
    "thu": "string",
    "tue": "string",
    "type": "ALWAYS_ON",
    "wed": "string"
  }
}

Responses

Accepted

Body
requestIdstring
Response
{
  "requestId": "string"
}

Create Wi-Fi Network Template

Request

Create a new Wi-Fi network template.

Body
required
One of:

AAA Wi-Fi network

namestring(?=^((?!(`|\$\()).){2,32}$)^(\S.*\S)$required
typestringrequired
descriptionstring[ 0 .. 256 ] characters
useCertificateTemplateboolean
Default false
wlanobject(AAAWifiWlan)required

AAA Wi-Fi WLAN

wlan.​advancedCustomizationobject(AAAWifiWlanAdvancedCustomization)

WLAN advanced customization

wlan.​bypassCNAboolean
Default false
wlan.​bypassCPUsingMacAddressAuthenticationboolean
Default false
wlan.​enabledboolean
Default true
wlan.​macAddressAuthenticationboolean
Default false
wlan.​managementFrameProtectionstring or null
Enum"Disabled""Optional""Required"
wlan.​ssidstring[^`\s]([^`\t\r\n]){0,30}[^`\s]required
wlan.​vlanIdinteger(int32)[ 1 .. 4094 ]
Default 1
wlan.​wlanSecuritystring
Default "WPA2Enterprise"
Enum"WPA2Enterprise""WPA3"
{
  "name": "string",
  "type": "string",
  "description": "string",
  "useCertificateTemplate": false,
  "wlan": {
    "advancedCustomization": { … },
    "bypassCNA": false,
    "bypassCPUsingMacAddressAuthentication": false,
    "enabled": true,
    "macAddressAuthentication": false,
    "managementFrameProtection": "Disabled",
    "ssid": "string",
    "vlanId": 1,
    "wlanSecurity": "WPA2Enterprise"
  }
}

Responses

Accepted

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

Delete Wi-Fi Network Template

Request

Delete a Wi-Fi network template.

Path
wifiNetworkTemplateIdstringrequired

Wi-Fi Network Template ID

No request payload

Responses

Accepted

Body
requestIdstring
Response
{
  "requestId": "string"
}

Get Wi-Fi Network Template

Request

Get the Wi-Fi network template details.

Path
wifiNetworkTemplateIdstringrequired

Wi-Fi Network Template ID

No request payload

Responses

OK

Body
idstringread-only
namestring(?=^((?!(`|\$\()).){2,32}$)^(\S.*\S)$required
typestringrequired
Discriminator
descriptionstring[ 0 .. 256 ] characters
useCertificateTemplateboolean
Default false
wlanobject(AAAWifiWlan)required

AAA Wi-Fi WLAN

wlan.​advancedCustomizationobject(AAAWifiWlanAdvancedCustomization)

WLAN advanced customization

wlan.​bypassCNAboolean
Default false
wlan.​bypassCPUsingMacAddressAuthenticationboolean
Default false
wlan.​enabledboolean
Default true
wlan.​macAddressAuthenticationboolean
Default false
wlan.​managementFrameProtectionstring or null
Enum"Disabled""Optional""Required"
wlan.​ssidstring[^`\s]([^`\t\r\n]){0,30}[^`\s]required
wlan.​vlanIdinteger(int32)[ 1 .. 4094 ]
Default 1
wlan.​wlanSecuritystring
Default "WPA2Enterprise"
Enum"WPA2Enterprise""WPA3"
Response
{
  "id": "string",
  "name": "string",
  "type": "AAAWifiNetwork",
  "description": "string",
  "useCertificateTemplate": false,
  "wlan": {
    "advancedCustomization": { … },
    "bypassCNA": false,
    "bypassCPUsingMacAddressAuthentication": false,
    "enabled": true,
    "macAddressAuthentication": false,
    "managementFrameProtection": "Disabled",
    "ssid": "string",
    "vlanId": 1,
    "wlanSecurity": "WPA2Enterprise"
  }
}

Update Wi-Fi Network Template

Request

Update this Wi-Fi network template, including nested details.

Path
wifiNetworkTemplateIdstringrequired

Wi-Fi Network Template ID

Body
required
One of:

AAA Wi-Fi network

namestring(?=^((?!(`|\$\()).){2,32}$)^(\S.*\S)$required
typestringrequired
descriptionstring[ 0 .. 256 ] characters
useCertificateTemplateboolean
Default false
wlanobject(AAAWifiWlan)required

AAA Wi-Fi WLAN

wlan.​advancedCustomizationobject(AAAWifiWlanAdvancedCustomization)

WLAN advanced customization

wlan.​bypassCNAboolean
Default false
wlan.​bypassCPUsingMacAddressAuthenticationboolean
Default false
wlan.​enabledboolean
Default true
wlan.​macAddressAuthenticationboolean
Default false
wlan.​managementFrameProtectionstring or null
Enum"Disabled""Optional""Required"
wlan.​ssidstring[^`\s]([^`\t\r\n]){0,30}[^`\s]required
wlan.​vlanIdinteger(int32)[ 1 .. 4094 ]
Default 1
wlan.​wlanSecuritystring
Default "WPA2Enterprise"
Enum"WPA2Enterprise""WPA3"
{
  "name": "string",
  "type": "string",
  "description": "string",
  "useCertificateTemplate": false,
  "wlan": {
    "advancedCustomization": { … },
    "bypassCNA": false,
    "bypassCPUsingMacAddressAuthentication": false,
    "enabled": true,
    "macAddressAuthentication": false,
    "managementFrameProtection": "Disabled",
    "ssid": "string",
    "vlanId": 1,
    "wlanSecurity": "WPA2Enterprise"
  }
}

Responses

Accepted

Body
requestIdstring
Response
{
  "requestId": "string"
}

Clone Wi-Fi Network Template

Request

Clone a existing Wi-Fi network template.

Path
wifiNetworkTemplateIdstringrequired

Wi-Fi Network Template ID

Body
required
idstring
namestringrequired
{
  "id": "string",
  "name": "string"
}

Responses

Accepted

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