Get Venue AP Models

View MSP

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

Operations

View VLAN Pool Profiles

Manage VLAN Pool Profile.

Operations

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 Portal Service Profiles

Manage Portal Service Profile.

Operations

View Client Isolation Profiles

Manage Client Isolation Profile.

Operations

View Venue Topology

View Venue Topology information.

Operations

Quality of Service

View the information of Quality of Service

Operations

Edge SD-LAN Status

Edge SD-LAN Status API

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

Get Venue Rogue APs

Request

Get the list of rogue APs located in this venue.

Path

venueIdstringrequired

Venue ID

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(RogueApDto)

errorMessagestring

subsequentQueriesArray of objects(SubsequentQuery)

Response

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

Get Venues

Request

Return a list of venue records.

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

namestring

idstring

descriptionstring

citystring

countrystring

countryCodestring

dpGroupIdstringread-only

latitudestring

longitudestring

crtTimestring

lastUpdTimestring

typestring

tenantIdstring

timeZonestring

notesstring

meshobject(MeshData)

switchProfileNamestring

switchProfileIdstring

dhcpobject(DhcpData)

wifiFirmwareVersionstring

rogueDetectionobject(RogueDetectionData)

syslogServerobject(SyslogServerData)

isTemplateboolean

currentApFirmwaresArray of objects(ApModelFirmwareMappingData)

isApFirmwareUpToDateboolean

lastApFirmwareUpdatestring

nextApFirmwareSchedulesArray of objects(ApFirmwareScheduleData)

addressLinestring

Response

{
  "name": "string",
  "id": "string",
  "description": "string",
  "city": "string",
  "country": "string",
  "countryCode": "string",
  "dpGroupId": "string",
  "latitude": "string",
  "longitude": "string",
  "crtTime": "string",
  "lastUpdTime": "string",
  "type": "string",
  "tenantId": "string",
  "timeZone": "string",
  "notes": "string",
  "mesh": {
    "enabled": true
  },
  "switchProfileName": "string",
  "switchProfileId": "string",
  "dhcp": {
    "enabled": true,
    "mode": "string"
  },
  "wifiFirmwareVersion": "string",
  "rogueDetection": {
    "policyId": "string",
    "policyName": "string",
    "enabled": true
  },
  "syslogServer": {
    "policyId": "string",
    "policyName": "string",
    "enabled": true
  },
  "isTemplate": true,
  "currentApFirmwares": [
    { … }
  ],
  "isApFirmwareUpToDate": true,
  "lastApFirmwareUpdate": "string",
  "nextApFirmwareSchedules": [
    { … }
  ],
  "addressLine": "string"
}