API Reference

status

get
Query parameters
fileNamestringOptional
Responses
chevron-right
200

OK

application/json
string[]Optional
get
/status
200

OK

isDeviceAlive

get
Query parameters
hostIPstringRequired
Responses
chevron-right
200

OK

application/json
booleanOptional
get
/isDeviceAlive
200

OK

getVersion

post
Bodystring[]
string[]Optional
Responses
chevron-right
200

OK

application/json
object[]Optional
post
/getVersion
200

OK

getControllerVersion

get
Responses
chevron-right
200

OK

application/json
Other propertiesstringOptional
get
/getControllerVersion
200

OK

getImgmgmtStatus

post
Bodystring[]
string[]Optional
Responses
chevron-right
200

OK

application/json
object[]Optional
post
/getImgmgmtStatus
200

OK

getDay1ConfigStatus

get
Query parameters
intentNamestringRequired
Responses
chevron-right
200

OK

application/json
object[]Optional
get
/getDay1ConfigStatus
200

OK

getIntentValidation

get
Query parameters
intentNamestringRequired
Responses
chevron-right
200

OK

application/json
object[]Optional
get
/getIntentValidation
200

OK

uploadDay1Config

post
Body
filestringRequired
Responses
chevron-right
200

OK

application/json
stringOptional
post
/uploadDay1Config
200

OK

uploadStatus

get
Responses
chevron-right
200

OK

application/json
stringOptional
get
/uploadStatus
200

OK

enableZTPUpgrade

post
Bodystring[]
string[]Optional
Responses
chevron-right
200

OK

application/json
booleanOptional
post
/enableZTPUpgrade
200

OK

upgradeNOSImage

post
Bodyobject[]
ipstringOptional
pathToImagestringOptional
Responses
chevron-right
200

OK

application/json
booleanOptional
post
/upgradeNOSImage
200

OK

rebootRequest

post
Bodystring[]
string[]Optional
Responses
chevron-right
200

OK

application/json
booleanOptional
post
/rebootRequest
200

OK

getConfigDiff

post
Body
ipstringOptional
Responses
chevron-right
200

OK

application/json
objectOptional
post
/getConfigDiff
200

OK

getControllerVersionInternal

get
Responses
chevron-right
200

OK

application/json
Other propertiesstringOptional
get
/getControllerVersionInternal
200

OK

addDeviceFacts

post
Bodyobject[]
ipstringOptional
userstringOptional
passwordstringOptional
Responses
chevron-right
200

OK

application/json
booleanOptional
post
/addDeviceFacts
200

OK

removeDeviceFacts

post
Bodystring[]
string[]Optional
Responses
chevron-right
200

OK

application/json
booleanOptional
post
/removeDeviceFacts
200

OK

getIntentDerivationLogs

get
Query parameters
devicestringRequired
Responses
chevron-right
200

OK

application/json
object[]Optional
get
/getIntentDerivationLogs
200

OK

uploadUIObject

post
Body
idintegerOptional
namestringOptional
fabricIdintegerOptional
orchestrationModestringOptional
sspineCountintegerOptional
spineCountintegerOptional
leafCountintegerOptional
fecstringOptional
mtustringOptional
adminStatusstringOptional
asnSSpinestringOptional
isAsnSSpineUniquebooleanOptional
asnLeafstringOptional
isAsnLeafUniquebooleanOptional
asnSpinestringOptional
isAsnSpineUniquebooleanOptional
ntpServerstringOptional
timezonestringOptional
sysLogServerstringOptional
snmpServerstringOptional
v4SpineLeafPoolstringOptional
v6SpineLeafPoolstringOptional
v4LoopbackPoolstringOptional
v6LoopbackPoolstringOptional
v4LeafTorPoolstringOptional
v6LeafTorPoolstringOptional
v4HostPoolstringOptional
v6HostPoolstringOptional
isBGP_UbooleanOptional
isTorPresentbooleanOptional
ND_RAintegerOptional
isactivebooleanOptional
lastupdatedobjectOptional
logsstringOptional
issagbooleanOptional
sflowcollector1stringOptional
sflowport1stringOptional
sflowcollector2stringOptional
sflowport2stringOptional
isL2LSEnabledbooleanOptional
dhcpServerIpsstringOptional
dhcpRelaySrcInterfacestringOptional
dhcpRelaySrcInterfaceIPstringOptional
l2lsmodestringOptional
Responses
chevron-right
200

