OrgsSites

countOrgSites

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

Count organization sites grouped by a distinct site attribute, such as country code, site name, feature flags, or enabled services.

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: analytic_enabled, app_waking, asset_enabled, auto_upgrade_enabled, auto_upgrade_version, country_code, honeypot_enabled, id, locate_unconnected, mesh_enabled, name, remote_syslog_enabled, rogue_enabled, rtsa_enabled, vna_enabled, wifi_enabled

Default"id"

Value in

  • "analytic_enabled"
  • "app_waking"
  • "asset_enabled"
  • "auto_upgrade_enabled"
  • "auto_upgrade_version"
  • "country_code"
  • "honeypot_enabled"
  • "id"
  • "locate_unconnected"
  • "mesh_enabled"
  • "name"
  • "remote_syslog_enabled"
  • "rogue_enabled"
  • "rtsa_enabled"
  • "vna_enabled"
  • "wifi_enabled"
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/sites/count"
{  "distinct": "string",  "end": 0,  "limit": 0,  "results": [    {      "count": 0,      "property": "string"    }  ],  "start": 0,  "total": 0}