username

Y

—

String

pathReplace

Username of the user.

rolename

Y

—

String

pathReplace

Role name to be added to the user.

username

Y

—

String

pathReplace

Username of user.

rolename

Y

—

String

pathReplace

Role name that needs to be deleted from this user.

___username

Y

—

string

body

Username of the user.

password

Y

—

string

body

Password of the user.

firstname

N

—

string

body

First name of the user.

lastname

N

—

string

body

Last name of the user.

roles

N

—

text

body

Roles for this user.

developerkey

N

—

string

body

CMX API Developer Key.

lastlogin

N

—

text

body

User's last login.

username

Y

—

String

pathReplace

Username name of the user

___username

Y

—

string

body

Username of the user.

password

Y

—

string

body

Password of the user.

firstname

N

—

string

body

First name of the user.

lastname

N

—

string

body

Last name of the user.

roles

N

—

text

body

Roles assigned to this user.

developerkey

N

—

string

body

CMX API Developer Key.

lastlogin

N

—

text

body

User's Last Login.

username

Y

—

String

pathReplace

Username

username

Y

—

String

pathReplace

Username.

name

Y

—

String

pathReplace

Campus Name .

objectVersion

N

—

number

body

objectVersion

name

Y

—

string

body

Name of the campus. This value should be unique.

dimension

N

—

text

body

Dimension

image

N

—

text

body

image

buildingList

N

—

text

body

List of buildings inside the campus.

aesUid

N

—

number

body

aesUid

aesUidString

N

—

string

body

aesUidString

members

N

—

text

body

members

name

Y

—

String

pathReplace

Campus Name

Cisco CMX Release 10.4

This API is introduced.

Cisco CMX Release 10.4

This API is introduced.

name

Y

—

String

pathReplace

Building Name

Cisco CMX Release 10.4

This API is introduced.

Cisco CMX Release 10.4

This API is introduced.

campusName

Y

—

String

pathReplace

Campus Name

campusName

Y

—

String

pathReplace

Campus Name.

buildingName

Y

—

String

pathReplace

Building Name.

campusName

Y

—

String

pathReplace

Campus Name.

buildingName

Y

—

String

pathReplace

Building Name.

floorName

Y

—

String

pathReplace

Floor Name.

campusName

Y

—

String

pathReplace

Campus Name.

buildingName

Y

—

String

pathReplace

Building Name.

floorName

Y

—

String

pathReplace

Floor Name.

imageName

Y

—

String

pathReplace

Image Name.

component

Y

—

String

pathReplace

The component.

key

N

—

String

pathReplace

The key to retrieve. If not set, retrieves all keys for the given component.

component

Y

—

String

pathReplace

The component.

key

Y

—

String

pathReplace

The key.

String

Y

—

string

body

Value.

name

Y

—

String

pathReplace

Notification Name.

name

Y

—

String

pathReplace

Notification Name.

userId

Y

—

string

body

User ID.

rules

Y

—

text

body

List of rules.

subscribers

Y

—

text

body

Subscribers

notificationType

Y

—

enumerated

body

Choose one of the following notification types:

• Any

• Absence

• AreaChange

• Association

• BatteryLife

• Chokepoint

• Containment

• Emergency

• Movement

• Presence

• LocationUpdate

• Zone

• Location

• ServiceStatus

• NetworkDesignChanged

• CpuUsage

• MemoryUsage

• DiskUsage

• BeaconMovement

• BeaconAbsence

• Update

• InOut

• PasserbyDetected

• PasserbyBecameVisitor

• VisitorWentAway

• SiteEntryChanged

enabled

N

—

enumerated

body

enabled

• true

• false

enableMacScrambling

N

—

enumerated

body

enableMacScrambling

• true

• false

name

Y

—

String

pathReplace

Notification Name.

name

Y

—

String

pathReplace

Notification Name.

severity

Y

—

enumerated

body

Choose one of the following severity levels:

• Critical

• Major

• Minor

• Warning

• Info

• Cleared

userId

Y

—

string

body

User ID.

rules

Y

—

text

body

List of rules.

subscribers

Y

—

text

body

Subscribers

notificationType

Y

—

enumerated

body

Choose one of the following notification types:

• Any

• Absence

• AreaChange

• Association

• BatteryLife

• Chokepoint

• Containment

• Emergency

• Movement

• Presence

• LocationUpdate

• Zone

• Location

• ServiceStatus

• NetworkDesignChanged

• CpuUsage

• MemoryUsage

• DiskUsage

• BeaconMovement

• BeaconAbsence

• Update

• InOut

• PasserbyDetected

• PasserbyBecameVisitor

• VisitorWentAway

• SiteEntryChanged

enabled

N

—

enumerated

body

enabled

• true

• false

enableMacScrambling

N

—

enumerated

body

enableMacScrambling

• true

• false

name

Y

—

String

pathReplace

Notification Name.

name

Y

—

String

pathReplace

Notification Name.

action

Y

—

String

pathReplace

Enable/Disable

startTime

Y

—

Number

query

Specifies the start time in milliseconds.

endTime

Y

—

Number

query

Specifies the end time in milliseconds.

startTime

Y

—

Number

query

Specifies the start time in milliseconds.

endTime

Y

—

Number

query

Specifies the end time in milliseconds.

key

Y

—

String

pathReplace

Alert Hashkey which could be obtained by calling /config/v1/alerts.

startTime

Y

—

Number

query

Specifies the start time in milliseconds.

endTime

Y

—

Number

query

Specifies the end time in milliseconds.

key

Y

—

String

pathReplace

Alert Hashkey which could be obtained by calling /config/v1/alerts.

mac

Y

—

String

pathReplace

Access point MAC address.

userid

Y