OK

application/json
stringOptional
post
/uploadUIObject
200

OK

addFabricData

post
Body
idintegerOptional
namestringOptional
typestringOptional
statusstringOptional
descriptionstringOptional
numOfSusintegerOptional
maxNumOfSusintegerOptional
dedicatedbooleanOptional
hybridbooleanOptional
startingSubnetGpuintegerOptional
startingSubnetCpustringOptional
startingSubnetTenantsstringOptional
startingSubnetStoragestringOptional
simulationIdintegerOptional
intentstringOptional
ewTenantAwarebooleanOptional
storageTenantAwarebooleanOptional
isOnesControlledbooleanOptional
suHostCntstringOptional
isVxlanFabricbooleanOptional
nodeTypestringOptional
isimportedbooleanOptional
Responses
chevron-right
200

OK

application/json
stringOptional
post
/addFabricData
200

OK

delFabricData

delete
Path parameters
namestringRequired
Responses
chevron-right
200

OK

application/json
stringOptional
delete
/delFabricData/{name}
200

OK

editFabricData

patch
Path parameters
fabricNamestringRequired
Body
idintegerOptional
namestringOptional
typestringOptional
statusstringOptional
descriptionstringOptional
numOfSusintegerOptional
maxNumOfSusintegerOptional
dedicatedbooleanOptional
hybridbooleanOptional
startingSubnetGpuintegerOptional
startingSubnetCpustringOptional
startingSubnetTenantsstringOptional
startingSubnetStoragestringOptional
simulationIdintegerOptional
intentstringOptional
ewTenantAwarebooleanOptional
storageTenantAwarebooleanOptional
isOnesControlledbooleanOptional
suHostCntstringOptional
isVxlanFabricbooleanOptional
nodeTypestringOptional
isimportedbooleanOptional
Responses
chevron-right
200

OK

application/json
stringOptional
patch
/fabrics/{fabricName}/editFabricData
200

OK

editInventoryData

patch
Path parameters
fabricNamestringRequired
Bodyobject[]
SpinesintegerOptional
LeafsintegerOptional
SSpinesintegerOptional
TorsintegerOptional
HostsintegerOptional
Responses
chevron-right
200

OK

application/json
stringOptional
patch
/fabrics/{fabricName}/editInventoryData
200

OK

getAllFabrics

get
Responses
chevron-right
200

OK

application/json
idintegerOptional
namestringOptional
typestringOptional
statusstringOptional
descriptionstringOptional
numOfSusintegerOptional
maxNumOfSusintegerOptional
dedicatedbooleanOptional
hybridbooleanOptional
startingSubnetGpuintegerOptional
startingSubnetCpustringOptional
startingSubnetTenantsstringOptional
startingSubnetStoragestringOptional
simulationIdintegerOptional
intentstringOptional
ewTenantAwarebooleanOptional
storageTenantAwarebooleanOptional
isOnesControlledbooleanOptional
suHostCntstringOptional
isVxlanFabricbooleanOptional
nodeTypestringOptional
isimportedbooleanOptional
get
/getAllFabrics
200

OK

getFabricByName

get
Path parameters
namestringRequired
Responses
chevron-right
200

OK

application/json
idintegerOptional
namestringOptional
typestringOptional
statusstringOptional
descriptionstringOptional
numOfSusintegerOptional
maxNumOfSusintegerOptional
dedicatedbooleanOptional
hybridbooleanOptional
startingSubnetGpuintegerOptional
startingSubnetCpustringOptional
startingSubnetTenantsstringOptional
startingSubnetStoragestringOptional
simulationIdintegerOptional
intentstringOptional
ewTenantAwarebooleanOptional
storageTenantAwarebooleanOptional
isOnesControlledbooleanOptional
suHostCntstringOptional
isVxlanFabricbooleanOptional
nodeTypestringOptional
isimportedbooleanOptional
get
/getFabricByName/{name}
200

