HomeGuidesAPI Reference
GuidesAPI ReferenceGitHubAirheads Developer CommunityLog In
API Reference

Get an array of LAG objects

Retrieve an array of Link Aggregation Group objects, optionally including an array of Port objects and/or VLAN Group objects related to each Link Aggregation Group.

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

Return only the count of Link Aggregation Group objects in the result property of the response.

fabrics
array

Return Lags 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
boolean

If there is a L2VPN object associated with this object, return the L2VPN's UUID

boolean

Include MAC attachment information with each Link Aggregation Group object in the response body.

integer

Return the array of Link Aggregation Group objects contained in the given page number.

integer

Return an array of Link Aggregation Group objects of the given size.

boolean

Include an array of associated ports with each Link Aggregation Group object in the response body.

string
enum

Filter the result set based on the value of each object's type property value, which can be one of:

  • access: exist by default on switches and are for general use.
Allowed:
boolean

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

type
array of strings

Filter the result set based on the value of each object's type property value.

  • Link Aggregation Groups with type provisioned have been explicitly configured on switches and can contain one or more ports.
  • Link Aggregation Groups with type internal exist by default on switches and contain only one port. Think of these as objects that simply hold configuration state (e.g. configured line speed).
  • Link Aggregation Groups with type ISL have been explicitly configured on switches and can contain only one port.
  • Link Aggregation Groups with type ALL output all the lags.
type
boolean

Include an array of associated VLAN Group objects with each Link Aggregation Group object in the response body.

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