HomeGuidesAPI Reference
GuidesAPI ReferenceGitHubAirheads Developer CommunityLog In
API Reference

Get an array of vrf 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 VRFs 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
switches
array

Get VRFs for the given list of switch 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
switches
boolean

Include Interface information with each Virtual Routing Forwarding object in the response body.

boolean

Include static route information with each Virtual Routing Forwarding object in the response body.

boolean

Include Border Gateway Protocol Global configuration with each Virtual Routing Forwarding object in the response body.

boolean

Include Border Gateway Protocol information with each Virtual Routing Forwarding object in the response body.

boolean

Include Network objects for each VRF object in the response body

boolean

Include Open Shortest Path First Global configuration with each Virtual Routing Forwarding object in the response body.

boolean

Include Open Shortest Path First Routers information with each Virtual Routing Forwarding object in the response body.

boolean

Include Open Shortest Path First Summary Addresses information with each Virtual Routing Forwarding object in the response body if include_ospf is True.

boolean

If returning Virtual Routing Forwarding child objects in the response body, also include any objects referenced by those child objects in the response.For IP Interfaces of type 'routed', the LAG and switch objects on which the Interface was created will be included, along with the member ports of the LAG.

type
array of strings

Return vrfs only for the type defined. type can be default, mgmt, user.

type
integer

Return the array of Virtual Routing Forwarding objects contained in the given page number

integer

Return an array of Virtual Routing Forwarding objects of the given size

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