Skip to content
View Model Resources/
/
Get Rogue AP Policy Profi...

View Model Resources (1.0.44)

Ruckus Network Technical Documents
Download OpenAPI description
Download PDF
Overview
License
RUCKUS Cloud Privacy Policy
Terms of Service
Languages
Servers
RUCKUS One API host for North American region.
https://api.ruckus.cloud
RUCKUS One API host for European region.
https://api.eu.ruckus.cloud
RUCKUS One API host for Asian region.
https://api.asia.ruckus.cloud

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 Wi-Fi Profile

View Wi-Fi service and policy profile information including RADIUS authentication.

Operations

Get Access Control ProfilesDeprecated

Request

Get data for a list of access control profiles. This method will be removed no sooner than 08/31/2026. The following /accessControlProfiles/query can be used for this content.

Body
required
excludeFiltersobject

Exclusion filters as key value pairs defining values to omit from results.

existsstring

Field name that must exist within each document matched by the query execution.

fieldsArray of stringsunique

Set of field names to include in response payload for each record.

filtersobject

Filters provided as key value pairs defining inclusion criteria for query execution.

groupBystring

Field name used to group aggregated results when producing grouped query responses.

matchFieldsArray of objects(MatchFieldDto)

List of match field filters specifying terms that must align with query criteria.

multiSortFieldsArray of strings

List of multiple field names applied for compound sorting logic in results.

mustHaveFieldsArray of strings

List of fields that must exist on documents returned by the query.

mustNotHaveFieldsArray of strings

List of fields that must not exist on documents included in results.

mustNotMatchFieldArray of objects(MustNotMatchFieldDto)
pageinteger(int32)

Page number indicating current position within paginated query results.

pageByDateobject

Pagination by date entry specifying anchor timestamp for search after pagination.

pageSizeinteger(int32)

Number of items per page controlling volume of results returned per page.

queryStringOrFilterobject(QueryStringOrMacFilterDto)

Query string or MAC filter configuration combining text search and device matching.

rangeDateFilterobject(RangeFilterDto)

Range date filter configuration defining temporal boundaries for returned records.

rangeFilterobject(RangeFilterDto)

Range filter configuration defining numeric or date boundaries for query results.

searchStringstring

Search string representing the user query applied across designated target fields.

searchTargetFieldsArray of strings

List of target field names that should be queried for search string matching.

search_afterArray of strings

Search after values used to continue pagination without relying on offsets.

sortDescriptorsArray of objects(SortDescriptor)

List of sort descriptors defining multi level sort behaviors for query responses.

sortFieldstring

Field name used to sort query results within the returned data.

sortOrderstring

Sort order specifying ascending or descending direction for query results.

termFieldobject(TermFieldDto)

Term field filter configuration specifying exact match criteria for a field.

termsobject

Filter terms represented as key value pairs applied to refine result sets.

{
  "excludeFilters": {
    "property1": [ … ],
    "property2": [ … ]
  },
  "exists": "string",
  "fields": [
    "string"
  ],
  "filters": {
    "property1": [ … ],
    "property2": [ … ]
  },
  "groupBy": "string",
  "matchFields": [
    { … }
  ],
  "multiSortFields": [
    "string"
  ],
  "mustHaveFields": [
    "string"
  ],
  "mustNotHaveFields": [
    "string"
  ],
  "mustNotMatchField": [
    { … }
  ],
  "page": 0,
  "pageByDate": {
    "key": "string",
    "value": "string"
  },
  "pageSize": 0,
  "queryStringOrFilter": {
    "filterTerms": { … },
    "searchString": "string"
  },
  "rangeDateFilter": {
    "field": "string",
    "gte": 0,
    "lt": 0,
    "lte": 0
  },
  "rangeFilter": {
    "field": "string",
    "gte": 0,
    "lt": 0,
    "lte": 0
  },
  "searchString": "string",
  "searchTargetFields": [
    "string"
  ],
  "search_after": [
    "string"
  ],
  "sortDescriptors": [
    null
  ],
  "sortField": "string",
  "sortOrder": "string",
  "termField": {
    "field": "string",
    "value": "string"
  },
  "terms": {
    "property1": [ … ],
    "property2": [ … ]
  }
}

Responses

successful operation

Body
dataArray of objects(AccessControlPolicyProfileDto)

List of data items returned by the query.

errorMessagestring

Error message if the request failed.

errorsArray of objects(Error)

List of detailed errors if the request encountered issues.

fieldsArray of stringsunique

Set of field names included in the response.

objectIdstring

Unique identifier of the object being queried.

pageinteger(int32)

Current page number in the paginated results.

requestIdstring

Unique identifier for tracking this request.

subsequentQueriesArray of objects(SubsequentQuery)

List of subsequent query options for drilling down into results.

totalCountinteger(int64)

Total number of results matching the query.

Response
{
  "data": [
    { … }
  ],
  "errorMessage": "string",
  "errors": [
    { … }
  ],
  "fields": [
    "string"
  ],
  "objectId": "string",
  "page": 0,
  "requestId": "string",
  "subsequentQueries": [
    { … }
  ],
  "totalCount": 0
}

Get Application PoliciesDeprecated

Request

Get data for a list of application policies. This method will be removed no sooner than 08/31/2026. The following /applicationPolicies/query can be used for this content.

Body
required
excludeFiltersobject

Exclusion filters as key value pairs defining values to omit from results.

existsstring

Field name that must exist within each document matched by the query execution.

fieldsArray of stringsunique

Set of field names to include in response payload for each record.

filtersobject

Filters provided as key value pairs defining inclusion criteria for query execution.

groupBystring

Field name used to group aggregated results when producing grouped query responses.

matchFieldsArray of objects(MatchFieldDto)

List of match field filters specifying terms that must align with query criteria.

multiSortFieldsArray of strings

List of multiple field names applied for compound sorting logic in results.

mustHaveFieldsArray of strings

List of fields that must exist on documents returned by the query.

mustNotHaveFieldsArray of strings

List of fields that must not exist on documents included in results.

mustNotMatchFieldArray of objects(MustNotMatchFieldDto)
pageinteger(int32)

Page number indicating current position within paginated query results.

pageByDateobject

Pagination by date entry specifying anchor timestamp for search after pagination.

pageSizeinteger(int32)

Number of items per page controlling volume of results returned per page.

queryStringOrFilterobject(QueryStringOrMacFilterDto)

Query string or MAC filter configuration combining text search and device matching.

rangeDateFilterobject(RangeFilterDto)

Range date filter configuration defining temporal boundaries for returned records.

rangeFilterobject(RangeFilterDto)

Range filter configuration defining numeric or date boundaries for query results.

searchStringstring

Search string representing the user query applied across designated target fields.

searchTargetFieldsArray of strings

List of target field names that should be queried for search string matching.

search_afterArray of strings

Search after values used to continue pagination without relying on offsets.

sortDescriptorsArray of objects(SortDescriptor)

List of sort descriptors defining multi level sort behaviors for query responses.

sortFieldstring

Field name used to sort query results within the returned data.

sortOrderstring

Sort order specifying ascending or descending direction for query results.

termFieldobject(TermFieldDto)

Term field filter configuration specifying exact match criteria for a field.

termsobject

Filter terms represented as key value pairs applied to refine result sets.

