Cisco Prime Infrastructure API
Prime Infrastructure API Documentation

GET MerakiDevices

Represents basic information about Meraki devices. The API resource does not include Meraki access points or Meraki dashboard devices.

Since Product Version: 3.6

Resource Information

Rate Limiting?

Yes

Sorting?

Yes

Paging?

Yes

Filtering?

Yes

Group Filtering?

Yes

Aggregation?

No

Response Formats

xml

json

User Group

NBI Read

HTTP Methods

GET

Resource URL

/webacs/api/v4/data/MerakiDevices

To filter entities based on device groups, use Group Based Filtering as documented on the Filtering page on the Home page. Example: ?.group=myrouters

Response Parameters

Attribute Description

clientCount int

The number of clients currently associated with the device.

contactedAt Date

The last time the device contacted the Cloud Controller.

dashboardAddress InetAddress

The Meraki dashboard address.

deviceName String

The name of the device.

deviceType String

The type of the device.

ipAddress InetAddress

The ip address of the device.

macAddress MacAddress

Device MAC address.

networkName String

The name of the network this device is in.

productFamily String

The product family of this device.

reachability MerakiReachabilityStateEnum

The status of the device's connection to the Meraki Cloud.

  • UNREACHABLE
  • REACHABLE

serialNumber String

Device serial number.

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 Payload

https://localhost/webacs/api/v4/data/MerakiDevices/15

<?xml version="1.0" ?>
<queryResponse type="MerakiDevices" responseType="getEntity" requestUrl="https://localhost/webacs/api/v4/data/MerakiDevices/15" rootUrl="https://localhost/webacs/api/v4/data">
  <entity dtoType="merakiDevicesDTO" type="MerakiDevices" url="https://localhost/webacs/api/v4/data/MerakiDevices/15">
    <merakiDevicesDTO displayName="String value" id="15" uuid="String value">
      <clientCount>1</clientCount>
      <contactedAt>1986-07-24T00:00:00Z</contactedAt>
      <dashboardAddress>
        <address>192.168.115.243</address>
      </dashboardAddress>
      <deviceName>String value</deviceName>
      <deviceType>String value</deviceType>
      <ipAddress>
        <address>192.168.115.243</address>
      </ipAddress>
      <macAddress>
        <octets>000a959d6816</octets>
      </macAddress>
      <networkName>String value</networkName>
      <productFamily>String value</productFamily>
      <reachability>UNREACHABLE</reachability>
      <serialNumber>String value</serialNumber>
    </merakiDevicesDTO>
  </entity>
</queryResponse>

Sample JSON Payload

https://localhost/webacs/api/v4/data/MerakiDevices/15.json

{
  "queryResponse" : {
    "@type" : "MerakiDevices",
    "@requestUrl" : "https://localhost/webacs/api/v4/data/MerakiDevices/15",
    "@responseType" : "getEntity",
    "@rootUrl" : "https://localhost/webacs/api/v4/data",
    "entity" : [ {
      "@dtoType" : "merakiDevicesDTO",
      "@type" : "MerakiDevices",
      "@url" : "https://localhost/webacs/api/v4/data/MerakiDevices/15",
      "merakiDevicesDTO" : {
        "@displayName" : "String value",
        "@id" : 15,
        "@uuid" : "String value",
        "clientCount" : 1,
        "contactedAt" : "1986-07-24T00:00:00.000Z",
        "dashboardAddress" : {
          "address" : "192.168.115.243"
        },
        "deviceName" : "String value",
        "deviceType" : "String value",
        "ipAddress" : {
          "address" : "192.168.115.243"
        },
        "macAddress" : {
          "octets" : "000a959d6816"
        },
        "networkName" : "String value",
        "productFamily" : "String value",
        "reachability" : "UNREACHABLE",
        "serialNumber" : "String value"
      }
    } ]
  }
}