Cisco Prime Infrastructure API
Prime Infrastructure API Documentation

GET groups/sites

Resource Information

Rate Limiting?

Yes

Sorting?

No

Paging?

No

Filtering?

No

Response Formats

xml

json

User Group

NBI Read

HTTP Methods

GET

Returns list of Locations, including the count of alarms of each severity for each group. Also includes counts of devices, APs and Clients associated with the Location and also location information regarding the location. This service was formerly known as "Site Groups."

Resource URL

/webacs/api/v1/op/groups/sites

Since : 2.0

Sample Payloads

Sample payloads are for information only. They are automatically generated and the values included may not be representative of actual valid data values.

Sample XML Response Payload

https://szier-m8-106.cisco.com/webacs/api/v1/op/groups/sites

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<mgmtResponse rootUrl="https://szier-m8-106.cisco.com/webacs/api/v1/op/" requestUrl="https://szier-m8-106.cisco.com/webacs/api/v1/op/groups/sites" responseType="operation">
    <siteOpDTO>
        <apCount>1</apCount>
        <clearedAlarms>1</clearedAlarms>
        <clientCount>1</clientCount>
        <criticalAlarms>1</criticalAlarms>
        <deviceCount>1</deviceCount>
        <groupId>2</groupId>
        <groupName>String value</groupName>
        <informationAlarms>1</informationAlarms>
        <latitude>15.0</latitude>
        <locationAddress>String value</locationAddress>
        <longitude>15.0</longitude>
        <majorAlarms>1</majorAlarms>
        <minorAlarms>1</minorAlarms>
        <name>String value</name>
        <siteType>String value</siteType>
        <warningAlarms>1</warningAlarms>
    </siteOpDTO>
</mgmtResponse>

Sample JSON Response Payload

https://szier-m8-106.cisco.com/webacs/api/v1/op/groups/sites.json

{
  "mgmtResponse" : {
    "@rootUrl" : "https : \/\/szier-m8-106.cisco.com\/webacs\/api\/v1\/op\/",
    "@requestUrl" : "https : \/\/szier-m8-106.cisco.com\/webacs\/api\/v1\/op\/groups\/sites",
    "@responseType" : "operation",
    "siteOpDTO" : {
      "apCount" : 1,
      "clearedAlarms" : 1,
      "clientCount" : 1,
      "criticalAlarms" : 1,
      "deviceCount" : 1,
      "groupId" : 2,
      "groupName" : "String value",
      "informationAlarms" : 1,
      "latitude" : 15,
      "locationAddress" : "String value",
      "longitude" : 15,
      "majorAlarms" : 1,
      "minorAlarms" : 1,
      "name" : "String value",
      "siteType" : "String value",
      "warningAlarms" : 1
    }
  }
}