
Cisco Evolved Programmable Network Manager API
Evolved Programmable Network Manager API Documentation

# GET MerakiAccessPoints

Represents basic information about Meraki access points.

Since Product Version: 3.6

- Jump To

- v1
- v2
- v3
- v4

API version v1 is deprecated

This API version has been deprecated. It will be removed in a future release of the product. Please develop new clients using the latest API version. Please modify your existing clients to use a later API version.

Resource unavailable for this API version

This resource was introduced in API version 4.

Resource unavailable for this API version

This resource was introduced in API version 4.

Resource unavailable for this API version

This resource was introduced in API version 4.

### 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/MerakiAccessPoints

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 access point 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.
meshStatus MerakiMeshStateEnum | Whether the AP is currently acting as a gateway or a repeater. Allowed values GATEWAY REPEATER
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. Allowed values 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://10.64.88.203/webacs/api/v4/data/MerakiAccessPoints/15

    <?xml version="1.0" ?>
    <queryResponse type="MerakiAccessPoints" responseType="getEntity" requestUrl="https://10.64.88.203/webacs/api/v4/data/MerakiAccessPoints/15" rootUrl="https://10.64.88.203/webacs/api/v4/data">
      <entity dtoType="merakiAccessPointsDTO" type="MerakiAccessPoints" url="https://10.64.88.203/webacs/api/v4/data/MerakiAccessPoints/15">
        <merakiAccessPointsDTO displayName="String value" id="15" uuid="String value">
          <clientCount>1</clientCount>
          <contactedAt>1986-07-24T00:00:00+05:30</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>
          <meshStatus>GATEWAY</meshStatus>
          <networkName>String value</networkName>
          <productFamily>String value</productFamily>
          <reachability>UNREACHABLE</reachability>
          <serialNumber>String value</serialNumber>
        </merakiAccessPointsDTO>
      </entity>
    </queryResponse>

### Sample JSON Payload

https://10.64.88.203/webacs/api/v4/data/MerakiAccessPoints/15.json

    {
      "queryResponse" : {
        "@type" : "MerakiAccessPoints",
        "@requestUrl" : "https://10.64.88.203/webacs/api/v4/data/MerakiAccessPoints/15",
        "@responseType" : "getEntity",
        "@rootUrl" : "https://10.64.88.203/webacs/api/v4/data",
        "entity" : [ {
          "@dtoType" : "merakiAccessPointsDTO",
          "@type" : "MerakiAccessPoints",
          "@url" : "https://10.64.88.203/webacs/api/v4/data/MerakiAccessPoints/15",
          "merakiAccessPointsDTO" : {
            "@displayName" : "String value",
            "@id" : 15,
            "@uuid" : "String value",
            "clientCount" : 1,
            "contactedAt" : "1986-07-23T18:30:00.000Z",
            "dashboardAddress" : {
              "address" : "192.168.115.243"
            },
            "deviceName" : "String value",
            "deviceType" : "String value",
            "ipAddress" : {
              "address" : "192.168.115.243"
            },
            "macAddress" : {
              "octets" : "000a959d6816"
            },
            "meshStatus" : "GATEWAY",
            "networkName" : "String value",
            "productFamily" : "String value",
            "reachability" : "UNREACHABLE",
            "serialNumber" : "String value"
          }
        } ]
      }
    }