Skip to content
/
Get Cloudpath Servers

ViewModel Service API & Model Documentation (1.0.41)

Ruckus Network Technical Documents
Download OpenAPI description
Download PDF
Overview
License

TBD

Terms of Service

Languages
Servers
Generated server url

http://localhost/

View Switch

View Switch information. Note: this set of endpoints is used to view operational data. They don't provide the means to manage configuration.

Operations

View Venue

View venue information. Note: this group of endpoints is used to view operational data. They don't provide the means to manage configuration.

Operations

View Wi-Fi Profile

View Wi-Fi Service & Policy information

Operations

View Platform

View platform information. Note: this group of endpoints is used to view operational data. They don't provide the means to manage configuration.

Operations

View Wi-Fi

View Wi-Fi information. Note: this group of endpoints is used to view operational data. They don't provide the means to manage configuration.

Operations

Export Guest CSVDeprecated

Request

Export guest to CSV.

Body
required
guestIdsArray of stringsunique
timezonestring
dateFormatstring
{
  "guestIds": [
    "string"
  ],
  "timezone": "string",
  "dateFormat": "string"
}

Responses

Successful operation

Bodytext/csv

Get Cloudpath ServersDeprecated

Request

Get a list of Cloudpath server information.

Body
required
multiSortFieldsArray of strings
matchFieldsArray of objects(MatchFieldDto)
rangeFilterobject(RangeFilterDto)
rangeDateFilterobject(RangeFilterDto)
mustNotMatchFieldArray of objects(MustNotMatchFieldDto)
sortFieldstring
sortOrderstring
pageinteger(int32)
pageByDateobject
pageSizeinteger(int32)
fieldsArray of stringsunique
searchTargetFieldsArray of strings
searchStringstring
filtersobject
mustHaveFieldsArray of strings
mustNotHaveFieldsArray of strings
termFieldobject(TermFieldDto)
termsobject
existsstring
groupBystring
{
  "multiSortFields": [
    "string"
  ],
  "matchFields": [
    { … }
  ],
  "rangeFilter": {
    "field": "string",
    "gte": 0,
    "lte": 0,
    "lt": 0
  },
  "rangeDateFilter": {
    "field": "string",
    "gte": 0,
    "lte": 0,
    "lt": 0
  },
  "mustNotMatchField": [
    { … }
  ],
  "sortField": "string",
  "sortOrder": "string",
  "page": 0,
  "pageByDate": {
    "value": "string",
    "key": "string"
  },
  "pageSize": 0,
  "fields": [
    "string"
  ],
  "searchTargetFields": [
    "string"
  ],
  "searchString": "string",
  "filters": {
    "property1": [ … ],
    "property2": [ … ]
  },
  "mustHaveFields": [
    "string"
  ],
  "mustNotHaveFields": [
    "string"
  ],
  "termField": {
    "field": "string",
    "value": "string"
  },
  "terms": {
    "property1": [ … ],
    "property2": [ … ]
  },
  "exists": "string",
  "groupBy": "string"
}

Responses

successful operation

Body
fieldsArray of stringsunique
totalCountinteger(int64)
pageinteger(int32)
objectIdstring
dataArray of objects(CloudpathServerDto)
errorMessagestring
subsequentQueriesArray of objects(SubsequentQuery)
Response
{
  "fields": [
    "string"
  ],
  "totalCount": 0,
  "page": 0,
  "objectId": "string",
  "data": [
    { … }
  ],
  "errorMessage": "string",
  "subsequentQueries": [
    { … }
  ]
}

Get APsDeprecated

Request

Get parameters and operational data for a list of APs or mesh APs.

Query
meshboolean

Get mesh aps

Default false
Body
required
multiSortFieldsArray of strings
matchFieldsArray of objects(MatchFieldDto)
rangeFilterobject(RangeFilterDto)
rangeDateFilterobject(RangeFilterDto)
mustNotMatchFieldArray of objects(MustNotMatchFieldDto)
sortFieldstring
sortOrderstring
pageinteger(int32)
pageByDateobject
pageSizeinteger(int32)
fieldsArray of stringsunique
searchTargetFieldsArray of strings
searchStringstring
filtersobject
mustHaveFieldsArray of strings
mustNotHaveFieldsArray of strings
termFieldobject(TermFieldDto)
termsobject
existsstring
groupBystring
{
  "multiSortFields": [
    "string"
  ],
  "matchFields": [
    { … }
  ],
  "rangeFilter": {
    "field": "string",
    "gte": 0,
    "lte": 0,
    "lt": 0
  },
  "rangeDateFilter": {
    "field": "string",
    "gte": 0,
    "lte": 0,
    "lt": 0
  },
  "mustNotMatchField": [
    { … }
  ],
  "sortField": "string",
  "sortOrder": "string",
  "page": 0,
  "pageByDate": {
    "value": "string",
    "key": "string"
  },
  "pageSize": 0,
  "fields": [
    "string"
  ],
  "searchTargetFields": [
    "string"
  ],
  "searchString": "string",
  "filters": {
    "property1": [ … ],
    "property2": [ … ]
  },
  "mustHaveFields": [
    "string"
  ],
  "mustNotHaveFields": [
    "string"
  ],
  "termField": {
    "field": "string",
    "value": "string"
  },
  "terms": {
    "property1": [ … ],
    "property2": [ … ]
  },
  "exists": "string",
  "groupBy": "string"
}

