HomeGuidesAPI Reference
GuidesAPI ReferenceGitHubAirheads Developer CommunityLog In
API Reference
GuidesAPI ReferenceGitHubAirheads Developer Community

Get data for all sites

get
https://{api-base-url}/branchhealth/v1/site

Get data for all sites

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
integer
Defaults to 0

pagination start index

integer
Defaults to 10

pagination size

string

site / label name or part of its name

integer
Defaults to device_total

Column to sort on

integer
enum
Defaults to desc

Sort order:

  • asc - Ascending, from A to Z.
  • desc - Descending, from Z to A.
Allowed:
string
enum

Site thresholds

  • All properties of a site can be used as filter parameters with a threshold
  • The range filters can be combined with the column names with "__"
  • For eg. /site?device_down__gt=0 - Lists all sites that have more than 1 device in down state
  • For eg. /site?wan_uplinks_down__lt=1 - Lists all sites that have less than 1 wan in down state
  • For eg. /site?device_up__gt=1&device_up__lt=10 - Lists all sites that have 1-10 devices in up state
Allowed:
Responses

401

Unauthorized

413

Request-size limit exceeded

429

API rate limit exceeded

Updated about 2 years ago

Language
Credentials
Bearer
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 2 years ago