OK

addFabricSim

post
Body
idintegerOptional
fabricNamestringOptional
simulationIdstringOptional
usernamestringOptional
tokenstringOptional
orgUuidstringOptional
statusstringOptional
uiLinkstringOptional
createdAtobjectOptional
updatedAtobjectOptional
Responses
chevron-right
200

OK

application/json
stringOptional
post
/addFabricSim
200

OK

getAllFabricSims

get
Responses
chevron-right
200

OK

application/json
idintegerOptional
fabricNamestringOptional
simulationIdstringOptional
usernamestringOptional
tokenstringOptional
orgUuidstringOptional
statusstringOptional
uiLinkstringOptional
createdAtobjectOptional
updatedAtobjectOptional
get
/getAllFabricSims
200

OK

getFabrics

get
Responses
chevron-right
200

OK

application/json
get
/fabrics
200

OK

getFabricSimsByName

get
Path parameters
namestringRequired
Responses
chevron-right
200

OK

application/json
idintegerOptional
fabricNamestringOptional
simulationIdstringOptional
usernamestringOptional
tokenstringOptional
orgUuidstringOptional
statusstringOptional
uiLinkstringOptional
createdAtobjectOptional
updatedAtobjectOptional
get
/getFabricSimByName/{name}
200

OK

delFabricSim

delete
Path parameters
namestringRequired
Responses
chevron-right
200

OK

application/json
stringOptional
delete
/delFabricSim/{name}
200

OK

updateFabricSimStatus

post
Body
namestringOptional
statusstringOptional
Responses
chevron-right
200

OK

application/json
stringOptional
post
/updateFabricSimStatus
200

OK

addInventoryData

post
Bodyobject[]
SpinesintegerOptional
LeafsintegerOptional
SSpinesintegerOptional
TorsintegerOptional
HostsintegerOptional
Responses
chevron-right
200

OK

application/json
stringOptional
post
/addInventoryData
200

OK

updateInventoryData

post
Bodyobject[]
fabricNamestringOptional
hostnamestringOptional
ipAddressstringOptional
usernamestringOptional
passwordstringOptional
Responses
chevron-right
200

OK

application/json
stringOptional
post
/updateInventoryData
200

OK

updateFabricStatus

post
Body
namestringOptional
statusstringOptional
intentstringOptional
descriptionstringOptional
Responses
chevron-right
200

OK

application/json
stringOptional
post
/updateFabricStatus
200

OK

getAllInventory

get
Responses
chevron-right
200

OK

application/json
SpinesintegerOptional
LeafsintegerOptional
SSpinesintegerOptional
TorsintegerOptional
HostsintegerOptional
get
/getAllInventory
200

OK

getInventoryByFabricName

get
Path parameters
namestringRequired
Responses
chevron-right
200

OK

application/json
SpinesintegerOptional
LeafsintegerOptional
SSpinesintegerOptional
TorsintegerOptional
HostsintegerOptional
get
/getInventoryByFabricName/{name}
200

OK

getTenants

get
Path parameters
fabricNamestringRequired
Responses
chevron-right
200

OK

application/json
Other propertiesobjectOptional
get
/fabrics/{fabricName}/tenants
200

OK

createTenant

post
Path parameters
fabricNamestringRequired
Body
objectOptional
Responses
chevron-right
200

OK

application/json
stringOptional
post
/fabrics/{fabricName}/tenants
200

OK

getTenantGPUs

get
Path parameters
tenantNamestringRequired
fabricNamestringRequired
Responses
chevron-right
200

OK

application/json
Other propertiesobjectOptional
get
/fabrics/{fabricName}/tenants/{tenantName}
200

OK

delTenant

