API Guide

17. MULTI-TENANCY
APIs for Tenants and VxLAN segments, in a fabric intent.
17.1 GET /fabric-intents/{fabric-intent-id}/tenants
Details of all the tenants using the fabric.
This API will list all the tenants that are using the fabric managed by SFD.
REQUEST
PATH PARAMETERS
NAME TYPE DESCRIPTION
*fabric-intent-id string
Unique identier of the fabric intent
RESPONSE
STATUS CODE - 200: Response to get a list of all tenants using the fabric.
RESPONSE MODEL - application/json
{
List of all tenants using the fabric.
data [{
Array of object: Represents a tenant using the fabric.
id string
Unique identier of the tenant
fabric-intent-id string
Unique identier of the fabric intent that denes the fabric conguration used by the tenant.
l3-vni integer
L3 VNI of tenant
irb_type enum ALLOWED:SYMMETRIC, ASYMMETRIC
The distributed routing type:SYMMETRIC/ASYMMETRIC.
vm_manager {
The VM manager this Tenant is associated to.
id string
Unique identied of the VM manager.
name string
Name of the VM manager.
}
name* string
Name of the tenant
description string
Optional description for the tenant.
}]
}
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.
219 of 340