—

String

pathReplace

The user ID.

component

Y

—

String

pathReplace

The component.

key

N

—

String

pathReplace

The key to retrieve. If not set, retrieves all keys for the given component.

userid

Y

—

String

pathReplace

The user ID.

component

Y

—

String

pathReplace

The component.

key

Y

—

String

pathReplace

The key.

json

N

—

String

query

Whether the data passed is JSON - if set, this will validate the data and reject malformed JSON Allowed values/formats: true or false.

String

Y

—

string

body

Value

ipAddress

Y

—

String

pathReplace

IP Address.

name

Y

—

string

body

Name of the Wireless LAN controller.

ipAddress

Y

—

string

body

IP address of the Wireless LAN controller.

readOnlyComm

Y

—

string

body

SNMP Read Community.

writeComm

Y

—

string

body

SNMP Write Community.

snmpVersion

N

—

number

body

SNMP Version.

version

Y

—

string

body

Software version of the WLC Controller.

userName

Y

—

string

body

User name for the telnet connection.

authType

Y

—

number

body

SNMP v3 Auth Type.

authPassword

N

—

string

body

Authentication Password.

privType

N

—

number

body

Privacy Type.

privPassword

N

—

string

body

Password.

macAddress

N

—

string

body

MAC Address.

sysUpTime

N

—

number

body

System Up time.

unauthenticatedConnection

N

—

enumerated

body

Authentication to connect to the WLC Controller.

• true

• false

applicableServices

Y

—

array

body

Services to subscribe to the controller.

aesUId

Y

—

number

body

Cisco Prime Infrastructure generated unique ID. If not generated by Cisco Prime Infrastructure, please use a unique value.

objectVersion

N

—

number

body

Object version.

tagNotificationInterval

N

—

number

body

Tag notification interval.

wlanConfigList

N

—

text

body

WLC Controller Configuration list.

deviceVersion

N

—

string

body

Version of the device.

type

N

—

enumerated

body

type

• WLC

• NGWC

enablePassword

N

—

string

body

enablePassword

peerMode

N

—

enumerated

body

peerMode

• true

• false

members

N

—

text

body

Members.

validFrom

N

—

String

query

Start date of range Allowed values/formats: yyyy-mm-dd hh:mm:ss

validTo

N

—

String

query

End date of range Allowed values/formats: yyyy-mm-dd hh:mm:ss

validFrom

N

—

String

query

Start date of range Allowed values/formats: yyyy-mm-dd hh:mm:ss.

validTo

N

—

String

query

End date of range Allowed values/formats: yyyy-mm-dd hh:mm:ss.

pathSegments

N

—

String

pathReplace

Full path to the element or element id.

validDate

N

—

String

query

Show elements valid at given date (yyyy-mm-dd HH:mm:ss) Allowed values/formats: yyyy-mm-dd HH:mm:ss.

level

N

—

String

query

Level name (SUPERZONE, FLOOR, AP, POI, or ZONE) Allowed values/formats: SUPERZONE FLOOR AP ZONE POI.

Cisco CMX Release 10.4

This API is introduced.

pathSegments

N

—

String

pathReplace

Full path to the element or element ID.

validDate

N

—

String

query

Show elements valid from given date (yyyy-mm-dd HH:mm:ss) Allowed values/formats: yyyy-mm-dd HH:mm:ss.

level

N

—

String

query

Level name (SUPERZONE, FLOOR, AP, POI, or ZONE) Allowed values/formats: SUPERZONE FLOOR AP ZONE POI.

Cisco CMX Release 10.4

This API is introduced.

clusterId

Y

1

String

pathReplace

clusterId (default 1)

clusterId

Y

1

Number

pathReplace

clusterId (default 1)

clusterId

Y

1

String

pathReplace

clusterId (default 1)

zoneHierarchy

Y

array

body

List of exact zone hierarchy separated by /, i.e. Campus/Building/Floor/Zone. (including spaces, if any of the campus / building /floor /zone has spaces in the name) Ensure zones hierarchy are nested within the square brackets [ ] to be considered as list, otherwise this operation would fail For specifying single zone, ["Campus/Building/Floor/Zone1"] For specifying multiple zones, ["Campus/Building/Floor/Zone1", "Campus/Building/Floor/Zone2"]

zoneIds

N

array

body

List of zoneids,

for e.g. single zone as [391] multiple zones as [391,392]

zoneDetails

N

text

body

Populated by API after parsing zoneHierarchy or zoneIds input

totalZones

N

number

body

Total registered zones, Populated by API after parsing zoneHierarchy or zoneIds input

debug

N

false

enumerated

body

debug flag to enable recording macaddresses for registered zones

• true

• false

clusterId

Y

1

String

pathReplace

clusterId (default 1)

zoneHierarchy

Y

array

body

List of exact zone hierarchy separated by /, i.e. Campus/Building/Floor/Zone. (including spaces, if any of the campus / building /floor /zone has spaces in the name)</p> Ensure zones hierarchy are nested within the square brackets [ ] to be considered as list, otherwise this operation would fail</p> For specifying single zone, ["Campus/Building/Floor/Zone1"]</p> For specifying multiple zones, ["Campus/Building/Floor/Zone1", "Campus/Building/Floor/Zone2"]</p>

zoneIds

N

array

body

List of zoneids

for e.g. single zone as [391] multiple zones as [391,392]

zoneDetails

N

text

body

Populated by API after parsing zoneHierarchy or zoneIds input

totalZones

N

number

body

Total registered zones, Populated by API after parsing zoneHierarchy or zoneIds input

debug

N

false

enumerated

body

debug flag to enable recording macaddresses for registered zones

• true

• false

Cisco CMX Release 10.4

This API is introduced.