Responses

successful operation

Body
fieldsArray of stringsunique
totalCountinteger(int64)
pageinteger(int32)
objectIdstring
dataArray of objects(DeviceDto)
errorMessagestring
subsequentQueriesArray of objects(SubsequentQuery)
Response
{
  "fields": [
    "string"
  ],
  "totalCount": 0,
  "page": 0,
  "objectId": "string",
  "data": [
    { … }
  ],
  "errorMessage": "string",
  "subsequentQueries": [
    { … }
  ]
}

Export AP InventoryDeprecated

Request

Export the list of APs belong to the tenant.

Bodyapplication/jsonrequired
multiSortFieldsArray of strings
matchFieldsArray of objects(MatchFieldDto)
rangeFilterobject(RangeFilterDto)
rangeDateFilterobject(RangeFilterDto)
mustNotMatchFieldArray of objects(MustNotMatchFieldDto)
sortFieldstring
sortOrderstring
pageinteger(int32)
pageByDateobject
pageSizeinteger(int32)
fieldsArray of stringsunique
searchTargetFieldsArray of strings
searchStringstring
filtersobject
mustHaveFieldsArray of strings
mustNotHaveFieldsArray of strings
termFieldobject(TermFieldDto)
termsobject
existsstring
groupBystring
application/json
{
  "multiSortFields": [
    "string"
  ],
  "matchFields": [
    { … }
  ],
  "rangeFilter": {
    "field": "string",
    "gte": 0,
    "lte": 0,
    "lt": 0
  },
  "rangeDateFilter": {
    "field": "string",
    "gte": 0,
    "lte": 0,
    "lt": 0
  },
  "mustNotMatchField": [
    { … }
  ],
  "sortField": "string",
  "sortOrder": "string",
  "page": 0,
  "pageByDate": {
    "value": "string",
    "key": "string"
  },
  "pageSize": 0,
  "fields": [
    "string"
  ],
  "searchTargetFields": [
    "string"
  ],
  "searchString": "string",
  "filters": {
    "property1": [ … ],
    "property2": [ … ]
  },
  "mustHaveFields": [
    "string"
  ],
  "mustNotHaveFields": [
    "string"
  ],
  "termField": {
    "field": "string",
    "value": "string"
  },
  "terms": {
    "property1": [ … ],
    "property2": [ … ]
  },
  "exists": "string",
  "groupBy": "string"
}

Responses

successful operation

Bodyapplication/json
object(StreamingResponseBody)
Response
application/json
{}

Get APs Aggregation DetailsDeprecated

Request

Get parameters and operational data for a list of APs with aggregation details.

Bodyapplication/jsonrequired
multiSortFieldsArray of strings
matchFieldsArray of objects(MatchFieldDto)
rangeFilterobject(RangeFilterDto)
rangeDateFilterobject(RangeFilterDto)
mustNotMatchFieldArray of objects(MustNotMatchFieldDto)
sortFieldstring
sortOrderstring
pageinteger(int32)
pageByDateobject
pageSizeinteger(int32)
fieldsArray of stringsunique
searchTargetFieldsArray of strings
searchStringstring
filtersobject
mustHaveFieldsArray of strings
mustNotHaveFieldsArray of strings
termFieldobject(TermFieldDto)
termsobject
existsstring
groupBystring
application/json
{
  "multiSortFields": [
    "string"
  ],
  "matchFields": [
    { … }
  ],
  "rangeFilter": {
    "field": "string",
    "gte": 0,
    "lte": 0,
    "lt": 0
  },
  "rangeDateFilter": {
    "field": "string",
    "gte": 0,
    "lte": 0,
    "lt": 0
  },
  "mustNotMatchField": [
    { … }
  ],
  "sortField": "string",
  "sortOrder": "string",
  "page": 0,
  "pageByDate": {
    "value": "string",
    "key": "string"
  },
  "pageSize": 0,
  "fields": [
    "string"
  ],
  "searchTargetFields": [
    "string"
  ],
  "searchString": "string",
  "filters": {
    "property1": [ … ],
    "property2": [ … ]
  },
  "mustHaveFields": [
    "string"
  ],
  "mustNotHaveFields": [
    "string"
  ],
  "termField": {
    "field": "string",
    "value": "string"
  },
  "terms": {
    "property1": [ … ],
    "property2": [ … ]
  },
  "exists": "string",
  "groupBy": "string"
}