{
  "excludeFilters": {
    "property1": [ … ],
    "property2": [ … ]
  },
  "exists": "string",
  "fields": [
    "string"
  ],
  "filters": {
    "property1": [ … ],
    "property2": [ … ]
  },
  "groupBy": "string",
  "matchFields": [
    { … }
  ],
  "multiSortFields": [
    "string"
  ],
  "mustHaveFields": [
    "string"
  ],
  "mustNotHaveFields": [
    "string"
  ],
  "mustNotMatchField": [
    { … }
  ],
  "page": 0,
  "pageByDate": {
    "key": "string",
    "value": "string"
  },
  "pageSize": 0,
  "queryStringOrFilter": {
    "filterTerms": { … },
    "searchString": "string"
  },
  "rangeDateFilter": {
    "field": "string",
    "gte": 0,
    "lt": 0,
    "lte": 0
  },
  "rangeFilter": {
    "field": "string",
    "gte": 0,
    "lt": 0,
    "lte": 0
  },
  "searchString": "string",
  "searchTargetFields": [
    "string"
  ],
  "search_after": [
    "string"
  ],
  "sortDescriptors": [
    null
  ],
  "sortField": "string",
  "sortOrder": "string",
  "termField": {
    "field": "string",
    "value": "string"
  },
  "terms": {
    "property1": [ … ],
    "property2": [ … ]
  }
}

Responses

successful operation

Body
dataArray of objects(AccessControlSubProfileDto)

List of data items returned by the query.

errorMessagestring

Error message if the request failed.

errorsArray of objects(Error)

List of detailed errors if the request encountered issues.

fieldsArray of stringsunique

Set of field names included in the response.

objectIdstring

Unique identifier of the object being queried.

pageinteger(int32)

Current page number in the paginated results.

requestIdstring

Unique identifier for tracking this request.

subsequentQueriesArray of objects(SubsequentQuery)

List of subsequent query options for drilling down into results.

totalCountinteger(int64)

Total number of results matching the query.

Response
{
  "data": [
    { … }
  ],
  "errorMessage": "string",
  "errors": [
    { … }
  ],
  "fields": [
    "string"
  ],
  "objectId": "string",
  "page": 0,
  "requestId": "string",
  "subsequentQueries": [
    { … }
  ],
  "totalCount": 0
}

Get Device PoliciesDeprecated

Request

Get data for a list of device policies. This method will be removed no sooner than 08/31/2026. The following /devicePolicies/query can be used for this content.

Body
required
excludeFiltersobject

Exclusion filters as key value pairs defining values to omit from results.

existsstring

Field name that must exist within each document matched by the query execution.

fieldsArray of stringsunique

Set of field names to include in response payload for each record.

filtersobject

Filters provided as key value pairs defining inclusion criteria for query execution.

groupBystring

Field name used to group aggregated results when producing grouped query responses.

matchFieldsArray of objects(MatchFieldDto)

List of match field filters specifying terms that must align with query criteria.

multiSortFieldsArray of strings

List of multiple field names applied for compound sorting logic in results.

mustHaveFieldsArray of strings

List of fields that must exist on documents returned by the query.

mustNotHaveFieldsArray of strings

List of fields that must not exist on documents included in results.

mustNotMatchFieldArray of objects(MustNotMatchFieldDto)
pageinteger(int32)

Page number indicating current position within paginated query results.

pageByDateobject

Pagination by date entry specifying anchor timestamp for search after pagination.

pageSizeinteger(int32)

Number of items per page controlling volume of results returned per page.

queryStringOrFilterobject(QueryStringOrMacFilterDto)

Query string or MAC filter configuration combining text search and device matching.

rangeDateFilterobject(RangeFilterDto)

Range date filter configuration defining temporal boundaries for returned records.

rangeFilterobject(RangeFilterDto)

Range filter configuration defining numeric or date boundaries for query results.

searchStringstring

Search string representing the user query applied across designated target fields.

searchTargetFieldsArray of strings

List of target field names that should be queried for search string matching.

search_afterArray of strings

Search after values used to continue pagination without relying on offsets.

sortDescriptorsArray of objects(SortDescriptor)

List of sort descriptors defining multi level sort behaviors for query responses.

sortFieldstring

Field name used to sort query results within the returned data.

sortOrderstring

Sort order specifying ascending or descending direction for query results.

termFieldobject(TermFieldDto)

Term field filter configuration specifying exact match criteria for a field.

termsobject

Filter terms represented as key value pairs applied to refine result sets.

{
  "excludeFilters": {
    "property1": [ … ],
    "property2": [ … ]
  },
  "exists": "string",
  "fields": [
    "string"
  ],
  "filters": {
    "property1": [ … ],
    "property2": [ … ]
  },
  "groupBy": "string",
  "matchFields": [
    { … }
  ],
  "multiSortFields": [
    "string"
  ],
  "mustHaveFields": [
    "string"
  ],
  "mustNotHaveFields": [
    "string"
  ],
  "mustNotMatchField": [
    { … }
  ],
  "page": 0,
  "pageByDate": {
    "key": "string",
    "value": "string"
  },
  "pageSize": 0,
  "queryStringOrFilter": {
    "filterTerms": { … },
    "searchString": "string"
  },
  "rangeDateFilter": {
    "field": "string",
    "gte": 0,
    "lt": 0,
    "lte": 0
  },
  "rangeFilter": {
    "field": "string",
    "gte": 0,
    "lt": 0,
    "lte": 0
  },
  "searchString": "string",
  "searchTargetFields": [
    "string"
  ],
  "search_after": [
    "string"
  ],
  "sortDescriptors": [
    null
  ],
  "sortField": "string",
  "sortOrder": "string",
  "termField": {
    "field": "string",
    "value": "string"
  },
  "terms": {
    "property1": [ … ],
    "property2": [ … ]
  }
}

Responses

successful operation

Body
dataArray of objects(AccessControlSubProfileDto)

List of data items returned by the query.

errorMessagestring

Error message if the request failed.

errorsArray of objects(Error)

List of detailed errors if the request encountered issues.

fieldsArray of stringsunique

Set of field names included in the response.

objectIdstring

Unique identifier of the object being queried.

pageinteger(int32)

Current page number in the paginated results.

requestIdstring

Unique identifier for tracking this request.

subsequentQueriesArray of objects(SubsequentQuery)

List of subsequent query options for drilling down into results.

totalCountinteger(int64)

Total number of results matching the query.

Response
{
  "data": [
    { … }
  ],
  "errorMessage": "string",
  "errors": [
    { … }
  ],
  "fields": [
    "string"
  ],
  "objectId": "string",
  "page": 0,
  "requestId": "string",
  "subsequentQueries": [
    { … }
  ],
  "totalCount": 0
}

Get DHCP Configuration Service ProfilesDeprecated

Request

Get data for a list of DHCP configuration service profiles. This method will be removed no sooner than 08/31/2026. The following /dhcpConfigServiceProfiles/query can be used for this content.

Body
required
excludeFiltersobject

Exclusion filters as key value pairs defining values to omit from results.

existsstring

Field name that must exist within each document matched by the query execution.

fieldsArray of stringsunique

Set of field names to include in response payload for each record.

filtersobject

Filters provided as key value pairs defining inclusion criteria for query execution.

groupBystring

Field name used to group aggregated results when producing grouped query responses.

matchFieldsArray of objects(MatchFieldDto)

List of match field filters specifying terms that must align with query criteria.

multiSortFieldsArray of strings