delete
Path parameters
fabricNamestringRequired
tenantNamestringRequired
Responses
chevron-right
200

OK

application/json
stringOptional
delete
/fabrics/{fabricName}/tenants/{tenantName}
200

OK

updateTenant

patch
Path parameters
fabricNamestringRequired
tenantNamestringRequired
Body
objectOptional
Responses
chevron-right
200

OK

application/json
stringOptional
patch
/fabrics/{fabricName}/tenants/{tenantName}
200

OK

createVpcPeering

post
Path parameters
fabricNamestringRequired
Body
namestringOptional
vpcnamestringOptional
peervpcnamestringOptional
Responses
chevron-right
200

OK

application/json
stringOptional
post
/fabrics/{fabricName}/vpcpeering
200

OK

getFabricDevices

get
Path parameters
fabricNamestringRequired
Responses
chevron-right
200

OK

application/json
string[]Optional
get
/getFabricDevices/{fabricName}
200

OK

getDevicesByLayer

get
Query parameters
layerstringRequired
Responses
chevron-right
200

OK

application/json
string[]Optional
get
/getDevicesByLayer
200

OK

getAvailableServers

get
Path parameters
fabricNamestringRequired
Responses
chevron-right
200

OK

application/json
availableGPUsstring[]Optional
get
/fabrics/{fabricName}/available_servers
200

OK

getGpusByHost

get
Path parameters
hostNamestringRequired
fabricNamestringRequired
Responses
chevron-right
200

OK

application/json
idintegerOptional
gpuPortstringOptional
gpuHostnamestringOptional
gpuStatusstringOptional
gpuLeafIntstringOptional
suIdintegerOptional
leafHostnamestringOptional
leafIpAddressstringOptional
tenantNamestringOptional
fabricNamestringOptional
config_statusstringOptional
lastConfiguredTenantstringOptional
createdAtobjectOptional
updatedAtobjectOptional
get
/getGpusByHost/{hostName}/{fabricName}
200

OK

autoAllocateGpusToTenants

post
Body
fabricNamestringOptional
autoAllocationDevicesNeedintegerOptional
tenantNamestringOptional
portsstring[]Optional
Responses
chevron-right
200

OK

application/json
booleanOptional
post
/autoAllocateGpusToTenants
200

OK

getAllGpusList

get
Path parameters
fabricNamestringRequired
Responses
chevron-right
200

OK

application/json
idintegerOptional
gpuPortstringOptional
gpuHostnamestringOptional
gpuStatusstringOptional
gpuLeafIntstringOptional
suIdintegerOptional
leafHostnamestringOptional
leafIpAddressstringOptional
tenantNamestringOptional
fabricNamestringOptional
config_statusstringOptional
lastConfiguredTenantstringOptional
createdAtobjectOptional
updatedAtobjectOptional
get
/getAllGpusList/{fabricName}
200

OK

getGpuAllocationHistory

get
Path parameters
fabricNamestringRequired
tenantNamestringRequired
Responses
chevron-right
200

OK

application/json
idintegerOptional
suNumberintegerOptional
hostNamestringOptional
gpusAddedstringOptional
gpusRemovedstringOptional
tenantNamestringOptional
fabricNamestringOptional
createdAtobjectOptional
updatedAtobjectOptional
get
/fabrics/{fabricName}/tenants/{tenantName}/gpuAllocationHistory
200

OK

getUIObject

get
Query parameters
namestringOptional
Responses
chevron-right
200

OK

