Mist API Reference
Mist Automation Guide
HomeSDKsAPI ReferenceContext Plugin
OrgsStatsTunnels

countOrgTunnelsStats

GET
/api/v1/orgs/{org_id}/stats/tunnels/count

Count by Distinct Attributes of Mist Tunnels Stats

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 tunnel statistics count results. enum: ap, auth_algo, encrypt_algo, ike_version, ip, last_event, mac, mxcluster_id, mxedge_id, node, peer_host, peer_ip, peer_mxedge_id, protocol, remote_ip, remote_port, site_id, state, tunnel_name, up, wxtunnel_id

Default"wxtunnel_id"

Value in

  • "ap"
  • "auth_algo"
  • "encrypt_algo"
  • "ike_version"
  • "ip"
  • "last_event"
  • "mac"
  • "mxcluster_id"
  • "mxedge_id"
  • "node"
  • "peer_host"
  • "peer_ip"
  • "peer_mxedge_id"
  • "protocol"
  • "remote_ip"
  • "remote_port"
  • "site_id"
  • "state"
  • "tunnel_name"
  • "up"
  • "wxtunnel_id"
type?string

Filter results by type. enum: wan, wxtunnel

Default"wxtunnel"

Value in

  • "wan"
  • "wxtunnel"
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/stats/tunnels/count"
{  "distinct": "string",  "end": 0,  "limit": 0,  "results": [    {      "count": 0,      "property": "string"    }  ],  "start": 0,  "total": 0}

listOrgSiteStats GET

Get List of Org Site Stats

searchOrgTunnelsStats GET

By default the endpoint returns only `wxtunnel` type stats, to get `wan` type stats you need to specify `type=wan` in the query parameters. Tunnel types: - `wxtunnel` (default) - A WxLan Tunnel (WxTunnel) are used to create a secure connection between Juniper Mist Access Points and third-party VPN concentrators using protocols such as L2TPv3 or dmvpn. - `wan` - A WAN Tunnel is a secure connection between two Gateways, typically used for site-to-site or mesh connectivity. It can be configured with various protocols and encryption methods. If `type` is not specified or `type`==`wxtunnel`, the following parameters are supported: - `mxcluster_id` - the MX cluster ID - `site_id` - the site ID - `wxtunnel_id` - the WX tunnel ID - `ap` - the AP MAC address If `type`==`wan`, the following parameters are supported: - `mac` - the MAC address of the WAN device - `node` - the node ID - `peer_ip` - the peer IP address - `peer_host` - the peer host name - `ip` - the IP address of the WAN device - `tunnel_name` - the name of the tunnel - `protocol` - the protocol used for the tunnel - `auth_algo` - the authentication algorithm used for the tunnel - `encrypt_algo` - the encryption algorithm used for the tunnel - `ike_version` - the IKE version used for the tunnel - `up` - the status of the tunnel (up or down)