Skip to content
/Portal Service Profile

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
Languages
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

Add Portal Service Profile

Request

Provision one portal service profile as defined in the payload.

Body
required
contentobject(PortalServiceProfileContentDto)

Content configuration for the portal profile.

idstring

Unique identifier for the portal service profile.

serviceNamestring

Name of the portal service.

tagsstring

Tags associated with the portal service profile for categorization.

{
  "content": {
    "bgColor": "string",
    "bgImage": "string",
    "bgImageChecksum": "string",
    "buttonColor": "string",
    "componentDisplay": { … },
    "displayLangCode": "string",
    "logo": "string",
    "logoChecksum": "string",
    "logoRatio": 0,
    "photo": "string",
    "photoChecksum": "string",
    "photoRatio": 0,
    "poweredBgColor": "string",
    "poweredColor": "string",
    "poweredImg": "string",
    "poweredImgChecksum": "string",
    "poweredImgRatio": 0,
    "poweredSize": 0,
    "secondaryColor": "string",
    "secondarySize": 0,
    "secondaryText": "string",
    "termsCondition": "string",
    "welcomeColor": "string",
    "welcomeSize": 0,
    "welcomeText": "string",
    "wifi4EUNetworkId": "string"
  },
  "id": "string",
  "serviceName": "string",
  "tags": "string"
}

Responses

Created

Body
requestIdstring

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

responseobject(EntityId)

The unique identifier for the entity that will be created.

Response
{
  "requestId": "string",
  "response": {
    "id": "string"
  }
}

Remove Portal Service Profile

Request

Remove portal service profile by id.

Path
portalServiceProfileIdstringrequired
No request payload

Responses

Accepted

Body
requestIdstring

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

Response
{
  "requestId": "string"
}

Retrieve Portal Service Profile

Request

Retrieve a portal service profile.

Path
portalServiceProfileIdstringrequired
No request payload

Responses

OK

Body
contentobject(PortalServiceProfileContentDto)

Content configuration for the portal profile.

namestring

Name of the portal service.

Response
{
  "content": {
    "bgColor": "string",
    "bgImage": "string",
    "bgImageChecksum": "string",
    "buttonColor": "string",
    "componentDisplay": { … },
    "displayLangCode": "string",
    "logo": "string",
    "logoChecksum": "string",
    "logoRatio": 0,
    "photo": "string",
    "photoChecksum": "string",
    "photoRatio": 0,
    "poweredBgColor": "string",
    "poweredColor": "string",
    "poweredImg": "string",
    "poweredImgChecksum": "string",
    "poweredImgRatio": 0,
    "poweredSize": 0,
    "secondaryColor": "string",
    "secondarySize": 0,
    "secondaryText": "string",
    "termsCondition": "string",
    "welcomeColor": "string",
    "welcomeSize": 0,
    "welcomeText": "string",
    "wifi4EUNetworkId": "string"
  },
  "name": "string"
}

Update Portal Service Profile

Request

Update portal service profile by id.

Path
portalServiceProfileIdstringrequired
Body
required
contentobject(PortalServiceProfileContentDto)

Content configuration for the portal profile.

idstring

Unique identifier for the portal service profile.

serviceNamestring

Name of the portal service.

tagsstring

Tags associated with the portal service profile for categorization.

{
  "content": {
    "bgColor": "string",
    "bgImage": "string",
    "bgImageChecksum": "string",
    "buttonColor": "string",
    "componentDisplay": { … },
    "displayLangCode": "string",
    "logo": "string",
    "logoChecksum": "string",
    "logoRatio": 0,
    "photo": "string",
    "photoChecksum": "string",
    "photoRatio": 0,
    "poweredBgColor": "string",
    "poweredColor": "string",
    "poweredImg": "string",
    "poweredImgChecksum": "string",
    "poweredImgRatio": 0,
    "poweredSize": 0,
    "secondaryColor": "string",
    "secondarySize": 0,
    "secondaryText": "string",
    "termsCondition": "string",
    "welcomeColor": "string",
    "welcomeSize": 0,
    "welcomeText": "string",
    "wifi4EUNetworkId": "string"
  },
  "id": "string",
  "serviceName": "string",
  "tags": "string"
}

Responses

Accepted

Body
requestIdstring

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

Response
{
  "requestId": "string"
}

Update Portal Profile Background Image

Request

Update portal service profile background image by id.

Path
portalServiceProfileIdstringrequired
Body
required
imagestring[ 0 .. 6990507 ] characters

A base 64 encoded string. Note that all images are saved as portable network graphics files.

Example: "iVBORw0KGgoAAAANSUhEUgAAAAUAAAADCAIAAADUVFKvAAAAFklEQVR4AWP4TwABAAAAAcADfzEPFwAAAABJRU5ErkJggg=="
{
  "image": "iVBORw0KGgoAAAANSUhEUgAAAAUAAAADCAIAAADUVFKvAAAAFklEQVR4AWP4TwABAAAAAcADfzEPFwAAAABJRU5ErkJggg=="
}

Responses

OK

Body
requestIdstring

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

Response
{
  "requestId": "string"
}

Update Portal Service Profile Photo

Request

Update portal service profile photo by id.

Path
portalServiceProfileIdstringrequired
Body
required
imagestring[ 0 .. 6990507 ] characters

A base 64 encoded string. Note that all images are saved as portable network graphics files.

Example: "iVBORw0KGgoAAAANSUhEUgAAAAUAAAADCAIAAADUVFKvAAAAFklEQVR4AWP4TwABAAAAAcADfzEPFwAAAABJRU5ErkJggg=="
{
  "image": "iVBORw0KGgoAAAANSUhEUgAAAAUAAAADCAIAAADUVFKvAAAAFklEQVR4AWP4TwABAAAAAcADfzEPFwAAAABJRU5ErkJggg=="
}

Responses

OK

Body
requestIdstring

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

Response
{
  "requestId": "string"
}

Update Portal Profile Powered Image

Request

Update portal service profile powered image by id.

Path
portalServiceProfileIdstringrequired
Body
required
imagestring[ 0 .. 6990507 ] characters

A base 64 encoded string. Note that all images are saved as portable network graphics files.

Example: "iVBORw0KGgoAAAANSUhEUgAAAAUAAAADCAIAAADUVFKvAAAAFklEQVR4AWP4TwABAAAAAcADfzEPFwAAAABJRU5ErkJggg=="
{
  "image": "iVBORw0KGgoAAAANSUhEUgAAAAUAAAADCAIAAADUVFKvAAAAFklEQVR4AWP4TwABAAAAAcADfzEPFwAAAABJRU5ErkJggg=="
}

Responses

OK

Body
requestIdstring

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

Response
{
  "requestId": "string"
}

Portal Service Template

Manage portal service profile template. Use /rec/templates for REC templates.

Operations