API Guide

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.
}]
}
30.2 POST /vm-managers
Adds vCenter/NSX url and credentials provided by user.
The API to add vCenter or NSX. SFD will contact the vCenter or NSX and congures the switches for Host networks.
REQUEST
REQUEST BODY - application/json
{
Add VM Manager request object
type enum ALLOWED:VCENTER, NSX
Type of the Vm-manager. Currently vCenter and NSX are supported.
name string
Name of the VM Manager
description string
Description of the VM Manager
url string min:1 chars
URL of vCenter/NSX, expected inputs are: 1. IP Address: x.x.x.x 2. Domain Name: domain.com, domain 3. Fully
qualied url with schema: https://example.com or http://example.com By Default https schema is applied to ip
address or domain name. If user chooses to connect over http then a fully qualied url must be provided
username string min:1 chars
user id to VM Manager
password string min:1 chars
password to access the VM Manager.
}
RESPONSE
STATUS CODE - 201: New entity created successfully.
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
324 of 340