Skip to content
Wifi Services/
/
Get Ap Group Client Admis...

Wifi Services (17.3.3.259)

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
RUCKUS One API host for North American region.
https://api.ruckus.cloud
RUCKUS One API host for European region.
https://api.eu.ruckus.cloud
RUCKUS One API host for Asian region.
https://api.asia.ruckus.cloud

Hotspot 2.0 Identity Provider

Manage Hotspot 2.0 identity providers including creation, updates, and assignments.

Operations

Syslog Server Profile Template

Manage Syslog server profile templates.

Operations

Application Library

Manage the current tenant's application library and settings.

Operations

Wi-Fi Network Template

Manage Wi-Fi network template profiles.

Operations

Wi-Fi Portal Service Profile

Portal service profile.

Operations

SAML Identity Provider Profile

Manage SAML identity provider profiles.

Operations

Layer 3 ACL Policy

Manage layer 3 ACL policy profiles.

Operations

Access Control Profile Template

Manage access control profile templates that define reusable network access policies for Wi-Fi networks and clients.

Operations

DPSK Service

Manage DPSK (Dynamic Pre-Shared Key) services including creation, updates, and associations with Wi-Fi networks for per-user authentication.

Operations

AP Group Template

Manage AP Group templates.

Operations

Portal Service Profile Template

Portal service profile template.

Operations

RADIUS Profile

Manage RADIUS server profiles.

Operations

Device Policy Template

Manage device policy templates.

Operations

Application Policy Template

Manage application policy template profile template.

Operations

Location Based Service Server Profile

Manage location based service server profiles.

Operations

Layer 2 ACL Policy Template

Manage layer 2 ACL policy profile templates.

Operations

Wi-Fi Network Activation

Manage Wi-Fi network venue activation relationships.

Operations

VLAN Pool Profile Template

Manage VLAN pool profile templates.

Operations

Hotspot 2.0 Operator

Manage Hotspot 2.0 operators including creation, updates, assignments, and network associations.

Operations

AP Compatibility

Query AP feature compatibility report, including incompatible feature of AP model and firmware version.

Operations

SNMP Agent Profile

Manage SNMP agent profiles.

Operations

RADIUS Server Profile Template

Manage RADIUS server profile templates.

Operations

Layer 3 ACL Policy Template

Manage layer 3 ACL policy profile templates for creation and lifecycle operations.

Operations

AP Group

Manage AP groups and their configurations including creation, retrieval, update, and deletion.

Operations

Create AP Group

Request

Create a new AP group to organize and manage access points within a venue. The group can be configured with specific AP serial numbers and settings, and subsequently applied to Wi-Fi networks to control AP group configurations.

Path
venueIdstringrequired

The unique identifier of the venue where the AP group will be created.

Body
required
apSerialNumbersArray of strings

List of AP serial numbers which are associated with the AP group.

