Cisco Meraki Wireless Controller API

The wirelessController API from Cisco Meraki — 15 operation(s) for wirelesscontroller.

OpenAPI Specification

cisco-meraki-wirelesscontroller-api-openapi.yml Raw ↑
openapi: 3.0.1
info:
  title: Meraki Dashboard API — wirelessController
  description: 'A RESTful API to programmatically manage and monitor Cisco Meraki networks at scale.


    > Date: 05 August, 2026

    >

    > [Recent Updates](https://meraki.io/whats-new/)


    ---


    [API Documentation](https://meraki.io/api)


    [Community Support](https://meraki.io/community)


    [Meraki Homepage](https://www.meraki.com)

    '
  contact:
    name: Meraki Developer Community
    url: https://meraki.io/community
  version: 1.73.0
  x-provenance:
    method: harvested
    authored_by: Cisco Meraki
    harvested_by: API Evangelist
    harvested_on: '2026-08-19'
    first_party: true
    note: Published by Cisco. Retrieved unmodified except for this x-provenance block.
    provider_published: true
    derived_view: Per-first-tag view of the source document, tag 'wirelessController'. Operations and schemas are the provider's,
      unmodified.
  x-evidence:
  - type: source
    url: https://github.com/meraki/openapi/blob/master/openapi/spec3.json
  - type: raw
    url: https://raw.githubusercontent.com/meraki/openapi/master/openapi/spec3.json
  - type: alternate
    url: https://api.meraki.com/api/v1/openapiSpec
servers:
- url: https://api.meraki.com/{basePath}
  variables:
    basePath:
      default: api/v1
security:
- meraki_api_key: []
- bearerAuth: []
tags:
- name: wirelessController
paths:
  /organizations/{organizationId}/wirelessController/availabilities/changeHistory:
    get:
      description: List connectivity data of wireless LAN controllers in an organization. If it is HA setup, then only returns
        active WLC data start from switchover
      operationId: getOrganizationWirelessControllerAvailabilitiesChangeHistory
      parameters:
      - name: organizationId
        in: path
        description: Organization ID
        schema:
          type: string
        required: true
      - name: serials
        in: query
        description: Optional parameter to filter wireless LAN controller by its cloud ID. This filter uses multiple exact
          matches.
        schema:
          type: array
          items:
            type: string
      - name: t0
        in: query
        description: The beginning of the timespan for the data. The maximum lookback period is 31 days from today.
        schema:
          type: string
      - name: t1
        in: query
        description: The end of the timespan for the data. t1 can be a maximum of 31 days after t0.
        schema:
          type: string
      - name: timespan
        in: query
        description: The timespan for which the information will be fetched. If specifying timespan, do not specify parameters
          t0 and t1. The value must be in seconds and be less than or equal to 31 days. The default is 7 days.
        schema:
          type: number
          format: float
          maximum: 2678400
      - name: perPage
        in: query
        description: The number of entries per page returned. Acceptable range is 3 - 1000. Default is 1000.
        schema:
          type: integer
      - name: startingAfter
        in: query
        description: A token used by the server to indicate the start of the page. Often this is a timestamp or an ID but
          it is not limited to those. This parameter should not be defined by client applications. The link for the first,
          last, prev, or next page in the HTTP Link header should define it.
        schema:
          type: string
      - name: endingBefore
        in: query
        description: A token used by the server to indicate the end of the page. Often this is a timestamp or an ID but it
          is not limited to those. This parameter should not be defined by client applications. The link for the first, last,
          prev, or next page in the HTTP Link header should define it.
        schema:
          type: string
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                properties:
                  items:
                    type: array
                    items:
                      type: object
                      properties:
                        serial:
                          type: string
                          description: Wireless LAN controller cloud ID
                        changes:
                          type: array
                          items:
                            type: object
                            properties:
                              startTs:
                                type: string
                                format: date-time
                                description: The start time(UTC seconds) of the wireless LAN controller connectivity status
                                  change
                              endTs:
                                type: string
                                description: The end time(UTC seconds) of the wireless LAN controller connectivity status
                                  change. This attribute is set to be null by default if there's no need to assign.
                              status:
                                type: string
                                description: The wireless LAN controller connectivity status
                          description: Connectivity information of a wireless LAN controller
                    description: Wireless LAN controller connectivity information
                  meta:
                    type: object
                    properties:
                      counts:
                        type: object
                        properties:
                          items:
                            type: object
                            properties:
                              total:
                                type: integer
                                description: The total number of items in the dataset
                              remaining:
                                type: integer
                                description: The number of items in the dataset that are available on subsequent pages
                            description: Counts relating to the paginated items
                        description: Counts relating to the paginated dataset
                    description: Metadata relevant to the paginated dataset
              example:
                items:
                - serial: Q234-ABCD-5678
                  changes:
                  - startTs: '2020-01-01T00:00:00Z'
                    endTs: 'null'
                    status: online
                meta:
                  counts:
                    items:
                      total: 10
                      remaining: 0
          headers:
            Link:
              schema:
                type: string
              description: A comma-separated list of first, last, prev, and next relative links used for subsequent paginated
                requests.
      security:
      - oauth2:
        - wireless:telemetry:read
      summary: List connectivity data of wireless LAN controllers in an organization
      tags:
      - wirelessController
      - monitor
      - availabilities
      - changeHistory
  /organizations/{organizationId}/wirelessController/clients/overview/history/byDevice/byInterval:
    get:
      description: List wireless client counts of wireless LAN controllers over time in an organization
      operationId: getOrganizationWirelessControllerClientsOverviewHistoryByDeviceByInterval
      parameters:
      - name: organizationId
        in: path
        description: Organization ID
        schema:
          type: string
        required: true
      - name: networkIds
        in: query
        description: Optional parameter to filter wireless LAN controllers by network ID. This filter uses multiple exact
          matches.
        schema:
          type: array
          items:
            type: string
      - name: serials
        in: query
        description: Optional parameter to filter wireless LAN controller by its cloud ID. This filter uses multiple exact
          matches.
        schema:
          type: array
          items:
            type: string
      - name: t0
        in: query
        description: The beginning of the timespan for the data. The maximum lookback period is 31 days from today.
        schema:
          type: string
      - name: t1
        in: query
        description: The end of the timespan for the data. t1 can be a maximum of 31 days after t0.
        schema:
          type: string
      - name: timespan
        in: query
        description: The timespan for which the information will be fetched. If specifying timespan, do not specify parameters
          t0 and t1. The value must be in seconds and be less than or equal to 31 days. The default is 7 days.
        schema:
          type: number
          format: float
          maximum: 2678400
      - name: perPage
        in: query
        description: The number of entries per page returned. Acceptable range is 3 - 1000. Default is 1000.
        schema:
          type: integer
      - name: startingAfter
        in: query
        description: A token used by the server to indicate the start of the page. Often this is a timestamp or an ID but
          it is not limited to those. This parameter should not be defined by client applications. The link for the first,
          last, prev, or next page in the HTTP Link header should define it.
        schema:
          type: string
      - name: endingBefore
        in: query
        description: A token used by the server to indicate the end of the page. Often this is a timestamp or an ID but it
          is not limited to those. This parameter should not be defined by client applications. The link for the first, last,
          prev, or next page in the HTTP Link header should define it.
        schema:
          type: string
      - name: resolution
        in: query
        description: 'The time resolution in seconds for returned data. The valid resolutions are: 300, 600, 1200, 3600, 14400,
          86400. The default is 86400.'
        schema:
          type: integer
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                properties:
                  items:
                    type: array
                    items:
                      type: object
                      properties:
                        serial:
                          type: string
                          description: Wireless LAN controller cloud ID
                        network:
                          type: object
                          properties:
                            id:
                              type: string
                              description: Wireless LAN controller network ID
                          description: Wireless LAN controller network
                        readings:
                          type: array
                          items:
                            type: object
                            properties:
                              startTs:
                                type: string
                                format: date-time
                                description: The start time of the query range
                              endTs:
                                type: string
                                format: date-time
                                description: The end time of the query range
                              counts:
                                type: object
                                properties:
                                  byStatus:
                                    type: object
                                    properties:
                                      online:
                                        type: integer
                                        description: Number of connected clients
                                    description: Client counts by its status
                                description: Client counts
                          description: Overview history of a wireless LAN controller
                    description: Overview history of wireless LAN controllers
                  meta:
                    type: object
                    properties:
                      counts:
                        type: object
                        properties:
                          items:
                            type: object
                            properties:
                              total:
                                type: integer
                                description: The total number of items in the dataset
                              remaining:
                                type: integer
                                description: The number of items in the dataset that are available on subsequent pages
                            description: Counts relating to the paginated items
                        description: Counts relating to the paginated dataset
                    description: Metadata relevant to the paginated dataset
              example:
                items:
                - serial: Q234-ABCD-5678
                  network:
                    id: N_24329156
                  readings:
                  - startTs: '2020-01-01T00:00:00Z'
                    endTs: '2020-01-01T01:00:00Z'
                    counts:
                      byStatus:
                        online: 1
                meta:
                  counts:
                    items:
                      total: 10
                      remaining: 0
          headers:
            Link:
              schema:
                type: string
              description: A comma-separated list of first, last, prev, and next relative links used for subsequent paginated
                requests.
      summary: List wireless client counts of wireless LAN controllers over time in an organization
      tags:
      - wirelessController
      - monitor
      - clients
      - overview
      - history
      - byDevice
      - byInterval
  /organizations/{organizationId}/wirelessController/connections:
    get:
      description: List all access points associated with wireless LAN controllers in an organization
      operationId: getOrganizationWirelessControllerConnections
      parameters:
      - name: organizationId
        in: path
        description: Organization ID
        schema:
          type: string
        required: true
      - name: networkIds
        in: query
        description: Optional parameter to filter access points by network ID. This filter uses multiple exact matches.
        schema:
          type: array
          items:
            type: string
      - name: controllerSerials
        in: query
        description: Optional parameter to filter access points by its controller cloud ID. This filter uses multiple exact
          matches.
        schema:
          type: array
          items:
            type: string
      - name: perPage
        in: query
        description: The number of entries per page returned. Acceptable range is 3 - 1000. Default is 1000.
        schema:
          type: integer
      - name: startingAfter
        in: query
        description: A token used by the server to indicate the start of the page. Often this is a timestamp or an ID but
          it is not limited to those. This parameter should not be defined by client applications. The link for the first,
          last, prev, or next page in the HTTP Link header should define it.
        schema:
          type: string
      - name: endingBefore
        in: query
        description: A token used by the server to indicate the end of the page. Often this is a timestamp or an ID but it
          is not limited to those. This parameter should not be defined by client applications. The link for the first, last,
          prev, or next page in the HTTP Link header should define it.
        schema:
          type: string
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                properties:
                  items:
                    type: array
                    items:
                      type: object
                      properties:
                        serial:
                          type: string
                          description: Access points cloud ID
                        controller:
                          type: object
                          properties:
                            serial:
                              type: string
                              description: Associated wireless LAN controller cloud ID
                          description: Associated wireless LAN controller
                        network:
                          type: object
                          properties:
                            id:
                              type: string
                              description: Access points network ID
                            url:
                              type: string
                              description: Access points network URL
                            name:
                              type: string
                              description: Access points network name
                          description: Access points network
                    description: Access points associated with Wireless LAN controllers
                  meta:
                    type: object
                    properties:
                      counts:
                        type: object
                        properties:
                          items:
                            type: object
                            properties:
                              total:
                                type: integer
                                description: The total number of items in the dataset
                              remaining:
                                type: integer
                                description: The number of items in the dataset that are available on subsequent pages
                            description: Counts relating to the paginated items
                        description: Counts relating to the paginated dataset
                    description: Metadata relevant to the paginated dataset
              example:
                items:
                - serial: Q234-ABCD-5678
                  controller:
                    serial: Q234-ABCD-5678
                  network:
                    id: N_24329156
                    url: https://network/url
                    name: Network1
                meta:
                  counts:
                    items:
                      total: 10
                      remaining: 0
          headers:
            Link:
              schema:
                type: string
              description: A comma-separated list of first, last, prev, and next relative links used for subsequent paginated
                requests.
      summary: List all access points associated with wireless LAN controllers in an organization
      tags:
      - wirelessController
      - monitor
      - connections
  /organizations/{organizationId}/wirelessController/devices/interfaces/l2/byDevice:
    get:
      description: List wireless LAN controller layer 2 interfaces in an organization
      operationId: getOrganizationWirelessControllerDevicesInterfacesL2ByDevice
      parameters:
      - name: organizationId
        in: path
        description: Organization ID
        schema:
          type: string
        required: true
      - name: serials
        in: query
        description: Optional parameter to filter wireless LAN controller by its cloud ID. This filter uses multiple exact
          matches.
        schema:
          type: array
          items:
            type: string
      - name: t0
        in: query
        description: The beginning of the timespan for the data. The maximum lookback period is 31 days from today.
        schema:
          type: string
      - name: t1
        in: query
        description: The end of the timespan for the data. t1 can be a maximum of 31 days after t0.
        schema:
          type: string
      - name: timespan
        in: query
        description: The timespan for which the information will be fetched. If specifying timespan, do not specify parameters
          t0 and t1. The value must be in seconds and be less than or equal to 31 days. The default is 7 days.
        schema:
          type: number
          format: float
          maximum: 2678400
      - name: perPage
        in: query
        description: The number of entries per page returned. Acceptable range is 3 - 1000. Default is 1000.
        schema:
          type: integer
      - name: startingAfter
        in: query
        description: A token used by the server to indicate the start of the page. Often this is a timestamp or an ID but
          it is not limited to those. This parameter should not be defined by client applications. The link for the first,
          last, prev, or next page in the HTTP Link header should define it.
        schema:
          type: string
      - name: endingBefore
        in: query
        description: A token used by the server to indicate the end of the page. Often this is a timestamp or an ID but it
          is not limited to those. This parameter should not be defined by client applications. The link for the first, last,
          prev, or next page in the HTTP Link header should define it.
        schema:
          type: string
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                properties:
                  items:
                    type: array
                    items:
                      type: object
                      properties:
                        serial:
                          type: string
                          description: The cloud ID of the wireless LAN controller
                        interfaces:
                          type: array
                          items:
                            type: object
                            properties:
                              name:
                                type: string
                                description: The name of the wireless LAN controller interface
                              description:
                                type: string
                                description: The description of the wireless LAN controller interface
                              enabled:
                                type: boolean
                                description: The status of the wireless LAN controller interface
                              mac:
                                type: string
                                description: The MAC address of the wireless LAN controller interface
                              status:
                                type: string
                                description: The status of the wireless LAN controller interface
                              speed:
                                type: string
                                description: The current data transfer rate which the interface is operating at. enum = [1
                                  Gbps, 2 Gbps, 5 Gbps, 10 Gbps, 20 Gbps, 40 Gbps, 100 Gbps]
                              isUplink:
                                type: boolean
                                description: Indicate whether the interface is uplink
                              vlan:
                                type: integer
                                description: The VLAN of the switch port. For a trunk port, this is the native VLAN. A null
                                  value will clear the value set for trunk ports.
                              isRedundancyPort:
                                type: boolean
                                description: Indicate whether the interface is a redundancy port used to perform HA role negotiation
                              linkNegotiation:
                                type: string
                                description: The interface negotiation mode
                              channelGroup:
                                type: object
                                properties:
                                  number:
                                    type: integer
                                    description: The interface channel group number
                                description: The channel group of this wireless LAN controller interface
                              module:
                                type: object
                                properties:
                                  model:
                                    type: string
                                    description: The module type of this wireless LAN controller interface
                                description: The module of this wireless LAN controller interface
                          description: Layer 2 interfaces belongs to the wireless LAN controller
                    description: Wireless LAN controller L2 interfaces
                  meta:
                    type: object
                    properties:
                      counts:
                        type: object
                        properties:
                          items:
                            type: object
                            properties:
                              total:
                                type: integer
                                description: The total number of items in the dataset
                              remaining:
                                type: integer
                                description: The number of items in the dataset that are available on subsequent pages
                            description: Counts relating to the paginated items
                        description: Counts relating to the paginated dataset
                    description: Metadata relevant to the paginated dataset
              example:
                items:
                - serial: Q234-ABCD-5678
                  interfaces:
                  - name: TenGigabitEthernet0/0/5
                    description: Uplink
                    enabled: true
                    mac: b0:c5:3c:0d:c5:0b
                    status: disabled
                    speed: 1 Gbps
                    isUplink: true
                    vlan: 10
                    isRedundancyPort: true
                    linkNegotiation: auto
                    channelGroup:
                      number: 5
                    module:
                      model: C9800-2X40GE
                meta:
                  counts:
                    items:
                      total: 10
                      remaining: 0
          headers:
            Link:
              schema:
                type: string
              description: A comma-separated list of first, last, prev, and next relative links used for subsequent paginated
                requests.
      summary: List wireless LAN controller layer 2 interfaces in an organization
      tags:
      - wirelessController
      - monitor
      - devices
      - interfaces
      - l2
      - byDevice
  /organizations/{organizationId}/wirelessController/devices/interfaces/l2/statuses/changeHistory/byDevice:
    get:
      description: List wireless LAN controller layer 2 interfaces history status in an organization
      operationId: getOrganizationWirelessControllerDevicesInterfacesL2StatusesChangeHistoryByDevice
      parameters:
      - name: organizationId
        in: path
        description: Organization ID
        schema:
          type: string
        required: true
      - name: serials
        in: query
        description: Optional parameter to filter wireless LAN controller by its cloud ID. This filter uses multiple exact
          matches.
        schema:
          type: array
          items:
            type: string
      - name: includeInterfacesWithoutChanges
        in: query
        description: 'By default, interfaces without changes are omitted from the response for brevity. If you want to include
          the interfaces even if they have no changes, set to true. (default: false)'
        schema:
          type: boolean
      - name: t0
        in: query
        description: The beginning of the timespan for the data. The maximum lookback period is 31 days from today.
        schema:
          type: string
      - name: t1
        in: query
        description: The end of the timespan for the data. t1 can be a maximum of 31 days after t0.
        schema:
          type: string
      - name: timespan
        in: query
        description: The timespan for which the information will be fetched. If specifying timespan, do not specify parameters
          t0 and t1. The value must be in seconds and be less than or equal to 31 days. The default is 7 days.
        schema:
          type: number
          format: float
          maximum: 2678400
      - name: perPage
        in: query
        description: The number of entries per page returned. Acceptable range is 3 - 1000. Default is 1000.
        schema:
          type: integer
      - name: startingAfter
        in: query
        description: A token used by the server to indicate the start of the page. Often this is a timestamp or an ID but
          it is not limited to those. This parameter should not be defined by client applications. The link for the first,
          last, prev, or next page in the HTTP Link header should define it.
        schema:
          type: string
      - name: endingBefore
        in: query
        description: A token used by the server to indicate the end of the page. Often this is a timestamp or an ID but it
          is not limited to those. This parameter should not be defined by client applications. The link for the first, last,
          prev, or next page in the HTTP Link header should define it.
        schema:
          type: string
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                properties:
                  items:
                    type: array
                    items:
                      type: object
                      properties:
                        serial:
                          type: string
                          description: The cloud ID of the wireless LAN controller
                        interfaces:
                          type: array
                          items:
                            type: object
                            properties:
                              name:
                                type: string
                                description: The name of the wireless LAN controller interface
                              mac:
                                type: string
                                description: The MAC address of the wireless LAN controller interface
                              changes:
                                type: array
                                items:
                                  type: object
                                  properties:
                                    ts:
                                      type: string
                                      format: date-time
                                      description: The timestamp of current status of the interface
                                    status:
                                      type: string
                                      description: The status of the interface
                                    warnings:
                                      type: array
                                      items:
                                        type: string
                                      description: All warnings present on the port
                 

# --- truncated at 32 KB (107 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/cisco-meraki/refs/heads/main/openapi/cisco-meraki-wirelesscontroller-api-openapi.yml