List of multiple field names applied for compound sorting logic in results.

mustHaveFieldsArray of strings

List of fields that must exist on documents returned by the query.

mustNotHaveFieldsArray of strings

List of fields that must not exist on documents included in results.

mustNotMatchFieldArray of objects(MustNotMatchFieldDto)
pageinteger(int32)

Page number indicating current position within paginated query results.

pageByDateobject

Pagination by date entry specifying anchor timestamp for search after pagination.

pageSizeinteger(int32)

Number of items per page controlling volume of results returned per page.

queryStringOrFilterobject(QueryStringOrMacFilterDto)

Query string or MAC filter configuration combining text search and device matching.

rangeDateFilterobject(RangeFilterDto)

Range date filter configuration defining temporal boundaries for returned records.

rangeFilterobject(RangeFilterDto)

Range filter configuration defining numeric or date boundaries for query results.

searchStringstring

Search string representing the user query applied across designated target fields.

searchTargetFieldsArray of strings

List of target field names that should be queried for search string matching.

search_afterArray of strings

Search after values used to continue pagination without relying on offsets.

sortDescriptorsArray of objects(SortDescriptor)

List of sort descriptors defining multi level sort behaviors for query responses.

sortFieldstring

Field name used to sort query results within the returned data.

sortOrderstring

Sort order specifying ascending or descending direction for query results.

termFieldobject(TermFieldDto)

Term field filter configuration specifying exact match criteria for a field.

termsobject

Filter terms represented as key value pairs applied to refine result sets.

{
  "excludeFilters": {
    "property1": [ … ],
    "property2": [ … ]
  },
  "exists": "string",
  "fields": [
    "string"
  ],
  "filters": {
    "property1": [ … ],
    "property2": [ … ]
  },
  "groupBy": "string",
  "matchFields": [
    { … }
  ],
  "multiSortFields": [
    "string"
  ],
  "mustHaveFields": [
    "string"
  ],
  "mustNotHaveFields": [
    "string"
  ],
  "mustNotMatchField": [
    { … }
  ],
  "page": 0,
  "pageByDate": {
    "key": "string",
    "value": "string"
  },
  "pageSize": 0,
  "queryStringOrFilter": {
    "filterTerms": { … },
    "searchString": "string"
  },
  "rangeDateFilter": {
    "field": "string",
    "gte": 0,
    "lt": 0,
    "lte": 0
  },
  "rangeFilter": {
    "field": "string",
    "gte": 0,
    "lt": 0,
    "lte": 0
  },
  "searchString": "string",
  "searchTargetFields": [
    "string"
  ],
  "search_after": [
    "string"
  ],
  "sortDescriptors": [
    null
  ],
  "sortField": "string",
  "sortOrder": "string",
  "termField": {
    "field": "string",
    "value": "string"
  },
  "terms": {
    "property1": [ … ],
    "property2": [ … ]
  }
}

Responses

successful operation

Body
dataArray of objects(DhcpConfigServiceProfileDto)

List of data items returned by the query.

errorMessagestring

Error message if the request failed.

errorsArray of objects(Error)

List of detailed errors if the request encountered issues.

fieldsArray of stringsunique

Set of field names included in the response.

objectIdstring

Unique identifier of the object being queried.

pageinteger(int32)

Current page number in the paginated results.

requestIdstring

Unique identifier for tracking this request.

subsequentQueriesArray of objects(SubsequentQuery)

List of subsequent query options for drilling down into results.

totalCountinteger(int64)

Total number of results matching the query.

Response
{
  "data": [
    { … }
  ],
  "errorMessage": "string",
  "errors": [
    { … }
  ],
  "fields": [
    "string"
  ],
  "objectId": "string",
  "page": 0,
  "requestId": "string",
  "subsequentQueries": [
    { … }
  ],
  "totalCount": 0
}

Get Client Isolation AllowlistsDeprecated

Request

Get data for a list of client isolation allowlists. This method will be removed no sooner than 08/31/2026. The following /clientIsolationProfiles/query can be used for this content.

Body
required
excludeFiltersobject

Exclusion filters as key value pairs defining values to omit from results.

existsstring

Field name that must exist within each document matched by the query execution.

fieldsArray of stringsunique

Set of field names to include in response payload for each record.

filtersobject

Filters provided as key value pairs defining inclusion criteria for query execution.

groupBystring

Field name used to group aggregated results when producing grouped query responses.

matchFieldsArray of objects(MatchFieldDto)

List of match field filters specifying terms that must align with query criteria.

multiSortFieldsArray of strings

List of multiple field names applied for compound sorting logic in results.

mustHaveFieldsArray of strings

List of fields that must exist on documents returned by the query.

mustNotHaveFieldsArray of strings

List of fields that must not exist on documents included in results.

mustNotMatchFieldArray of objects(MustNotMatchFieldDto)
pageinteger(int32)

Page number indicating current position within paginated query results.

pageByDateobject

Pagination by date entry specifying anchor timestamp for search after pagination.

pageSizeinteger(int32)

Number of items per page controlling volume of results returned per page.

queryStringOrFilterobject(QueryStringOrMacFilterDto)

Query string or MAC filter configuration combining text search and device matching.

rangeDateFilterobject(RangeFilterDto)

Range date filter configuration defining temporal boundaries for returned records.

rangeFilterobject(RangeFilterDto)

Range filter configuration defining numeric or date boundaries for query results.

searchStringstring

Search string representing the user query applied across designated target fields.

searchTargetFieldsArray of strings

List of target field names that should be queried for search string matching.

search_afterArray of strings

Search after values used to continue pagination without relying on offsets.

sortDescriptorsArray of objects(SortDescriptor)

List of sort descriptors defining multi level sort behaviors for query responses.

sortFieldstring

Field name used to sort query results within the returned data.

sortOrderstring

Sort order specifying ascending or descending direction for query results.

termFieldobject(TermFieldDto)

Term field filter configuration specifying exact match criteria for a field.

termsobject

Filter terms represented as key value pairs applied to refine result sets.

{
  "excludeFilters": {
    "property1": [ … ],
    "property2": [ … ]
  },
  "exists": "string",
  "fields": [
    "string"
  ],
  "filters": {
    "property1": [ … ],
    "property2": [ … ]
  },
  "groupBy": "string",
  "matchFields": [
    { … }
  ],
  "multiSortFields": [
    "string"
  ],
  "mustHaveFields": [
    "string"
  ],
  "mustNotHaveFields": [
    "string"
  ],
  "mustNotMatchField": [
    { … }
  ],
  "page": 0,
  "pageByDate": {
    "key": "string",
    "value": "string"
  },
  "pageSize": 0,
  "queryStringOrFilter": {
    "filterTerms": { … },
    "searchString": "string"
  },
  "rangeDateFilter": {
    "field": "string",
    "gte": 0,
    "lt": 0,
    "lte": 0
  },
  "rangeFilter": {
    "field": "string",
    "gte": 0,
    "lt": 0,
    "lte": 0
  },
  "searchString": "string",
  "searchTargetFields": [
    "string"
  ],
  "search_after": [
    "string"
  ],
  "sortDescriptors": [
    null
  ],
  "sortField": "string",
  "sortOrder": "string",
  "termField": {
    "field": "string",
    "value": "string"
  },
  "terms": {
    "property1": [ … ],
    "property2": [ … ]
  }
}

Responses

successful operation