descriptionstring[ 2 .. 180 ] characters
namestring(?=^((?!(`|\$\()).){2,64}$)^(\S.*\S)$

The name of the AP group. Is required during creation and modification but not for the default AP group.

{
  "apSerialNumbers": [
    "string"
  ],
  "description": "string",
  "name": "string"
}

Responses

Accepted

Body
Response
No response example

Delete AP Group

Request

Remove an AP group by its unique identifier. This operation permanently deletes the group and its associated configurations. Ensure the group is not actively associated with any Wi-Fi networks before deletion.

Path
venueIdstringrequired

The unique identifier of the venue containing the AP group.

apGroupIdstringrequired

The unique identifier of the AP group to be removed.

No request payload

Responses

Accepted

Body
Response
No response example

Get AP Group

Request

Retrieve detailed information about a specific AP group by its unique identifier. The response includes all configuration settings, associated AP serial numbers, and policies associated with the group.

Path
venueIdstringrequired

The unique identifier of the venue containing the AP group.

apGroupIdstringrequired

The unique identifier of the AP group to be retrieved.

No request payload

Responses

OK

Body
apSerialNumbersArray of strings

List of AP serial numbers which are associated with the AP group.

descriptionstring[ 2 .. 180 ] characters
idstringread-only
isDefaultbooleanread-only

Indicates whether this is the default AP group for the associated venue.

Default false
namestring(?=^((?!(`|\$\()).){2,64}$)^(\S.*\S)$

The name of the AP group. Is required during creation and modification but not for the default AP group.

Response
{
  "apSerialNumbers": [
    "string"
  ],
  "description": "string",
  "id": "string",
  "isDefault": false,
  "name": "string"
}

Update AP Group

Request

Modify the configuration of an existing AP group by its unique identifier. This operation allows you to update AP associations, settings, and policies while maintaining the group identity and its associations with Wi-Fi networks.

Path
venueIdstringrequired

The unique identifier of the venue containing the AP group.

apGroupIdstringrequired

The unique identifier of the AP group to be modified.

Body
required
apSerialNumbersArray of strings

List of AP serial numbers which are associated with the AP group.

descriptionstring[ 2 .. 180 ] characters
namestring(?=^((?!(`|\$\()).){2,64}$)^(\S.*\S)$

The name of the AP group. Is required during creation and modification but not for the default AP group.

{
  "apSerialNumbers": [
    "string"
  ],
  "description": "string",
  "name": "string"
}

Responses

Accepted

Body
Response
No response example

Get Ap Group Client Admission Control Settings

Request

Get client admission control settings for this AP group.

Path
venueIdstringrequired

Venue ID

apGroupIdstringrequired

AP Group ID

No request payload

Responses

OK

Body
enable24Gboolean
Default false
enable50Gboolean
Default false
maxRadioLoad24Ginteger(int32)[ 50 .. 100 ]
Default 75
maxRadioLoad50Ginteger(int32)[ 50 .. 100 ]
Default 75
minClientCount24Ginteger(int32)[ 0 .. 100 ]
Default 10
minClientCount50Ginteger(int32)[ 0 .. 100 ]
Default 20
minClientThroughput24Ginteger(int32)[ 0 .. 100 ]
Default 0
minClientThroughput50Ginteger(int32)[ 0 .. 100 ]
Default 0
useVenueSettingsboolean
Default true
Response
{
  "enable24G": false,
  "enable50G": false,
  "maxRadioLoad24G": 75,
  "maxRadioLoad50G": 75,
  "minClientCount24G": 10,
  "minClientCount50G": 20,
  "minClientThroughput24G": 0,
  "minClientThroughput50G": 0,
  "useVenueSettings": true
}

Update Ap Group Client Admission Control Settings

Request

Update Ap group client admission control settings of this Ap group.

Path
venueIdstringrequired

Venue ID

apGroupIdstringrequired

AP Group ID

Body
required
enable24Gboolean
Default false
enable50Gboolean
Default false
maxRadioLoad24Ginteger(int32)[ 50 .. 100 ]
Default 75
maxRadioLoad50Ginteger(int32)[ 50 .. 100 ]
Default 75
minClientCount24Ginteger(int32)[ 0 .. 100 ]
Default 10
minClientCount50Ginteger(int32)[ 0 .. 100 ]
Default 20
minClientThroughput24Ginteger(int32)[ 0 .. 100 ]
Default 0
minClientThroughput50Ginteger(int32)[ 0 .. 100 ]
Default 0
useVenueSettingsboolean
Default true
{
  "enable24G": false,
  "enable50G": false,
  "maxRadioLoad24G": 75,
  "maxRadioLoad50G": 75,
  "minClientCount24G": 10,
  "minClientCount50G": 20,
  "minClientThroughput24G": 0,
  "minClientThroughput50G": 0,
  "useVenueSettings": true
}

Responses

Accepted

Body
Response
No response example

Deactivate AP Group On Wi-Fi Network

Request

Remove the association between an AP group and a Wi-Fi network. This operation disables the AP group's configurations on the specified network without deleting the group itself, allowing it to be reused with other networks.

Path
venueIdstringrequired

The unique identifier of the venue containing the Wi-Fi network.

wifiNetworkIdstringrequired

The unique identifier of the Wi-Fi network where the AP group will be disassociated.

apGroupIdstringrequired

The unique identifier of the AP group to be disassociated from the Wi-Fi network.

No request payload

Responses

Accepted

Body
Response
No response example

Activate AP Group On Wi-Fi Network

Request

Associate an AP group with a specific Wi-Fi network within a venue to enforce AP group configurations. This operation establishes the relationship between the AP group and network, enabling the group's settings to control AP behavior on the specified Wi-Fi network.

Path
venueIdstringrequired

The unique identifier of the venue containing the Wi-Fi network.

wifiNetworkIdstringrequired

The unique identifier of the Wi-Fi network where the AP group will be activated.

apGroupIdstringrequired

The unique identifier of the AP group to be associated with the Wi-Fi network.

No request payload

Responses

Accepted

Body
Response
No response example

Get AP Group Settings On Wi-Fi Network

Request

Retrieve the activated AP group settings configured for a specific Wi-Fi network. The response includes all network specific settings such as VLAN configurations and radio type assignments associated with the AP group on the network.

Path
venueIdstringrequired

The unique identifier of the venue containing the Wi-Fi network.

wifiNetworkIdstringrequired

The unique identifier of the Wi-Fi network where the AP group settings are configured.

apGroupIdstringrequired

The unique identifier of the AP group whose settings are to be retrieved.

No request payload

Responses

OK

Body
radioTypesArray of strings
Items Enum"2.4-GHz""5-GHz""6-GHz"
vlanIdinteger(int32)[ 1 .. 4094 ]
Response
{
  "radioTypes": [
    "2.4-GHz"
  ],
  "vlanId": 1
}

Update AP Group Settings On Wi-Fi Network

Request

Modify the activated AP group settings for a specific Wi-Fi network. This operation allows you to update network specific configurations such as VLAN assignments and radio type selections while maintaining the association between the AP group and network.

Path
venueIdstringrequired

The unique identifier of the venue containing the Wi-Fi network.

wifiNetworkIdstringrequired

The unique identifier of the Wi-Fi network where the AP group settings will be updated.

apGroupIdstringrequired

The unique identifier of the AP group whose settings are to be modified.

Body
required
radioTypesArray of strings
Items Enum"2.4-GHz""5-GHz""6-GHz"
vlanIdinteger(int32)[ 1 .. 4094 ]
{
  "radioTypes": [
    "2.4-GHz"
  ],
  "vlanId": 1
}

Responses

Accepted

Body
Response
No response example

Access Control Profile

Manage access control profiles.

Operations

Ethernet Port Profile

Manage ethernet port profiles for configuring LAN ports on APs.

Operations

AP

Manage APs including pinging, traceroute, resetting, rebooting, floor plan positioning and LAN ports settings.

Operations

SoftGRE Profile

Manage SoftGRE profiles that configure GRE tunnels, gateways, and keep alive monitoring for reliable traffic forwarding.

Operations

VLAN Pool Profile

Manage VLAN pool profiles.

Operations

Wi-Fi Calling Service Profile

Manage Wi-Fi calling service profiles.

Operations

AP Venue Template

Manage Wi-Fi venue template configuration, including radio settings, mesh, LEDs, LAN ports, and syslog.

Operations

DHCP Configuration Service Profile Template

Manage DHCP configuration service profile templates.

Operations

Rogue AP Detection Policy Template

Manage rogue AP detection policy templates.

Operations

Wi-Fi Calling Service Profile Template

Manage Wi-Fi calling service profile templates.

Operations

Wi-Fi Network

Managing the relationships for Wi-Fi network activation within venue associations.

Operations

Syslog Server Profile

Manage Syslog server profiles.

Operations

Application Policy

Manage application policy profiles.

Operations

Client

Manage client connections.

Operations

Layer 2 ACL Policy

Manage layer 2 ACL policy profiles covering creation, updates, and assignments.

Operations

DHCP Configuration Service Profile

Manage DHCP configuration service profiles.

Operations

MAC Registration Pool

Manage MAC registration pool profiles.

Operations

Client Isolation Profile

Manage client isolation profiles and their configurations including creation, retrieval, update, and deletion.

Operations

AP Venue

Manage Wi-Fi venue configuration, including radio settings, mesh, LEDs, LAN ports, and syslog.

Operations

VRIoT Management

Manage VRIoT with venue or AP.

Operations

Tunnel Service Profile

Manage tunnel service profiles.

Operations

Device Policy

Manage device policies.

Operations

MDNS Proxy Service Profile

Manage Multicast DNS proxy service profiles.

Operations

Tunnel Service Profile Template

Manage tunnel service profile templates.

Operations

DPSK Service Template

Manage DPSK service templates.

Operations

Certificate Template Activation

Manage certificate templates.

Operations

Rogue AP Detection Policy

Manage rogue AP detection policies and their configurations including creation, retrieval, update, and deletion.

Operations