HomeGuidesAPI Reference
GuidesAPI ReferenceGitHubAirheads Developer CommunityLog In
API Reference

Get an array of Switch objects

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

Return only the count of objects in the result property of the response.

fabrics
array

Return the switch objects for the given list of fabric UUIDs.

  • Note that while the data type is array[string], the parameter value constructed by clients can be either:
  • Multiple instances of the parameter with distinct values, e.g. foo=bar&foo=baz translates to values bar and baz for parameter foo
  • One value (with no delimiter), e.g. foo=bar
  • Comma-separated list of strings, e.g. foo=bar,baz translates to the values bar and baz for parameter foo
    • NOTE: character encoding of the comma (,) character (%2C) as a delimiter is not supported
    • Parameter values can contain commas, but they must be encoded, e.g. foo=bar,baz%2Czab translates to the values bar and baz,zab for parameter foo
fabrics
integer

Return the array of attachment objects contained in the given page number

integer

Return an array of attachment objects of the given size

boolean

Include array of ports with each switch object

boolean

Include the software state of the switch, including running and staged software versions.

boolean

Include related tag list as a property of each object in the response body

boolean

When true, returns only switches which are not assigned to a fabric; if explicitly set to false, returns only switches which are assigned to a fabric

Include only switches with this IP address; matches either the IPv4 address property: ip_address or the IPv6 address property: ip_address_v6

string

Filter data results by query string

Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json; version=1.0