Body
dataArray of objects(IsolationAllowlistDto)

List of data items returned by the query.

errorMessagestring

Error message if the request failed.

errorsArray of objects(Error)

List of detailed errors if the request encountered issues.

fieldsArray of stringsunique

Set of field names included in the response.

objectIdstring

Unique identifier of the object being queried.

pageinteger(int32)

Current page number in the paginated results.

requestIdstring

Unique identifier for tracking this request.

subsequentQueriesArray of objects(SubsequentQuery)

List of subsequent query options for drilling down into results.

totalCountinteger(int64)

Total number of results matching the query.

Response
{
  "data": [
    { … }
  ],
  "errorMessage": "string",
  "errors": [
    { … }
  ],
  "fields": [
    "string"
  ],
  "objectId": "string",
  "page": 0,
  "requestId": "string",
  "subsequentQueries": [
    { … }
  ],
  "totalCount": 0
}

Get Layer 2 PoliciesDeprecated

Request

Get data for a list of layer 2 policies. This method will be removed no sooner than 08/31/2026. The following /l2AclPolicies/query can be used for this content.

Body
required
excludeFiltersobject

Exclusion filters as key value pairs defining values to omit from results.

existsstring

Field name that must exist within each document matched by the query execution.

fieldsArray of stringsunique

Set of field names to include in response payload for each record.

filtersobject

Filters provided as key value pairs defining inclusion criteria for query execution.

groupBystring

Field name used to group aggregated results when producing grouped query responses.

matchFieldsArray of objects(MatchFieldDto)

List of match field filters specifying terms that must align with query criteria.

multiSortFieldsArray of strings

List of multiple field names applied for compound sorting logic in results.

mustHaveFieldsArray of strings

List of fields that must exist on documents returned by the query.

mustNotHaveFieldsArray of strings

List of fields that must not exist on documents included in results.

mustNotMatchFieldArray of objects(MustNotMatchFieldDto)
pageinteger(int32)

Page number indicating current position within paginated query results.

pageByDateobject

Pagination by date entry specifying anchor timestamp for search after pagination.

pageSizeinteger(int32)

Number of items per page controlling volume of results returned per page.

queryStringOrFilterobject(QueryStringOrMacFilterDto)

Query string or MAC filter configuration combining text search and device matching.

rangeDateFilterobject(RangeFilterDto)

Range date filter configuration defining temporal boundaries for returned records.

rangeFilterobject(RangeFilterDto)

Range filter configuration defining numeric or date boundaries for query results.

searchStringstring

Search string representing the user query applied across designated target fields.

searchTargetFieldsArray of strings

List of target field names that should be queried for search string matching.

search_afterArray of strings

Search after values used to continue pagination without relying on offsets.

sortDescriptorsArray of objects(SortDescriptor)

List of sort descriptors defining multi level sort behaviors for query responses.

sortFieldstring

Field name used to sort query results within the returned data.

sortOrderstring

Sort order specifying ascending or descending direction for query results.

termFieldobject(TermFieldDto)

Term field filter configuration specifying exact match criteria for a field.

termsobject

Filter terms represented as key value pairs applied to refine result sets.

{
  "excludeFilters": {
    "property1": [ … ],
    "property2": [ … ]
  },
  "exists": "string",
  "fields": [
    "string"
  ],
  "filters": {
    "property1": [ … ],
    "property2": [ … ]
  },
  "groupBy": "string",
  "matchFields": [
    { … }
  ],
  "multiSortFields": [
    "string"
  ],
  "mustHaveFields": [
    "string"
  ],
  "mustNotHaveFields": [
    "string"
  ],
  "mustNotMatchField": [
    { … }
  ],
  "page": 0,
  "pageByDate": {
    "key": "string",
    "value": "string"
  },
  "pageSize": 0,
  "queryStringOrFilter": {
    "filterTerms": { … },
    "searchString": "string"
  },
  "rangeDateFilter": {
    "field": "string",
    "gte": 0,
    "lt": 0,
    "lte": 0
  },
  "rangeFilter": {
    "field": "string",
    "gte": 0,
    "lt": 0,
    "lte": 0
  },
  "searchString": "string",
  "searchTargetFields": [
    "string"
  ],
  "search_after": [
    "string"
  ],
  "sortDescriptors": [
    null
  ],
  "sortField": "string",
  "sortOrder": "string",
  "termField": {
    "field": "string",
    "value": "string"
  },
  "terms": {
    "property1": [ … ],
    "property2": [ … ]
  }
}

Responses

successful operation

Body
dataArray of objects(AccessControlSubProfileDto)

List of data items returned by the query.

errorMessagestring

Error message if the request failed.

errorsArray of objects(Error)

List of detailed errors if the request encountered issues.

fieldsArray of stringsunique

Set of field names included in the response.

objectIdstring

Unique identifier of the object being queried.

pageinteger(int32)

Current page number in the paginated results.

requestIdstring

Unique identifier for tracking this request.

subsequentQueriesArray of objects(SubsequentQuery)

List of subsequent query options for drilling down into results.

totalCountinteger(int64)

Total number of results matching the query.

Response
{
  "data": [
    { … }
  ],
  "errorMessage": "string",
  "errors": [
    { … }
  ],
  "fields": [
    "string"
  ],
  "objectId": "string",
  "page": 0,
  "requestId": "string",
  "subsequentQueries": [
    { … }
  ],
  "totalCount": 0
}

Get Layer 3 PoliciesDeprecated

Request

Get data for a list of layer 3 policies. This method will be removed no sooner than 08/31/2026. The following /l3AclPolicies/query can be used for this content.

Body
required
excludeFiltersobject

Exclusion filters as key value pairs defining values to omit from results.

existsstring

Field name that must exist within each document matched by the query execution.

fieldsArray of stringsunique

Set of field names to include in response payload for each record.

filtersobject

Filters provided as key value pairs defining inclusion criteria for query execution.

groupBystring

Field name used to group aggregated results when producing grouped query responses.

matchFieldsArray of objects(MatchFieldDto)

List of match field filters specifying terms that must align with query criteria.

multiSortFieldsArray of strings

List of multiple field names applied for compound sorting logic in results.

mustHaveFieldsArray of strings

List of fields that must exist on documents returned by the query.

mustNotHaveFieldsArray of strings

List of fields that must not exist on documents included in results.

mustNotMatchFieldArray of objects(MustNotMatchFieldDto)
pageinteger(int32)

Page number indicating current position within paginated query results.

pageByDateobject

Pagination by date entry specifying anchor timestamp for search after pagination.

pageSizeinteger(int32)

Number of items per page controlling volume of results returned per page.

queryStringOrFilterobject(QueryStringOrMacFilterDto)

Query string or MAC filter configuration combining text search and device matching.

rangeDateFilterobject(RangeFilterDto)

Range date filter configuration defining temporal boundaries for returned records.

rangeFilterobject(RangeFilterDto)

Range filter configuration defining numeric or date boundaries for query results.

searchStringstring

Search string representing the user query applied across designated target fields.

searchTargetFieldsArray of strings

List of target field names that should be queried for search string matching.

search_afterArray of strings

Search after values used to continue pagination without relying on offsets.

sortDescriptorsArray of objects(SortDescriptor)

List of sort descriptors defining multi level sort behaviors for query responses.

sortFieldstring

Field name used to sort query results within the returned data.

sortOrderstring

