Skip to content

dynamic_virtual_paths

Overview

Dynamic Virtual Path Configuration

Version information

Version : v2

URI scheme

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

Tags

  • dynamic_virtual_paths : Operations related to dynamic_virtual_paths

Paths

Get operation for dynamic_virtual_paths

GET /dynamic_virtual_paths

Description

Use this operation to get the dynamic virtual path configuration

Responses

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

  • dynamic_virtual_paths

PUT operation for dynamic_virtual_paths

PUT /dynamic_virtual_paths

Description

Use this operation to modify the dynamic virtual path configuration

Parameters

Type Name Schema
Body body
optional
dynamic_virtual_paths_request_schema

Responses

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

  • dynamic_virtual_paths

Definitions

ErrorSchema

Name Schema
errorcode
optional
integer
errormessage
optional
string

dynamic_virtual_paths

Name Schema
enable_dynamic_virtual_path
optional
enable_dynamic_virtual_path
maximum_dynamic_virtual_path
optional
maximum_dynamic_virtual_path
package_name
optional
package_name
site_name
optional
site_name

dynamic_virtual_paths_delete_success_schema

Name Schema
dynamic_virtual_paths
optional
dynamic_virtual_paths

dynamic_virtual_paths

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

dynamic_virtual_paths_post_success_schema

Name Schema
dynamic_virtual_paths
optional
dynamic_virtual_paths

dynamic_virtual_paths

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

dynamic_virtual_paths_put_success_schema

Name Schema
dynamic_virtual_paths
optional
dynamic_virtual_paths

dynamic_virtual_paths

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

dynamic_virtual_paths_request_schema

Name Schema
dynamic_virtual_paths
optional
dynamic_virtual_paths

dynamic_virtual_paths_response_schema

Type : < dynamic_virtual_paths_response_schema > array

dynamic_virtual_paths_response_schema

Name Schema
enable_dynamic_virtual_path
optional
enable_dynamic_virtual_path
maximum_dynamic_virtual_path
optional
maximum_dynamic_virtual_path
package_name
optional
package_name
possible_endpoints
optional
possible_endpoints
site_name
optional
site_name

enable_dynamic_virtual_path

If enabled, Dynamic Virtual Paths will be allowed between this Site and other Sites connected through an intermediate node.

Type : boolean

maximum_dynamic_virtual_path

The Maximum number of Dynamic Virtual Paths allowed between this Site and other Sites connected through an intermediate node. Use 'max' to choose maximum number of dynamic virtual paths.

Type : enum (max, 1, 2, 3, 4, 5, 6, 7, 8)

package_name

Config package name using which the dynamic virtual path configuration should be performed.

Type : string

possible_endpoints

The possible endpoint sites across the Dynamic Virtual Paths, Please invoke the compile option in order to get the possible end points

Type : < string > array

site_name

The site name

Type : string