API Guide

Message in the localized le.
}]
}
STATUS CODE - default: success or error response
RESPONSE MODEL - application/json
{
new_object_id string
This represents the id of the new object created for the POST API call.
id string
This represents the key for the localized property le to be used by UI to show the localized string.
message string
Success or error message
messageParams [string]
Params array to substitute in the message. This will be used by UI to substitue the params in the
Message in the localized le.
messages [{
Array of object:
id string
This represents the key for the localized property le to be used by UI to show the localized string.
message string
Success or error message
field_name string
Field name where the error was seen
messageParams [string]
Params array to substitute in the message. This will be used by UI to substitue the params in the
Message in the localized le.
}]
}
6.5 GET /fabric-intents/{id}/configurations/ufd
Retrieves the UFD interfaces for all the switches. The downlink interfaces will be shown only for an ACTIVE fabric intent.
REQUEST
PATH PARAMETERS
NAME TYPE DESCRIPTION
*id string
Unique identier of the fabric intent.
RESPONSE
STATUS CODE - 200: Response to get a list of ufd interfaces for all the switches.
RESPONSE MODEL - application/json
{
List of UFD interface details for all the switches.
data [{
Array of object: Lists the UFD interfaces and other UFD information for a switch.
switch_id string
ID of the switch.
switch_name string
Name of the switch.
enabled boolean
Represents whether UFD is congured on the switch.
group_id integer
The id of the UFD. There will be one UFD object per leaf switch.
interface_members [{
Array of object: The information about the UFD interface which is member of a group
type enum ALLOWED:UPLINK, DOWNLINK
Type of the UFD interface
members {
The information about an Ethernet interface.
id string
The object id of the interface.
name string
the name of the interface.
switch_id string
Oid of the switch, on which the interface resides.
switch_name string
Name of the switch, on which the interface resides.
89 of 340