Sort order specifying ascending or descending direction for query results.

termFieldobject(TermFieldDto)

Term field filter configuration specifying exact match criteria for a field.

termsobject

Filter terms represented as key value pairs applied to refine result sets.

{
  "excludeFilters": {
    "property1": [ … ],
    "property2": [ … ]
  },
  "exists": "string",
  "fields": [
    "string"
  ],
  "filters": {
    "property1": [ … ],
    "property2": [ … ]
  },
  "groupBy": "string",
  "matchFields": [
    { … }
  ],
  "multiSortFields": [
    "string"
  ],
  "mustHaveFields": [
    "string"
  ],
  "mustNotHaveFields": [
    "string"
  ],
  "mustNotMatchField": [
    { … }
  ],
  "page": 0,
  "pageByDate": {
    "key": "string",
    "value": "string"
  },
  "pageSize": 0,
  "queryStringOrFilter": {
    "filterTerms": { … },
    "searchString": "string"
  },
  "rangeDateFilter": {
    "field": "string",
    "gte": 0,
    "lt": 0,
    "lte": 0
  },
  "rangeFilter": {
    "field": "string",
    "gte": 0,
    "lt": 0,
    "lte": 0
  },
  "searchString": "string",
  "searchTargetFields": [
    "string"
  ],
  "search_after": [
    "string"
  ],
  "sortDescriptors": [
    null
  ],
  "sortField": "string",
  "sortOrder": "string",
  "termField": {
    "field": "string",
    "value": "string"
  },
  "terms": {
    "property1": [ … ],
    "property2": [ … ]
  }
}

Responses

successful operation

Body
dataArray of objects(AccessControlSubProfileDto)

List of data items returned by the query.

errorMessagestring

Error message if the request failed.

errorsArray of objects(Error)

List of detailed errors if the request encountered issues.

fieldsArray of stringsunique

Set of field names included in the response.

objectIdstring

Unique identifier of the object being queried.

pageinteger(int32)

Current page number in the paginated results.

requestIdstring

Unique identifier for tracking this request.

subsequentQueriesArray of objects(SubsequentQuery)

List of subsequent query options for drilling down into results.

totalCountinteger(int64)

Total number of results matching the query.

Response
{
  "data": [
    { … }
  ],
  "errorMessage": "string",
  "errors": [
    { … }
  ],
  "fields": [
    "string"
  ],
  "objectId": "string",
  "page": 0,
  "requestId": "string",
  "subsequentQueries": [
    { … }
  ],
  "totalCount": 0
}

Get Multicast DNS Proxy ProfilesDeprecated

Request

Get data for a list of multicast DNS proxy service profiles. This method will be removed no sooner than 08/31/2026. The following /multicastDnsProxyProfiles/query can be used for this content.

Body
required
excludeFiltersobject

Exclusion filters as key value pairs defining values to omit from results.

existsstring

Field name that must exist within each document matched by the query execution.

fieldsArray of stringsunique

Set of field names to include in response payload for each record.

filtersobject

Filters provided as key value pairs defining inclusion criteria for query execution.

groupBystring

Field name used to group aggregated results when producing grouped query responses.

matchFieldsArray of objects(MatchFieldDto)

List of match field filters specifying terms that must align with query criteria.

multiSortFieldsArray of strings

List of multiple field names applied for compound sorting logic in results.

mustHaveFieldsArray of strings

List of fields that must exist on documents returned by the query.

mustNotHaveFieldsArray of strings

List of fields that must not exist on documents included in results.

mustNotMatchFieldArray of objects(MustNotMatchFieldDto)
pageinteger(int32)

Page number indicating current position within paginated query results.

pageByDateobject

Pagination by date entry specifying anchor timestamp for search after pagination.

pageSizeinteger(int32)

Number of items per page controlling volume of results returned per page.

queryStringOrFilterobject(QueryStringOrMacFilterDto)

Query string or MAC filter configuration combining text search and device matching.

rangeDateFilterobject(RangeFilterDto)

Range date filter configuration defining temporal boundaries for returned records.

rangeFilterobject(RangeFilterDto)

Range filter configuration defining numeric or date boundaries for query results.

searchStringstring

Search string representing the user query applied across designated target fields.

searchTargetFieldsArray of strings

List of target field names that should be queried for search string matching.

search_afterArray of strings

Search after values used to continue pagination without relying on offsets.

sortDescriptorsArray of objects(SortDescriptor)

List of sort descriptors defining multi level sort behaviors for query responses.

sortFieldstring

Field name used to sort query results within the returned data.

sortOrderstring

Sort order specifying ascending or descending direction for query results.

termFieldobject(TermFieldDto)

Term field filter configuration specifying exact match criteria for a field.

termsobject

Filter terms represented as key value pairs applied to refine result sets.

{
  "excludeFilters": {
    "property1": [ … ],
    "property2": [ … ]
  },
  "exists": "string",
  "fields": [
    "string"
  ],
  "filters": {
    "property1": [ … ],
    "property2": [ … ]
  },
  "groupBy": "string",
  "matchFields": [
    { … }
  ],
  "multiSortFields": [
    "string"
  ],
  "mustHaveFields": [
    "string"
  ],
  "mustNotHaveFields": [
    "string"
  ],
  "mustNotMatchField": [
    { … }
  ],
  "page": 0,
  "pageByDate": {
    "key": "string",
    "value": "string"
  },
  "pageSize": 0,
  "queryStringOrFilter": {
    "filterTerms": { … },
    "searchString": "string"
  },
  "rangeDateFilter": {
    "field": "string",
    "gte": 0,
    "lt": 0,
    "lte": 0
  },
  "rangeFilter": {
    "field": "string",
    "gte": 0,
    "lt": 0,
    "lte": 0
  },
  "searchString": "string",
  "searchTargetFields": [
    "string"
  ],
  "search_after": [
    "string"
  ],
  "sortDescriptors": [
    null
  ],
  "sortField": "string",
  "sortOrder": "string",
  "termField": {
    "field": "string",
    "value": "string"
  },
  "terms": {
    "property1": [ … ],
    "property2": [ … ]
  }
}

Responses

successful operation

Body
dataArray of objects(MulticastDnsProxyServiceProfileDto)

List of data items returned by the query.

errorMessagestring

Error message if the request failed.

errorsArray of objects(Error)

List of detailed errors if the request encountered issues.

fieldsArray of stringsunique

Set of field names included in the response.

objectIdstring

Unique identifier of the object being queried.

pageinteger(int32)

Current page number in the paginated results.

requestIdstring

Unique identifier for tracking this request.

subsequentQueriesArray of objects(SubsequentQuery)

List of subsequent query options for drilling down into results.

totalCountinteger(int64)

Total number of results matching the query.

Response
{
  "data": [
    { … }
  ],
  "errorMessage": "string",
  "errors": [
    { … }
  ],
  "fields": [
    "string"
  ],
  "objectId": "string",
  "page": 0,
  "requestId": "string",
  "subsequentQueries": [
    { … }
  ],
  "totalCount": 0
}

Get RADIUS Server ProfilesDeprecated

Request

Get data for a list of RADIUS server profiles. This method will be removed no sooner than 08/31/2026. The following /radiusServerProfiles/query can be used for this content.

Body
required
excludeFiltersobject

Exclusion filters as key value pairs defining values to omit from results.

existsstring

Field name that must exist within each document matched by the query execution.

fieldsArray of stringsunique

