HomeGuidesAPI Reference
GuidesAPI ReferenceGitHubAirheads Developer CommunityLog In
API Reference

Get an array of Network objects

Retrieve an array of Network objects

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

Return Networks 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

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

boolean

Include statistics and detailed health information.

integer

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

integer

Return an array of network objects of the given size

string
length between 32 and 36

Get the list of networks related to the given VRF UUID

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