searchOrgSites
Search organization sites with filters for feature flags, country code, identifiers, names, upgrade settings, and other site attributes. Supports pagination and sorting.
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
uuidQuery Parameters
If Advanced Analytic feature is enabled. Accepts multiple comma-separated boolean values.
If App Waking feature is enabled
If Asset Tracking is enabled. Accepts multiple comma-separated boolean values.
Filter results by whether automatic upgrades are enabled
Filter results by automatic upgrade version. Accepts multiple comma-separated values.
Filter results by country code. Accepts multiple comma-separated values.
If Honeypot detection is enabled. Accepts multiple comma-separated boolean values.
Filter results by identifier. Accepts multiple comma-separated values.
If unconnected client are located. Accepts multiple comma-separated boolean values.
If Mesh feature is enabled. Accepts multiple comma-separated boolean values.
Partial / full Site name. Case insensitive. Use prefix* for prefix search or *substring* for contains search (e.g. my-site* and *site* match my-site-01). Suffix-only wildcards (e.g. *site-01) are not supported. Accepts multiple comma-separated values.
If Rogue detection is enabled. Accepts multiple comma-separated boolean values.
If Remote Syslog is enabled
If managed mobility feature is enabled. Accepts multiple comma-separated boolean values.
If Virtual Network Assistant is enabled. Accepts multiple comma-separated boolean values.
If Wi-Fi feature is enabled
Maximum number of results to return per page
0 <= value100Lower bound of the time range, as an epoch timestamp in seconds or a relative value such as -1d or -1w
Upper bound of the time range, as an epoch timestamp in seconds or a relative value such as -1d, -2h, or now
Time range duration for the query, using relative units such as 10m, 7d, or 2w
"1d"On which field the list should be sorted, -prefix represents DESC order
"timestamp"Pagination cursor for retrieving subsequent pages of results. This value is automatically populated by Mist in the next URL from the previous response and should not be manually constructed.
Response Body
curl -X GET "https://example.com/api/v1/orgs/000000ab-00ab-00ab-00ab-0000000000ab/sites/search"{ "end": 0, "limit": 0, "next": "string", "results": [ { "auto_upgrade_enabled": true, "auto_upgrade_version": "string", "country_code": "string", "honeypot_enabled": true, "id": "b069b358-4c97-5319-1f8c-7c5ca64d6ab1", "name": "string", "org_id": "b069b358-4c97-5319-1f8c-7c5ca64d6ab1", "site_id": "b069b358-4c97-5319-1f8c-7c5ca64d6ab1", "timestamp": 0, "timezone": "string", "vna_enabled": true, "wifi_enabled": true } ], "start": 0, "total": 0}