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

List Swarms

get
https://{api-base-url}/monitoring/v1/swarms

Get list of swarms. You can optionally specify a group to filter on groups.
Possible error_codes for the error responses are

  1. 0001 - General Error.
  2. 0002 - Validation Error. Out of Range value for a query parameter.
  3. 0004 - Validation Error. Invalid value for a query parameter
Query Params
string

Filter by group name

string

Filter by Swarm status

string

Filter by public ip address

string

Comma separated list of fields to be returned. Valid fields are status, ip_address, public_ip_address, firmware_version

boolean

Whether to calculate total Swarms

int32

Pagination offset

int32

Pagination limit. Default is 100 and max is 1000

string

Sort parameter may be one of +swarm_id, -swarm_id

string

Filter by swarm name

Responses

401

Unauthorized access

403

Forbidden

413

Request-size limit exceeded

417

Request-size limit exceeded

429

API Rate limit exceeded

Updated about 2 years ago

Language
Credentials
Bearer
URL
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated about 2 years ago