Skip to content
/
Get Client Isolation Allo...

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

Get Wifi Calling ProfilesDeprecated

Request

Get data for a list of wifi calling service profiles.

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(WifiCallingServiceProfileDto)
errorMessagestring
subsequentQueriesArray of objects(SubsequentQuery)
Response
{
  "fields": [
    "string"
  ],
  "totalCount": 0,
  "page": 0,
  "objectId": "string",
  "data": [
    { … }
  ],
  "errorMessage": "string",
  "subsequentQueries": [
    { … }
  ]
}

Get VLAN Pool ProfilesDeprecated

Request

Get data for a list of VLAN pool policy profiles.

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(VlanPoolVenueDto)
errorMessagestring
subsequentQueriesArray of objects(SubsequentQuery)
Response
{
  "fields": [
    "string"
  ],
  "totalCount": 0,
  "page": 0,
  "objectId": "string",
  "data": [
    { … }
  ],
  "errorMessage": "string",
  "subsequentQueries": [
    { … }
  ]
}

Get Syslog Server ProfilesDeprecated

Request

Get data for a list of syslog server profiles.

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(SyslogServerProfileDto)
errorMessagestring
subsequentQueriesArray of objects(SubsequentQuery)
Response
{
  "fields": [
    "string"
  ],
  "totalCount": 0,
  "page": 0,
  "objectId": "string",
  "data": [
    { … }
  ],
  "errorMessage": "string",
  "subsequentQueries": [
    { … }
  ]
}

Get Rogue AP Policy ProfilesDeprecated

Request

Get data for a list of rogue AP policies.

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(RogueApPolicyProfileDto)
errorMessagestring
subsequentQueriesArray of objects(SubsequentQuery)
Response
{
  "fields": [
    "string"
  ],
  "totalCount": 0,
  "page": 0,
  "objectId": "string",
  "data": [
    { … }
  ],
  "errorMessage": "string",
  "subsequentQueries": [
    { … }
  ]
}

Get RADIUS Server ProfilesDeprecated

Request

Get data for a list of RADIUS server profiles.

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(RadiusServerProfileDto)
errorMessagestring
subsequentQueriesArray of objects(SubsequentQuery)
Response
{
  "fields": [
    "string"
  ],
  "totalCount": 0,
  "page": 0,
  "objectId": "string",
  "data": [
    { … }
  ],
  "errorMessage": "string",
  "subsequentQueries": [
    { … }
  ]
}

Get Multicast DNS Proxy ProfilesDeprecated

Request

Get data for a list of multicast DNS proxy service profiles.

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(MulticastDnsProxyServiceProfileDto)
errorMessagestring
subsequentQueriesArray of objects(SubsequentQuery)
Response
{
  "fields": [
    "string"
  ],
  "totalCount": 0,
  "page": 0,
  "objectId": "string",
  "data": [
    { … }
  ],
  "errorMessage": "string",
  "subsequentQueries": [
    { … }
  ]
}

Get Layer Three PoliciesDeprecated

Request

Get data for a list of layer 3 policies.

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(AccessControlSubProfileDto)
errorMessagestring
subsequentQueriesArray of objects(SubsequentQuery)
Response
{
  "fields": [
    "string"
  ],
  "totalCount": 0,
  "page": 0,
  "objectId": "string",
  "data": [
    { … }
  ],
  "errorMessage": "string",
  "subsequentQueries": [
    { … }
  ]
}

Get Layer Two PoliciesDeprecated

Request

Get data for a list of layer 2 policies.

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(AccessControlSubProfileDto)
errorMessagestring
subsequentQueriesArray of objects(SubsequentQuery)
Response
{
  "fields": [
    "string"
  ],
  "totalCount": 0,
  "page": 0,
  "objectId": "string",
  "data": [
    { … }
  ],
  "errorMessage": "string",
  "subsequentQueries": [
    { … }
  ]
}

Get Client Isolation AllowlistsDeprecated

Request

Get data for a list of client isolation allowlists.

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(IsolationAllowlistDto)
errorMessagestring
subsequentQueriesArray of objects(SubsequentQuery)
Response
{
  "fields": [
    "string"
  ],
  "totalCount": 0,
  "page": 0,
  "objectId": "string",
  "data": [
    { … }
  ],
  "errorMessage": "string",
  "subsequentQueries": [
    { … }
  ]
}

Get DHCP Configuration Service ProfilesDeprecated

Request

Get data for a list of DHCP configuration service profiles.

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(DhcpConfigServiceProfileDto)
errorMessagestring
subsequentQueriesArray of objects(SubsequentQuery)
Response
{
  "fields": [
    "string"
  ],
  "totalCount": 0,
  "page": 0,
  "objectId": "string",
  "data": [
    { … }
  ],
  "errorMessage": "string",
  "subsequentQueries": [
    { … }
  ]
}

Get Device PoliciesDeprecated

Request

Get data for a list of device policies.

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(AccessControlSubProfileDto)
errorMessagestring
subsequentQueriesArray of objects(SubsequentQuery)
Response
{
  "fields": [
    "string"
  ],
  "totalCount": 0,
  "page": 0,
  "objectId": "string",
  "data": [
    { … }
  ],
  "errorMessage": "string",
  "subsequentQueries": [
    { … }
  ]
}

Get Application PoliciesDeprecated

Request

Get data for a list of application policies.

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(AccessControlSubProfileDto)
errorMessagestring
subsequentQueriesArray of objects(SubsequentQuery)
Response
{
  "fields": [
    "string"
  ],
  "totalCount": 0,
  "page": 0,
  "objectId": "string",
  "data": [
    { … }
  ],
  "errorMessage": "string",
  "subsequentQueries": [
    { … }
  ]
}

Get Access Control ProfilesDeprecated

Request

Get data for a list of access control profiles.

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(AccessControlPolicyProfileDto)
errorMessagestring
subsequentQueriesArray of objects(SubsequentQuery)
Response
{
  "fields": [
    "string"
  ],
  "totalCount": 0,
  "page": 0,
  "objectId": "string",
  "data": [
    { … }
  ],
  "errorMessage": "string",
  "subsequentQueries": [
    { … }
  ]
}

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

AP SNMP Agents

Operations