Skip to content
/
Update Portal Service Pro...

Guest API and Model Documentation (1.7.0)

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

Overview

Rate Limit

For the ApOps 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/

Portal Service Profile

Manage Portal Service Profile.

Operations

Get Portal Service Profile

Request

Get a portal service profile.

Path
portalServiceProfileIdstringrequired
No request payload

Responses

OK

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

Update Portal Service Profile

Request

Update portal service profile by id.

Path
portalServiceProfileIdstringrequired
Body
required
namestring
contentobject(PortalServiceProfileContentDto)
{
  "name": "string",
  "content": {
    "welcomeText": "string",
    "welcomeColor": "string",
    "bgImage": "string",
    "bgImageChecksum": "string",
    "bgColor": "string",
    "welcomeSize": 0,
    "photo": "string",
    "photoChecksum": "string",
    "photoRatio": 0,
    "logo": "string",
    "logoChecksum": "string",
    "logoRatio": 0,
    "secondaryText": "string",
    "secondaryColor": "string",
    "secondarySize": 0,
    "buttonColor": "string",
    "poweredBgColor": "string",
    "poweredColor": "string",
    "poweredSize": 0,
    "poweredImg": "string",
    "poweredImgChecksum": "string",
    "poweredImgRatio": 0,
    "wifi4EUNetworkId": "string",
    "termsCondition": "string",
    "componentDisplay": { … },
    "displayLangCode": "string"
  }
}

Responses

Accepted

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

Delete Portal Service Profile

Request

Delete portal service profile by id.

Path
portalServiceProfileIdstringrequired
No request payload

Responses

Accepted

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

Update Portal Service 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
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
Response
{
  "requestId": "string"
}

Update Portal Service 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
Response
{
  "requestId": "string"
}

Add Portal Service Profile

Request

Provision one portal service profile as defined in the payload.

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

Responses

Created

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

Guest User

Manage guest users.

Operations