API Guide

error_count integer
The count of switches where conguration has failed.
}
deployment_progression [{
Array of object: This object denes the deployment progression on the individual switch
id string
Unique identier of the switch object
name string
Name of the switch.
progress number
The conguration progress of the switch in percentage.
status enum ALLOWED:SUCCESS, IN_PROGRESS, FAILED
The conguration status on the switch.
timestamp {
Time of the start and end of deployment.
start_time integer
The time in secs since epoch at which the deployment was started.
start_time_iso string
The time, in iso format, at which the deployment was started.
end_time integer
The time in secs since epoch at which the deployment was ended.
end_time_iso string
The time, in iso format, at which the deployment was ended.
}
messages [{
Array of object: Message object to dene the id and message string
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
}]
}]
}
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
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.
143 of 340