application/json
idintegerOptional
namestringOptional
fabricIdintegerOptional
orchestrationModestringOptional
sspineCountintegerOptional
spineCountintegerOptional
leafCountintegerOptional
fecstringOptional
mtustringOptional
adminStatusstringOptional
asnSSpinestringOptional
isAsnSSpineUniquebooleanOptional
asnLeafstringOptional
isAsnLeafUniquebooleanOptional
asnSpinestringOptional
isAsnSpineUniquebooleanOptional
ntpServerstringOptional
timezonestringOptional
sysLogServerstringOptional
snmpServerstringOptional
v4SpineLeafPoolstringOptional
v6SpineLeafPoolstringOptional
v4LoopbackPoolstringOptional
v6LoopbackPoolstringOptional
v4LeafTorPoolstringOptional
v6LeafTorPoolstringOptional
v4HostPoolstringOptional
v6HostPoolstringOptional
isBGP_UbooleanOptional
isTorPresentbooleanOptional
ND_RAintegerOptional
isactivebooleanOptional
lastupdatedobjectOptional
logsstringOptional
issagbooleanOptional
sflowcollector1stringOptional
sflowport1stringOptional
sflowcollector2stringOptional
sflowport2stringOptional
isL2LSEnabledbooleanOptional
dhcpServerIpsstringOptional
dhcpRelaySrcInterfacestringOptional
dhcpRelaySrcInterfaceIPstringOptional
l2lsmodestringOptional
get
/getUIObject
200

OK

getLastOrchestratedIntentName

get
Responses
chevron-right
200

OK

application/json
stringOptional
get
/getLastOrchestratedIntentName
200

OK

getFMInventory

get
Responses
chevron-right
200

OK

application/json
ipAddressstringOptional
hostnamestringOptional
layerstringOptional
get
/fm-Inventory
200

OK

restoreconfig

post
Bodyobject[]
ipstringOptional
timestampstringOptional
Responses
chevron-right
200

OK

application/json
booleanOptional
post
/restoreconfig
200

OK

fillbootstrapconfig

post
Body
batchNamestringOptional
subnetstringOptional
netmaskstringOptional
gatewaystringOptional
Responses
chevron-right
200

OK

application/json
booleanOptional
post
/fillbootstrapconfig
200

OK

triggerbootstrapconfig

post
Body
batchNamestringOptional
subnetstringOptional
netmaskstringOptional
gatewaystringOptional
Responses
chevron-right
200

OK

application/json
Other propertiesobjectOptional
post
/triggerbootstrapconfig
200

OK

getbootstrapinfo

get
Responses
chevron-right
200

OK

application/json
idintegerOptional
deviceMacAddressstringOptional
serialstringOptional
deviceIpstringOptional
hostnamestringOptional
regionstringOptional
layerstringOptional
azidstringOptional
rackidstringOptional
brickidstringOptional
groupidstringOptional
paramspathstringOptional
bootfilepathstringOptional
nosImagePathstringOptional
agentImagePathstringOptional
fmcliImagePathstringOptional
baseConfigDbPathstringOptional
baseConfigFmPathstringOptional
statusintegerOptional
batchNamestringOptional
lastupdatedobjectOptional
collectorIPstringOptional
fabricidstringOptional
vendorstringOptional
get
/getbootstrapinfo
200

OK

fillrmaconfig

post
Bodyobject[]
idintegerOptional
replacingDeviceMacstringOptional
replacingDeviceIpstringOptional
replacingDeviceSerialstringOptional
replacetoDeviceMacstringOptional
replacetoDeviceIpstringOptional
replacetoDeviceSerialstringOptional
fabricIdstringOptional
statestringOptional
markedTimestringOptional
ticketIdstringOptional
backupSelectedstringOptional
scheduledTimestringOptional
isScheduledForLaterbooleanOptional
triggertimestringOptional
Responses
chevron-right
200

OK

application/json
booleanOptional
post
/fillrmaconfig
200

OK

triggerrma

post
Bodyobject[]
idintegerOptional
replacingDeviceMacstringOptional
replacingDeviceIpstringOptional
replacingDeviceSerialstringOptional
replacetoDeviceMacstringOptional
replacetoDeviceIpstringOptional
replacetoDeviceSerialstringOptional
fabricIdstringOptional
statestringOptional
markedTimestringOptional
ticketIdstringOptional
backupSelectedstringOptional
scheduledTimestringOptional
isScheduledForLaterbooleanOptional
triggertimestringOptional
Responses
chevron-right
200

OK

