Mist API Reference
Mist Automation Guide
HomeSDKsAPI ReferenceContext Plugin
OrgsUser MACs

searchOrgUserMacs

GET
/api/v1/orgs/{org_id}/usermacs/search

Search Org User MACs

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

mac?string

Partial / full Client MAC address. Use prefix* for prefix search or *substring* for contains search (e.g. aabbcc* and *bbcc* match aabbccddeeff). Suffix-only wildcards (e.g. *bccddeeff) are not supported

labels?array<string>

Optional, array of strings of labels

limit?integer

Maximum number of results to return per page

Range0 <= value
Default100
page?integer

Select the page number to return when using page-based pagination; starts at 1

Range1 <= value
Default1
sort?string

On which field the list should be sorted, -prefix represents DESC order

Default"timestamp"

Response Body

curl -X GET "https://example.com/api/v1/orgs/000000ab-00ab-00ab-00ab-0000000000ab/usermacs/search"
[  {    "id": "111cafd2-ba1b-5169-bfcb-9cdf1d473ddb",    "labels": [      "flor1",      "bld4"    ],    "mac": "921b638445cd",    "notes": "MAC address refers to Canon printers",    "site_ids": [      "4ac1dcf4-9d8b-7211-65c4-057819f0862b",      "52f4347e-3e4b-186c-21ca-ad5b70eb23d6"    ],    "vlan": "30"  }]

importOrgUserMacs POST

Import Org User MACs. Accepts JSON or CSV upload. **JSON — Array form** (asynchronous by default): ```json [ {"mac": "921b638445cd", "labels": ["label1"], "vlan": "vlan-1"}, {"mac": "721b638445ef", "labels": ["label2", "label3"], "notes": "mac address refers to Canon printers"} ] ``` **CSV upload**: multipart/form-data with `file` field. ### CSV file format ```csv mac,labels,vlan,notes,name,radius_group 921b638445cd,"bldg1,flor1",vlan-100 721b638445ef,"bldg2,flor2",vlan-101,Canon Printers 721b638445ee,"bldg3,flor3",vlan-102,Printer2,VIP 921b638445ce,"bldg4,flor4",vlan-103 921b638445cf,"bldg5,flor5",vlan-104 ```

countOrgVars GET

Count organization vars, optionally grouped by `distinct` and filtered by site, variable name, and source. Example: /api/v1/orgs/{org_id}/vars/count?distinct=var