Set of field names to include in response payload for each record.

filtersobject

Filters provided as key value pairs defining inclusion criteria for query execution.

groupBystring

Field name used to group aggregated results when producing grouped query responses.

matchFieldsArray of objects(MatchFieldDto)

List of match field filters specifying terms that must align with query criteria.

multiSortFieldsArray of strings

List of multiple field names applied for compound sorting logic in results.

mustHaveFieldsArray of strings

List of fields that must exist on documents returned by the query.

mustNotHaveFieldsArray of strings

List of fields that must not exist on documents included in results.

mustNotMatchFieldArray of objects(MustNotMatchFieldDto)
pageinteger(int32)

Page number indicating current position within paginated query results.

pageByDateobject

Pagination by date entry specifying anchor timestamp for search after pagination.

pageSizeinteger(int32)

Number of items per page controlling volume of results returned per page.

queryStringOrFilterobject(QueryStringOrMacFilterDto)

Query string or MAC filter configuration combining text search and device matching.

rangeDateFilterobject(RangeFilterDto)

Range date filter configuration defining temporal boundaries for returned records.

rangeFilterobject(RangeFilterDto)

Range filter configuration defining numeric or date boundaries for query results.

searchStringstring

Search string representing the user query applied across designated target fields.

searchTargetFieldsArray of strings

List of target field names that should be queried for search string matching.

search_afterArray of strings

Search after values used to continue pagination without relying on offsets.

sortDescriptorsArray of objects(SortDescriptor)

List of sort descriptors defining multi level sort behaviors for query responses.

sortFieldstring

Field name used to sort query results within the returned data.

sortOrderstring

Sort order specifying ascending or descending direction for query results.

termFieldobject(TermFieldDto)

Term field filter configuration specifying exact match criteria for a field.

termsobject

Filter terms represented as key value pairs applied to refine result sets.

{
  "excludeFilters": {
    "property1": [ … ],
    "property2": [ … ]
  },
  "exists": "string",
  "fields": [
    "string"
  ],
  "filters": {
    "property1": [ … ],
    "property2": [ … ]
  },
  "groupBy": "string",
  "matchFields": [
    { … }
  ],
  "multiSortFields": [
    "string"
  ],
  "mustHaveFields": [
    "string"
  ],
  "mustNotHaveFields": [
    "string"
  ],
  "mustNotMatchField": [
    { … }
  ],
  "page": 0,
  "pageByDate": {
    "key": "string",
    "value": "string"
  },
  "pageSize": 0,
  "queryStringOrFilter": {
    "filterTerms": { … },
    "searchString": "string"
  },
  "rangeDateFilter": {
    "field": "string",
    "gte": 0,
    "lt": 0,
    "lte": 0
  },
  "rangeFilter": {
    "field": "string",
    "gte": 0,
    "lt": 0,
    "lte": 0
  },
  "searchString": "string",
  "searchTargetFields": [
    "string"
  ],
  "search_after": [
    "string"
  ],
  "sortDescriptors": [
    null
  ],
  "sortField": "string",
  "sortOrder": "string",
  "termField": {
    "field": "string",
    "value": "string"
  },
  "terms": {
    "property1": [ … ],
    "property2": [ … ]
  }
}

Responses

successful operation

Body
dataArray of objects(RadiusServerProfileDto)

List of data items returned by the query.

errorMessagestring

Error message if the request failed.

errorsArray of objects(Error)

List of detailed errors if the request encountered issues.

fieldsArray of stringsunique

Set of field names included in the response.

objectIdstring

Unique identifier of the object being queried.

pageinteger(int32)

Current page number in the paginated results.

requestIdstring

Unique identifier for tracking this request.

subsequentQueriesArray of objects(SubsequentQuery)

List of subsequent query options for drilling down into results.

totalCountinteger(int64)

Total number of results matching the query.

Response
{
  "data": [
    { … }
  ],
  "errorMessage": "string",
  "errors": [
    { … }
  ],
  "fields": [
    "string"
  ],
  "objectId": "string",
  "page": 0,
  "requestId": "string",
  "subsequentQueries": [
    { … }
  ],
  "totalCount": 0
}

Get Rogue AP Policy ProfilesDeprecated

Request

Get data for a list of rogue AP policies. This method will be removed no sooner than 08/31/2026. The following /roguePolicies/query can be used for this content.

Body
required
excludeFiltersobject

Exclusion filters as key value pairs defining values to omit from results.

existsstring

Field name that must exist within each document matched by the query execution.

fieldsArray of stringsunique

Set of field names to include in response payload for each record.

filtersobject

Filters provided as key value pairs defining inclusion criteria for query execution.

groupBystring

Field name used to group aggregated results when producing grouped query responses.

matchFieldsArray of objects(MatchFieldDto)

List of match field filters specifying terms that must align with query criteria.

multiSortFieldsArray of strings

List of multiple field names applied for compound sorting logic in results.

mustHaveFieldsArray of strings

List of fields that must exist on documents returned by the query.

mustNotHaveFieldsArray of strings

List of fields that must not exist on documents included in results.

mustNotMatchFieldArray of objects(MustNotMatchFieldDto)
pageinteger(int32)

Page number indicating current position within paginated query results.

pageByDateobject

Pagination by date entry specifying anchor timestamp for search after pagination.

pageSizeinteger(int32)

Number of items per page controlling volume of results returned per page.

queryStringOrFilterobject(QueryStringOrMacFilterDto)

Query string or MAC filter configuration combining text search and device matching.

rangeDateFilterobject(RangeFilterDto)

Range date filter configuration defining temporal boundaries for returned records.

rangeFilterobject(RangeFilterDto)

Range filter configuration defining numeric or date boundaries for query results.

searchStringstring

Search string representing the user query applied across designated target fields.

searchTargetFieldsArray of strings

List of target field names that should be queried for search string matching.

search_afterArray of strings

Search after values used to continue pagination without relying on offsets.

sortDescriptorsArray of objects(SortDescriptor)

List of sort descriptors defining multi level sort behaviors for query responses.

sortFieldstring

Field name used to sort query results within the returned data.

sortOrderstring

Sort order specifying ascending or descending direction for query results.

termFieldobject(TermFieldDto)

Term field filter configuration specifying exact match criteria for a field.

termsobject

Filter terms represented as key value pairs applied to refine result sets.

{
  "excludeFilters": {
    "property1": [ … ],
    "property2": [ … ]
  },
  "exists": "string",
  "fields": [
    "string"
  ],
  "filters": {
    "property1": [ … ],
    "property2": [ … ]
  },
  "groupBy": "string",
  "matchFields": [
    { … }
  ],
  "multiSortFields": [
    "string"
  ],
  "mustHaveFields": [
    "string"
  ],
  "mustNotHaveFields": [
    "string"
  ],
  "mustNotMatchField": [
    { … }
  ],
  "page": 0,
  "pageByDate": {
    "key": "string",
    "value": "string"
  },
  "pageSize": 0,
  "queryStringOrFilter": {
    "filterTerms": { … },
    "searchString": "string"
  },
  "rangeDateFilter": {
    "field": "string",
    "gte": 0,
    "lt": 0,
    "lte": 0
  },
  "rangeFilter": {
    "field": "string",
    "gte": 0,
    "lt": 0,
    "lte": 0
  },
  "searchString": "string",
  "searchTargetFields": [
    "string"
  ],
  "search_after": [
    "string"
  ],
  "sortDescriptors": [
    null
  ],
  "sortField": "string",
  "sortOrder": "string",
  "termField": {
    "field": "string",
    "value": "string"
  },
  "terms": {
    "property1": [ … ],
    "property2": [ … ]
  }
}

