API Guide

PATH PARAMETERS
NAME TYPE DESCRIPTION
*id string
Unique identier of the fabric intent.
RESPONSE
STATUS CODE - 200: Response to get a list of bgp neighbor details for every switch managed by SFD.
RESPONSE MODEL - application/json
{
List of BGP neighbor details for each switch.
data [{
Array of object: The BGP conguration on the switch
switch_id string
Id of the switch.
name string
Name of the switch
switch_role enum ALLOWED:LEAF, SPINE, EDGE_LEAF, EDGE_CLOUD
The Role for a switch, if its a LEAF, SPINE, or an EDGE_LEAF
as_number integer
AS number on the switch
ip_address string
The loopback IP address or the physical adjacency IP address of the switch
neighbors [{
Array of object: The BGP neighbors for this switch
peer_switch_id string
Object id of the remote switch
peer_switch_name string
Name of the the remote switch
peer_switch_role enum ALLOWED:LEAF, SPINE, EDGE_LEAF, EDGE_CLOUD
The Role for a switch, if its a LEAF, SPINE, or an EDGE_LEAF
peer_as_number integer
AS (Autonomus System) of the remote switch
peer_address string
Ip Address of the remote switch
}]
}]
}
STATUS CODE - 401: You are not authorized to perform this operation.
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.
}]
}
STATUS CODE - 404: Requested entity does not exist.
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
86 of 340