Mist API Reference
Mist Automation Guide
HomeSDKsAPI ReferenceContext Plugin
OrgsDevices

countOrgDevices

GET
/api/v1/orgs/{org_id}/devices/count

Count organization device records, optionally grouped by distinct and filtered by device identifiers, model, LLDP attributes, Mist Edge, tunnel status, device type, and time range.

Authorization

Authorization<token>

Preferred authentication method for automation and integrations. Send the API token in the HTTP Authorization header.

Format: Authorization: Token {apitoken}

Notes:

  • An API token generated for a specific admin has the same privileges as that admin
  • An API token is automatically removed if it is not used for more than 90 days
  • SSO admins cannot generate admin API tokens. Use organization API tokens when scoped Org/Site privileges are needed.

In: header

Path Parameters

org_id*string
Formatuuid

Query Parameters

distinct?string

Field used to group this count response. enum: hostname, ip, lldp_mgmt_addr, lldp_port_id, lldp_system_desc, lldp_system_name, mac, model, mxedge_id, mxtunnel_status, site_id, version

Default"model"

Value in

  • "hostname"
  • "ip"
  • "lldp_mgmt_addr"
  • "lldp_port_id"
  • "lldp_system_desc"
  • "lldp_system_name"
  • "mac"
  • "model"
  • "mxedge_id"
  • "mxtunnel_status"
  • "site_id"
  • "version"
hostname?string

Partial / full hostname

site_id?string

Filter results by site identifier

Formatuuid
model?string

Filter results by device model. Accepts multiple comma-separated values.

managed?string
Deprecated

for switches and gateways, to filter on managed/unmanaged devices. Deprecated in favour of mist_configured. enum: true, false

mac?string

Filter results by MAC address

version?string

Filter results by software version

ip?string

Filter results by IPv4 address

Formatipv4
mxtunnel_status?string

MxTunnel status, enum: up, down

Value in

  • "down"
  • "up"
mxedge_id?string

Mist Edge id, if AP is connecting to a Mist Edge

Formatuuid
lldp_system_name?string

Filter results by LLDP system name

lldp_system_desc?string

Filter results by LLDP system description

lldp_port_id?string

Filter results by LLDP port identifier

lldp_mgmt_addr?string

LLDP management IP address

type?string

Filter results by type. enum: ap, gateway, switch

Default"ap"

Value in

  • "ap"
  • "gateway"
  • "switch"
start?string

Lower bound of the time range, as an epoch timestamp in seconds or a relative value such as -1d or -1w

end?string

Upper bound of the time range, as an epoch timestamp in seconds or a relative value such as -1d, -2h, or now

duration?string

Time range duration for the query, using relative units such as 10m, 7d, or 2w

Default"1d"
limit?integer

Maximum number of results to return per page

Range0 <= value
Default100

Response Body

curl -X GET "https://example.com/api/v1/orgs/000000ab-00ab-00ab-00ab-0000000000ab/devices/count"
{  "distinct": "string",  "end": 0,  "limit": 0,  "results": [    {      "count": 0,      "property": "string"    }  ],  "start": 0,  "total": 0}

countOrgDeviceLastConfigs GET

Count device config history records across the organization, optionally grouped by `distinct` and filtered by device type and time range.

getOrgJuniperDevicesCommand GET

Get Org Juniper Devices command Juniper devices can be managed/adopted by Mist. Currently outbound-ssh + netconf is used. A few lines of CLI commands are generated per-Org, allowing the Juniper devices to phone home to Mist.