Responses

successful operation

Body
dataArray of objects(RogueApPolicyProfileDto)

List of data items returned by the query.

errorMessagestring

Error message if the request failed.

errorsArray of objects(Error)

List of detailed errors if the request encountered issues.

fieldsArray of stringsunique

Set of field names included in the response.

objectIdstring

Unique identifier of the object being queried.

pageinteger(int32)

Current page number in the paginated results.

requestIdstring

Unique identifier for tracking this request.

subsequentQueriesArray of objects(SubsequentQuery)

List of subsequent query options for drilling down into results.

totalCountinteger(int64)

Total number of results matching the query.

Response
{
  "data": [
    { … }
  ],
  "errorMessage": "string",
  "errors": [
    { … }
  ],
  "fields": [
    "string"
  ],
  "objectId": "string",
  "page": 0,
  "requestId": "string",
  "subsequentQueries": [
    { … }
  ],
  "totalCount": 0
}

Get Syslog Server ProfilesDeprecated

Request

Get data for a list of syslog server profiles. This method will be removed no sooner than 08/31/2026. The following /syslogServerProfiles/query can be used for this content.

Body
required
excludeFiltersobject

Exclusion filters as key value pairs defining values to omit from results.

existsstring

Field name that must exist within each document matched by the query execution.

fieldsArray of stringsunique

Set of field names to include in response payload for each record.

filtersobject

Filters provided as key value pairs defining inclusion criteria for query execution.

groupBystring

Field name used to group aggregated results when producing grouped query responses.

matchFieldsArray of objects(MatchFieldDto)

List of match field filters specifying terms that must align with query criteria.

multiSortFieldsArray of strings

List of multiple field names applied for compound sorting logic in results.

mustHaveFieldsArray of strings

List of fields that must exist on documents returned by the query.

mustNotHaveFieldsArray of strings

List of fields that must not exist on documents included in results.

mustNotMatchFieldArray of objects(MustNotMatchFieldDto)
pageinteger(int32)

Page number indicating current position within paginated query results.

pageByDateobject

Pagination by date entry specifying anchor timestamp for search after pagination.

pageSizeinteger(int32)

Number of items per page controlling volume of results returned per page.

queryStringOrFilterobject(QueryStringOrMacFilterDto)

Query string or MAC filter configuration combining text search and device matching.

rangeDateFilterobject(RangeFilterDto)

Range date filter configuration defining temporal boundaries for returned records.

rangeFilterobject(RangeFilterDto)

Range filter configuration defining numeric or date boundaries for query results.

searchStringstring

Search string representing the user query applied across designated target fields.

searchTargetFieldsArray of strings

List of target field names that should be queried for search string matching.

search_afterArray of strings

Search after values used to continue pagination without relying on offsets.

sortDescriptorsArray of objects(SortDescriptor)

List of sort descriptors defining multi level sort behaviors for query responses.

sortFieldstring

Field name used to sort query results within the returned data.

sortOrderstring

Sort order specifying ascending or descending direction for query results.

termFieldobject(TermFieldDto)

Term field filter configuration specifying exact match criteria for a field.

termsobject

Filter terms represented as key value pairs applied to refine result sets.

{
  "excludeFilters": {
    "property1": [ … ],
    "property2": [ … ]
  },
  "exists": "string",
  "fields": [
    "string"
  ],
  "filters": {
    "property1": [ … ],
    "property2": [ … ]
  },
  "groupBy": "string",
  "matchFields": [
    { … }
  ],
  "multiSortFields": [
    "string"
  ],
  "mustHaveFields": [
    "string"
  ],
  "mustNotHaveFields": [
    "string"
  ],
  "mustNotMatchField": [
    { … }
  ],
  "page": 0,
  "pageByDate": {
    "key": "string",
    "value": "string"
  },
  "pageSize": 0,
  "queryStringOrFilter": {
    "filterTerms": { … },
    "searchString": "string"
  },
  "rangeDateFilter": {
    "field": "string",
    "gte": 0,
    "lt": 0,
    "lte": 0
  },
  "rangeFilter": {
    "field": "string",
    "gte": 0,
    "lt": 0,
    "lte": 0
  },
  "searchString": "string",
  "searchTargetFields": [
    "string"
  ],
  "search_after": [
    "string"
  ],
  "sortDescriptors": [
    null
  ],
  "sortField": "string",
  "sortOrder": "string",
  "termField": {
    "field": "string",
    "value": "string"
  },
  "terms": {
    "property1": [ … ],
    "property2": [ … ]
  }
}

Responses

successful operation

Body
dataArray of objects(SyslogServerProfileDto)

List of data items returned by the query.

errorMessagestring

Error message if the request failed.

errorsArray of objects(Error)

List of detailed errors if the request encountered issues.

fieldsArray of stringsunique

Set of field names included in the response.

objectIdstring

Unique identifier of the object being queried.

pageinteger(int32)

Current page number in the paginated results.

requestIdstring

Unique identifier for tracking this request.

subsequentQueriesArray of objects(SubsequentQuery)

List of subsequent query options for drilling down into results.

totalCountinteger(int64)

Total number of results matching the query.

Response
{
  "data": [
    { … }
  ],
  "errorMessage": "string",
  "errors": [
    { … }
  ],
  "fields": [
    "string"
  ],
  "objectId": "string",
  "page": 0,
  "requestId": "string",
  "subsequentQueries": [
    { … }
  ],
  "totalCount": 0
}

Get VLAN Pool ProfilesDeprecated

Request

Get data for a list of VLAN pool policy profiles. This method will be removed no sooner than 08/31/2026. The following /vlanPoolProfiles/query can be used for this content.

Body
required
excludeFiltersobject

Exclusion filters as key value pairs defining values to omit from results.

existsstring

Field name that must exist within each document matched by the query execution.

fieldsArray of stringsunique

Set of field names to include in response payload for each record.

filtersobject

Filters provided as key value pairs defining inclusion criteria for query execution.

groupBystring

Field name used to group aggregated results when producing grouped query responses.

matchFieldsArray of objects(MatchFieldDto)

List of match field filters specifying terms that must align with query criteria.

multiSortFieldsArray of strings

List of multiple field names applied for compound sorting logic in results.

mustHaveFieldsArray of strings

List of fields that must exist on documents returned by the query.

mustNotHaveFieldsArray of strings

List of fields that must not exist on documents included in results.

mustNotMatchFieldArray of objects(MustNotMatchFieldDto)
pageinteger(int32)

Page number indicating current position within paginated query results.

pageByDateobject

Pagination by date entry specifying anchor timestamp for search after pagination.

pageSizeinteger(int32)

Number of items per page controlling volume of results returned per page.

queryStringOrFilterobject(QueryStringOrMacFilterDto)

Query string or MAC filter configuration combining text search and device matching.

rangeDateFilterobject(RangeFilterDto)

Range date filter configuration defining temporal boundaries for returned records.

rangeFilterobject(RangeFilterDto)

Range filter configuration defining numeric or date boundaries for query results.

searchStringstring

Search string representing the user query applied across designated target fields.

searchTargetFieldsArray of strings

