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

Get an array of Port objects

get
https://example.com/api/ports
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
boolean

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

fabrics
array

Return Ports 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 related lag object as a property of each port object in the response body

integer

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

integer

Return an array of Port objects of the given size

string

Return an array of Port objects with the matching label

integer

Return an array of Port objects belonging to a slot.Returns empty for non chassis based switches.

boolean

Include ports which have port security:

  • true - enabled or
  • false - disabled
switches
array

Return Ports 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 related tag list as a property of each object in the response body

boolean

Include an array of related VLAN group objects as a property of each port 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 an array of neighbor (learned via CDP, LLDP, or user-defined) within the neighbors property of each port object in the response body

string

Filter data results by query string

Responses

Updated over 2 years ago

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

Updated over 2 years ago