Get a list of MAC attachments filtering output by query parameters.

get

https://example.com/api/mac_attachments

Retrieve an array of MAC attachments. NOTE:

Most query parameters can contain more than one item.
A logical OR operation is performed when filtering items of a particular type
A logical AND operation is performed when query parameters of differing types are used

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

count_only

boolean

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

interfaces

boolean

Return the port or LAG the MAC attachment object was learned on in the result property of the response.

page

integer

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

page_size

integer

Return an array of MAC attachment objects of the given size

fabrics

array

Return MAC attachments 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 MAC attachments 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

ports

array

Get MAC attachments for the given list of port 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

ports

lags

array

Get MAC attachments for the given list of LAG 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

lags

interface_uuids

array

Get MAC attachments learned on the given list of interface UUIDs.

Note that while the data type is Array[string], the parameter value constructed by clients must be a string representation: a comma-separated list of UUIDs.
Limiting the value of this parameter to one UUID is also valid.

interface_uuids

mac_addresses

array of strings

Return a list of MAC Attachments for given list of MAC Addresses.

Note that while the data type is Array[string], the parameter value constructed by clients must be a string representation: a comma-separated list of url-encoded MAC addresses.

mac_addresses

oui

string

Return a list of MAC attachments matching an MAC address OUI prefix.
The parameter value constructed by clients must be a string representation: a url-encoded MAC address OUI prefix.

The first 3 bytes are used to filter the request.
The last 3 are ignored.
For example: AB:CD:EF:XX:XX:XX Will return all MAC addresses with a OUI prefix of AB:CD:EF

vlan

array of integers

Return a list of MAC attachments matching the list of VLANs.

vlan

vni

array of integers

Return a list of MAC attachments learned on the list of VNIs.

vni

interface_type

string

enum

Return a list of MAC attachments learned on either a port or lag.

Allowed:

filter

string

Filter data results by query string

Responses

200Success

401Error: Unauthorized