List of target field names that should be queried for search string matching.

search_afterArray of strings

Search after values used to continue pagination without relying on offsets.

sortDescriptorsArray of objects(SortDescriptor)

List of sort descriptors defining multi level sort behaviors for query responses.

sortFieldstring

Field name used to sort query results within the returned data.

sortOrderstring

Sort order specifying ascending or descending direction for query results.

termFieldobject(TermFieldDto)

Term field filter configuration specifying exact match criteria for a field.

termsobject

Filter terms represented as key value pairs applied to refine result sets.

{
  "excludeFilters": {
    "property1": [ … ],
    "property2": [ … ]
  },
  "exists": "string",
  "fields": [
    "string"
  ],
  "filters": {
    "property1": [ … ],
    "property2": [ … ]
  },
  "groupBy": "string",
  "matchFields": [
    { … }
  ],
  "multiSortFields": [
    "string"
  ],
  "mustHaveFields": [
    "string"
  ],
  "mustNotHaveFields": [
    "string"
  ],
  "mustNotMatchField": [
    { … }
  ],
  "page": 0,
  "pageByDate": {
    "key": "string",
    "value": "string"
  },
  "pageSize": 0,
  "queryStringOrFilter": {
    "filterTerms": { … },
    "searchString": "string"
  },
  "rangeDateFilter": {
    "field": "string",
    "gte": 0,
    "lt": 0,
    "lte": 0
  },
  "rangeFilter": {
    "field": "string",
    "gte": 0,
    "lt": 0,
    "lte": 0
  },
  "searchString": "string",
  "searchTargetFields": [
    "string"
  ],
  "search_after": [
    "string"
  ],
  "sortDescriptors": [
    null
  ],
  "sortField": "string",
  "sortOrder": "string",
  "termField": {
    "field": "string",
    "value": "string"
  },
  "terms": {
    "property1": [ … ],
    "property2": [ … ]
  }
}

Responses

successful operation

Body
dataArray of objects(VlanPoolVenueDto)

List of data items returned by the query.

errorMessagestring

Error message if the request failed.

errorsArray of objects(Error)

List of detailed errors if the request encountered issues.

fieldsArray of stringsunique

Set of field names included in the response.

objectIdstring

Unique identifier of the object being queried.

pageinteger(int32)

Current page number in the paginated results.

requestIdstring

Unique identifier for tracking this request.

subsequentQueriesArray of objects(SubsequentQuery)

List of subsequent query options for drilling down into results.

totalCountinteger(int64)

Total number of results matching the query.

Response
{
  "data": [
    { … }
  ],
  "errorMessage": "string",
  "errors": [
    { … }
  ],
  "fields": [
    "string"
  ],
  "objectId": "string",
  "page": 0,
  "requestId": "string",
  "subsequentQueries": [
    { … }
  ],
  "totalCount": 0
}

Get Wifi Calling ProfilesDeprecated

Request

Get data for a list of Wi-Fi calling service profiles. This method will be removed no sooner than 08/31/2026. The following /wifiCallingServiceProfiles/query can be used for this content.

Body
required
excludeFiltersobject

Exclusion filters as key value pairs defining values to omit from results.

existsstring

Field name that must exist within each document matched by the query execution.

fieldsArray of stringsunique

Set of field names to include in response payload for each record.

filtersobject

Filters provided as key value pairs defining inclusion criteria for query execution.

groupBystring

Field name used to group aggregated results when producing grouped query responses.

matchFieldsArray of objects(MatchFieldDto)

List of match field filters specifying terms that must align with query criteria.

multiSortFieldsArray of strings

List of multiple field names applied for compound sorting logic in results.

mustHaveFieldsArray of strings

List of fields that must exist on documents returned by the query.

mustNotHaveFieldsArray of strings

List of fields that must not exist on documents included in results.

mustNotMatchFieldArray of objects(MustNotMatchFieldDto)
pageinteger(int32)

Page number indicating current position within paginated query results.

pageByDateobject

Pagination by date entry specifying anchor timestamp for search after pagination.

pageSizeinteger(int32)

Number of items per page controlling volume of results returned per page.

queryStringOrFilterobject(QueryStringOrMacFilterDto)

Query string or MAC filter configuration combining text search and device matching.

rangeDateFilterobject(RangeFilterDto)

Range date filter configuration defining temporal boundaries for returned records.

rangeFilterobject(RangeFilterDto)

Range filter configuration defining numeric or date boundaries for query results.

searchStringstring

Search string representing the user query applied across designated target fields.

searchTargetFieldsArray of strings

List of target field names that should be queried for search string matching.

search_afterArray of strings

Search after values used to continue pagination without relying on offsets.

sortDescriptorsArray of objects(SortDescriptor)

List of sort descriptors defining multi level sort behaviors for query responses.

sortFieldstring

Field name used to sort query results within the returned data.

sortOrderstring

Sort order specifying ascending or descending direction for query results.

termFieldobject(TermFieldDto)

Term field filter configuration specifying exact match criteria for a field.

termsobject

Filter terms represented as key value pairs applied to refine result sets.

{
  "excludeFilters": {
    "property1": [ … ],
    "property2": [ … ]
  },
  "exists": "string",
  "fields": [
    "string"
  ],
  "filters": {
    "property1": [ … ],
    "property2": [ … ]
  },
  "groupBy": "string",
  "matchFields": [
    { … }
  ],
  "multiSortFields": [
    "string"
  ],
  "mustHaveFields": [
    "string"
  ],
  "mustNotHaveFields": [
    "string"
  ],
  "mustNotMatchField": [
    { … }
  ],
  "page": 0,
  "pageByDate": {
    "key": "string",
    "value": "string"
  },
  "pageSize": 0,
  "queryStringOrFilter": {
    "filterTerms": { … },
    "searchString": "string"
  },
  "rangeDateFilter": {
    "field": "string",
    "gte": 0,
    "lt": 0,
    "lte": 0
  },
  "rangeFilter": {
    "field": "string",
    "gte": 0,
    "lt": 0,
    "lte": 0
  },
  "searchString": "string",
  "searchTargetFields": [
    "string"
  ],
  "search_after": [
    "string"
  ],
  "sortDescriptors": [
    null
  ],
  "sortField": "string",
  "sortOrder": "string",
  "termField": {
    "field": "string",
    "value": "string"
  },
  "terms": {
    "property1": [ … ],
    "property2": [ … ]
  }
}

Responses

successful operation

Body
dataArray of objects(WifiCallingServiceProfileDto)

List of data items returned by the query.

errorMessagestring

Error message if the request failed.

errorsArray of objects(Error)

List of detailed errors if the request encountered issues.

fieldsArray of stringsunique

Set of field names included in the response.

objectIdstring

Unique identifier of the object being queried.

pageinteger(int32)

Current page number in the paginated results.

requestIdstring

Unique identifier for tracking this request.

subsequentQueriesArray of objects(SubsequentQuery)

List of subsequent query options for drilling down into results.

totalCountinteger(int64)

Total number of results matching the query.

Response
{
  "data": [
    { … }
  ],
  "errorMessage": "string",
  "errors": [
    { … }
  ],
  "fields": [
    "string"
  ],
  "objectId": "string",
  "page": 0,
  "requestId": "string",
  "subsequentQueries": [
    { … }
  ],
  "totalCount": 0
}

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

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

AP SNMP Agents

Operations