config_editor_classes¶
Overview¶
API to add, modify, delete, and get configuration for Classes
Version information¶
Version : v2
URI scheme¶
Host :
BasePath : /sdwan/nitro/v2/config_editor/
Schemes : HTTP
Tags¶
- config_editor_classes : Operations related to config_editor_classes
Paths¶
Get operation for config_editor_classes¶
GET /config_editor_classes
Description¶
Use this operation to get the Classes settings
Responses¶
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | API Successfully executed | config_editor_classes_response_schema |
| 400 | Failed: bad input parameter | ErrorSchema |
| 401 | Unauthorized: Failed Authentication | ErrorSchema |
| 403 | Unauthorized: Forbidden | ErrorSchema |
| 405 | Failed: Data format unacceptable | ErrorSchema |
| 415 | Failed: Data format unacceptable | ErrorSchema |
| 500 | Failed: Internal Server Error | ErrorSchema |
Produces¶
application/json
Tags¶
- config_editor_classes
PUT operation for config_editor_classes¶
PUT /config_editor_classes
Description¶
Use this operation to modify the Classes settings
Parameters¶
| Type | Name | Schema |
|---|---|---|
| Body | body optional |
config_editor_classes_request_schema |
Responses¶
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Resource modified added | config_editor_classes_put_success_schema |
| 400 | Failed: bad input parameter | ErrorSchema |
| 401 | Unauthorized: Failed Authentication | ErrorSchema |
| 403 | Unauthorized: Forbidden | ErrorSchema |
| 405 | Failed: Data format unacceptable | ErrorSchema |
| 415 | Failed: Data format unacceptable | ErrorSchema |
| 500 | Failed: Internal Server Error | ErrorSchema |
Consumes¶
application/json
Produces¶
application/json
Tags¶
- config_editor_classes
Definitions¶
ErrorSchema¶
| Name | Schema |
|---|---|
| errorcode optional |
integer |
| errormessage optional |
string |
config_editor_classes¶
| Name | Schema |
|---|---|
| id optional |
id |
| initial_period optional |
initial_period |
| initial_rate optional |
initial_rate |
| initial_share_percent optional |
initial_share_percent |
| name optional |
name |
| package_name optional |
package_name |
| site_name optional |
site_name |
| sustained_rate optional |
sustained_rate |
| sustained_share_percent optional |
sustained_share_percent |
| type optional |
type |
| virtual_path_name optional |
virtual_path_name |
config_editor_classes_delete_success_schema¶
| Name | Schema |
|---|---|
| config_editor_classes optional |
config_editor_classes |
| Name | Description | Schema |
|---|---|---|
| message optional |
Example : "resource deleted succesfully" |
string |
config_editor_classes_post_success_schema¶
| Name | Schema |
|---|---|
| config_editor_classes optional |
config_editor_classes |
| Name | Description | Schema |
|---|---|---|
| message optional |
Example : "resource added succesfully" |
string |
config_editor_classes_put_success_schema¶
| Name | Schema |
|---|---|
| config_editor_classes optional |
config_editor_classes |
| Name | Description | Schema |
|---|---|---|
| message optional |
Example : "resource modified succesfully" |
string |
config_editor_classes_request_schema¶
| Name | Schema |
|---|---|
| config_editor_classes optional |
config_editor_classes |
config_editor_classes_response_schema¶
Type : < config_editor_classes_response_schema > array
config_editor_classes_response_schema
| Name | Schema |
|---|---|
| id optional |
id |
| initial_period optional |
initial_period |
| initial_rate optional |
initial_rate |
| initial_share_percent optional |
initial_share_percent |
| name optional |
name |
| package_name optional |
package_name |
| site_name optional |
site_name |
| sustained_rate optional |
sustained_rate |
| sustained_share_percent optional |
sustained_share_percent |
| type optional |
type |
| virtual_path_name optional |
virtual_path_name |
id¶
Class ID
Type : integer
initial_period¶
Duration to apply the Initial Rate before switching to the Sustained Rate, in milliseconds
Type : integer
initial_rate¶
The maximum rate during the Initial Period, as a percentage or in kbps
Type : integer
initial_share_percent¶
The maximum share of Virtual Path bandwidth during the Initial Period, as a percentage
Type : integer
name¶
The class name
Type : string
package_name¶
Package name
Type : string
site_name¶
Site name for corresponding class
Type : string
sustained_rate¶
The maximum rate after the Initial Period, as a percent share of the Virtual Path or in kbps
Type : integer
sustained_share_percent¶
The maximum share of Virtual Path bandwidth after the Initial Period, as a percentage
Type : integer
type¶
Class traffic type
Type : enum (realtime, interactive, bulk)
virtual_path_name¶
Virtual Path for corresponding class
Type : string