Skip to content
/
Remove Portal Service Pro...

Guest API and Model Documentation (1.7.1)

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 ProfilesDeprecated

Request

Get portal service profile for the list.

Query
serviceNamestring

Portal Service Profile Name

networkIdstring

NetworkId

tagsstring

Tags

pageinteger(int32)

Indicates the page to return, will be 1 based, and default to page 1

Default 1
pageSizeinteger(int32)

Default is 256, indicates the page size to return

Default 256
excludeContentboolean

Get the total count information from the query and NOT pull the data

Default false
No request payload

Responses

OK

Bodyapplication/json
contentArray of objects(PortalServiceProfileDto)
pagingobject(Paging)
Response
application/json
{
  "content": [
    { … }
  ],
  "paging": {
    "page": 0,
    "pageSize": 0,
    "totalCount": 0
  }
}

Remove Portal Service ProfileDeprecated

Request

Remove portal service profile by ids.

Bodyapplication/jsonrequiredArray [
string
]
application/json
[
  "string"
]

Responses

Accepted

Bodyapplication/json
requestIdstring
responseobject
Response
application/json
{
  "requestId": "string",
  "response": {}
}

Get Tags Filter of Portal Service ProfilesDeprecated

Request

Get tags filter for portal service profile lists.

No request payload

Responses

OK

Bodyapplication/jsonArray [
idstring
namestring
tagsstring
]
Response
application/json
[
  {
    "id": "string",
    "name": "string",
    "tags": "string"
  }
]

Get Network Filter of Portal Service ProfilesDeprecated

Request

Get network filter for portal service profile lists.

No request payload

Responses

OK

Bodyapplication/jsonArray [
idstring
namestring
tagsstring
]
Response
application/json
[
  {
    "id": "string",
    "name": "string",
    "tags": "string"
  }
]

Guest User

Manage guest users.

Operations