application/json
booleanOptional
post
/triggerrma
200

OK

getrmainfo

get
Responses
chevron-right
200

OK

application/json
idintegerOptional
replacingDeviceMacstringOptional
replacingDeviceIpstringOptional
replacingDeviceSerialstringOptional
replacetoDeviceMacstringOptional
replacetoDeviceIpstringOptional
replacetoDeviceSerialstringOptional
fabricIdstringOptional
statestringOptional
markedTimestringOptional
ticketIdstringOptional
backupSelectedstringOptional
scheduledTimestringOptional
isScheduledForLaterbooleanOptional
triggertimestringOptional
get
/getrmainfo
200

OK

getrmastatus

get
Query parameters
rmaInfoIdintegerRequired
Responses
chevron-right
200

OK

application/json
idintegerOptional
rmainfoIdintegerOptional
taskstringOptional
statusintegerOptional
starttimestringOptional
endtimestringOptional
logsstringOptional
tasktitlestringOptional
get
/getrmastatus
200

OK

fetchDeviceBackupFiles

post
Body
ipstringOptional
timestampstringOptional
Responses
chevron-right
200

OK

application/json
objectOptional
post
/fetchdevicebackupfiles
200

OK

configslisttorestore

post
Body
devicesstring[]Optional
onlylimitedbooleanOptional
Responses
chevron-right
200

OK

application/json
stringOptional
post
/configslisttorestore
200

OK

backupConfig

post
Bodyobject[]
ipstringOptional
labelstringOptional
Responses
chevron-right
200

OK

application/json
booleanOptional
post
/backupConfig
200

OK

replaceConfig

post
Query parameters
deviceipstringRequired
onlydiffbooleanOptional
Body
filestringRequired
Responses
chevron-right
200

OK

application/json
objectOptional
post
/replaceConfig
200

OK

markForStreaming

get
Query parameters
filenamestringRequired
Responses
chevron-right
200

OK

application/json
stringOptional
get
/start
200

OK

stopStreaming

get
Query parameters
filenamestringRequired
Responses
chevron-right
200

OK

application/json
stringOptional
get
/stop
200

OK

getconfig

get
Query parameters
deviceipstringRequired
Responses
chevron-right
200

OK

application/json
objectOptional
get
/getconfig
200

OK

getLogLevel

get
Responses
chevron-right
200

OK

application/json
Other propertiesstringOptional
get
/log/level
200

OK

changeLogLevel

post
Body
Other propertiesstringOptional
Responses
chevron-right
200

OK

application/json
stringOptional
post
/log/level
200

OK

uploadFile

post
Query parameters
filetypestringRequired
Body
filestringRequired
versionstringOptional
vendorstringOptional
tagstringOptional
Responses
chevron-right
200

OK

application/json
Other propertiesobjectOptional
post
/uploadfile
200

OK

getFilesByType

get
Path parameters
filetypestringRequired
Responses
chevron-right
200

OK

application/json
Other propertiesobjectOptional
get
/getfiles/{filetype}
200

OK

deleteFile

delete
Path parameters
idintegerRequired
Responses
chevron-right
200

OK

application/json
Other propertiesobjectOptional
delete
/deletefile/{id}
200

OK

updateRoleInfo

post
Body
Other propertiesobjectOptional
Responses
chevron-right
200

OK

application/json
stringOptional
post
/updateroleinfo
200

OK

getAllBootstrapBatches

get
Responses
chevron-right
200

OK

application/json
Other propertiesobjectOptional
get
/getAllBootstrapBatches
200

OK

getBootstrapBatch

get
Path parameters
batchNamestringRequired
Responses
chevron-right
200

OK

application/json
Other propertiesobjectOptional
get
/getBootstrapBatch/{batchName}
200

OK

getDeviceBootstrapStages

get
Path parameters
bootstrapIdintegerRequired
Responses
chevron-right
200

OK

application/json
Other propertiesobjectOptional
get
/getDeviceBootstrapStages/{bootstrapId}
200

OK

Last updated