Skip to content

virtual_path_default_set_advanced_settings

Overview

API to modify, get Virtual Path Default Set Advanced settings

Version information

Version : v2

URI scheme

Host :
BasePath : /sdwan/nitro/v2/config_editor/
Schemes : HTTP

Tags

  • virtual_path_default_set_advanced_settings : Operations related to virtual_path_default_set_advanced_settings

Paths

Get operation for virtual_path_default_set_advanced_settings

GET /virtual_path_default_set_advanced_settings

Description

Use this operation to get the Virtual Path Default Set Advanced settings

Responses

HTTP Code Description Schema
200 API Successfully executed virtual_path_default_set_advanced_settings_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

  • virtual_path_default_set_advanced_settings

PUT operation for virtual_path_default_set_advanced_settings

PUT /virtual_path_default_set_advanced_settings

Description

Use this operation to modify Virtual Path Default Set Advanced settings

Parameters

Type Name Schema
Body body
optional
virtual_path_default_set_advanced_settings_request_schema

Responses

HTTP Code Description Schema
200 Resource modified added virtual_path_default_set_advanced_settings_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

  • virtual_path_default_set_advanced_settings

Definitions

ErrorSchema

Name Schema
errorcode
optional
integer
errormessage
optional
string

id

Auto-generated ID to uniquely identify Virtual Path Default Set Advanced setting

Type : integer

override_global_on_demand_bandwidth_limit

Override the global on-demand bandwidth limit value for the Virtual Path

Type : boolean

package_name

Config package name using which the API operation should be performed.

Type : string

standby_bandwidth_threshold_percentage

On-Demand standby links will not be activated when the WAN-to-LAN bandwidth exceeds this limit.

Type : integer

virtual_path_default_set_advanced_settings

Name Schema
id
optional
id
override_global_on_demand_bandwidth_limit
optional
override_global_on_demand_bandwidth_limit
package_name
optional
package_name
standby_bandwidth_threshold_percentage
optional
standby_bandwidth_threshold_percentage

virtual_path_default_set_advanced_settings_delete_success_schema

Name Schema
virtual_path_default_set_advanced_settings
optional
virtual_path_default_set_advanced_settings

virtual_path_default_set_advanced_settings

Name Description Schema
message
optional
Example : "resource deleted succesfully" string

virtual_path_default_set_advanced_settings_post_success_schema

Name Schema
virtual_path_default_set_advanced_settings
optional
virtual_path_default_set_advanced_settings

virtual_path_default_set_advanced_settings

Name Description Schema
message
optional
Example : "resource added succesfully" string

virtual_path_default_set_advanced_settings_put_success_schema

Name Schema
virtual_path_default_set_advanced_settings
optional
virtual_path_default_set_advanced_settings

virtual_path_default_set_advanced_settings

Name Description Schema
message
optional
Example : "resource modified succesfully" string

virtual_path_default_set_advanced_settings_request_schema

Name Schema
virtual_path_default_set_advanced_settings
optional
virtual_path_default_set_advanced_settings

virtual_path_default_set_advanced_settings_response_schema

Type : < virtual_path_default_set_advanced_settings_response_schema > array

virtual_path_default_set_advanced_settings_response_schema

Name Schema
id
optional
id
override_global_on_demand_bandwidth_limit
optional
override_global_on_demand_bandwidth_limit
package_name
optional
package_name
standby_bandwidth_threshold_percentage
optional
standby_bandwidth_threshold_percentage
virtual_path_default_set_name
optional
virtual_path_default_set_name

virtual_path_default_set_name

Virtual path default set name using which the API operation should be performed.

Type : string