Guest Service (1.7.1)

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

Overview

The Guest Service REST API provides comprehensive management capabilities for guest access in RUCKUS Cloud WiFi environments.

Key Features

Guest User Management: Create, retrieve, update, and delete guest users with configurable access credentials and expiration policies
Portal Service Profiles: Configure and manage captive portal settings, authentication methods, and user experience
Service Templates: Define reusable templates to streamline portal deployment across multiple networks

This API enables network administrators to efficiently provision temporary network access for guests while maintaining security and control over their wireless infrastructure.

Download OpenAPI description

Download PDF

Overview

License

RUCKUS Cloud Privacy Policy

Servers

RUCKUS One API host for Asian region.

https://api.asia.ruckus.cloud

RUCKUS One API host for European region.

https://api.eu.ruckus.cloud

RUCKUS One API host for North American region.

https://api.ruckus.cloud

Guest User

Manage guest users and their access credentials.

Operations

Portal Service Profile

Manage portal service profile.

Operations

Remove Portal Service ProfileDeprecated

Request

Remove portal service profile by ids. This method will be removed no sooner than 08/31/2026.

Bodyapplication/jsonrequiredArray [

string

]

application/json

[
  "string"
]

Responses

Accepted

Bodyapplication/json

requestIdstring

Unique identifier that can be used to trace the request status in the activity service.

responseany

The response payload from the operation.

Response

application/json

{
  "requestId": "string",
  "response": null
}

Get Portal Service ProfilesDeprecated

Request

Get portal service profile for the list. This method will be removed no sooner than 08/31/2026.

Query

serviceNamestring

Portal Service Profile Name

networkIdstring

NetworkId

tagsstring

Responses

Bodyapplication/json

contentArray of objects(PortalServiceProfileDto)

List of items in the current page.

pagingobject(Paging)

Pagination metadata including page number, size, and total count.

Response

application/json

{
  "content": [
    { … }
  ],
  "paging": {
    "page": 0,
    "pageSize": 0,
    "totalCount": 0
  }
}

Get Network FilterDeprecated

Request

Get network filter for portal service profile lists. This method will be removed no sooner than 08/31/2026.

No request payload

Responses

Bodyapplication/jsonArray [

idstring

namestring

tagsstring

Tags associated with this filter option for categorization or filtering purposes.

]

Response

application/json

[
  {
    "id": "string",
    "name": "string",
    "tags": "string"
  }
]

Get Tags FilterDeprecated

Request

Get tags filter for portal service profile lists. This method will be removed no sooner than 08/31/2026.

No request payload

Responses

Bodyapplication/jsonArray [

idstring

namestring

tagsstring

Tags associated with this filter option for categorization or filtering purposes.

]

Response

application/json

[
  {
    "id": "string",
    "name": "string",
    "tags": "string"
  }
]