Responses

successful operation

Bodyapplication/json
fieldsArray of stringsunique
totalCountinteger(int64)
pageinteger(int32)
objectIdstring
dataArray of objects(GroupedApDto)
errorMessagestring
subsequentQueriesArray of objects(SubsequentQuery)
Response
application/json
{
  "fields": [
    "string"
  ],
  "totalCount": 0,
  "page": 0,
  "objectId": "string",
  "data": [
    { … }
  ],
  "errorMessage": "string",
  "subsequentQueries": [
    { … }
  ]
}

Get AP ClientsDeprecated

Request

Get client (i.e., end-user devices) parameters and operational data.

Query
apSerialNumberstring
pageinteger(int32)
sizeinteger(int32)
No request payload

Responses

OK

Body
Array [
txBytesinteger(int64)read-only
macstring
apMacstring
apNamestringread-only
osTypestring
venueIdstring
venueNamestringread-only
connectedSincestring
apSerialNumberstring
networkIdstring
ipstring
usernamestring
hostnamestring
ssidstring
vlaninteger(int32)
vniinteger(int32)
bandstring
bssidstringread-only
rxBytesinteger(int64)read-only
rxPacketsinteger(int64)read-only
txPacketsinteger(int64)read-only
snr_dBinteger(int32)read-only
receiveSignalStrength_dBminteger(int32)read-only
noiseFloor_dBminteger(int32)read-only
radioChannelinteger(int32)read-only
txDropDataPacketinteger(int32)read-only
switchNamestringread-only
switchMacstring
switchSerialNumberstring
healthCheckStatusstring
]
Response
[
  {
    "txBytes": 0,
    "mac": "string",
    "apMac": "string",
    "apName": "string",
    "osType": "string",
    "venueId": "string",
    "venueName": "string",
    "connectedSince": "string",
    "apSerialNumber": "string",
    "networkId": "string",
    "ip": "string",
    "username": "string",
    "hostname": "string",
    "ssid": "string",
    "vlan": 0,
    "vni": 0,
    "band": "string",
    "bssid": "string",
    "rxBytes": 0,
    "rxPackets": 0,
    "txPackets": 0,
    "snr_dB": 0,
    "receiveSignalStrength_dBm": 0,
    "noiseFloor_dBm": 0,
    "radioChannel": 0,
    "txDropDataPacket": 0,
    "switchName": "string",
    "switchMac": "string",
    "switchSerialNumber": "string",
    "healthCheckStatus": "string"
  }
]

Get Client by MACDeprecated

Request

Get extended set of parameters and operational data for the client having this MAC address.

Path
macstringrequired
No request payload

Responses

OK

Body
txBytesinteger(int64)
macstring
apMacstring
apNamestring
osTypestring
venueIdstring
venueNamestring
connectedSincestring
apSerialNumberstring
networkIdstring
ipstring
usernamestring
hostnamestring
ssidstring
vlaninteger(int32)
vniinteger(int32)
bandstring
bssidstring
rxBytesinteger(int64)
rxPacketsinteger(int64)
txPacketsinteger(int64)
snr_dBinteger(int32)
receiveSignalStrength_dBminteger(int32)
noiseFloor_dBminteger(int32)
radioChannelinteger(int32)
txDropDataPacketinteger(int32)
switchNamestring
switchMacstring
switchSerialNumberstring
healthCheckStatusstring
Response
{
  "txBytes": 0,
  "mac": "string",
  "apMac": "string",
  "apName": "string",
  "osType": "string",
  "venueId": "string",
  "venueName": "string",
  "connectedSince": "string",
  "apSerialNumber": "string",
  "networkId": "string",
  "ip": "string",
  "username": "string",
  "hostname": "string",
  "ssid": "string",
  "vlan": 0,
  "vni": 0,
  "band": "string",
  "bssid": "string",
  "rxBytes": 0,
  "rxPackets": 0,
  "txPackets": 0,
  "snr_dB": 0,
  "receiveSignalStrength_dBm": 0,
  "noiseFloor_dBm": 0,
  "radioChannel": 0,
  "txDropDataPacket": 0,
  "switchName": "string",
  "switchMac": "string",
  "switchSerialNumber": "string",
  "healthCheckStatus": "string"
}

AP SNMP Agents

Operations