Skip to content

virtual_path_default_set

Overview

API to add, modify, get, delete Virtual Path Default Set

Version information

Version : v2

URI scheme

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

Tags

  • virtual_path_default_set : Operations related to virtual_path_default_set

Paths

POST operation for virtual_path_default_set

POST /virtual_path_default_set

Description

Use this operation to add Virtual Path Default Set

Parameters

Type Name Schema
Body body
optional
virtual_path_default_set_request_schema

Responses

HTTP Code Description Schema
200 Resource successfully added virtual_path_default_set_post_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

Get operation for virtual_path_default_set

GET /virtual_path_default_set

Description

Use this operation to get the list of Virtual Path Default Sets

Responses

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

PUT operation for virtual_path_default_set

PUT /virtual_path_default_set

Description

Use this operation to modify Virtual Path Default Set

Responses

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

Produces

  • application/json

Tags

  • virtual_path_default_set

DELETE operation for virtual_path_default_set

DELETE /virtual_path_default_set/{deletePathParam}

Description

Use this operation to delete Virtual Path Default Set

Parameters

Type Name Description Schema
Path deletePathParam
required
Object Primary Key for DELETE operation object

Responses

HTTP Code Description Schema
200 Resource delete added virtual_path_default_set_delete_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

Produces

  • application/json

Tags

  • virtual_path_default_set

Definitions

ErrorSchema

Name Schema
errorcode
optional
integer
errormessage
optional
string

id

Auto-generated ID to uniquely identify Virtual Path Default Set

Type : integer

name

The name for this Virtual Path Default Set

Type : string

package_name

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

Type : string

virtual_path_default_set

Name Schema
id
optional
id
name
optional
name
package_name
optional
package_name

virtual_path_default_set_delete_success_schema

Name Schema
virtual_path_default_set
optional
virtual_path_default_set

virtual_path_default_set

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

virtual_path_default_set_post_success_schema

Name Schema
virtual_path_default_set
optional
virtual_path_default_set

virtual_path_default_set

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

virtual_path_default_set_put_success_schema

Name Schema
virtual_path_default_set
optional
virtual_path_default_set

virtual_path_default_set

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

virtual_path_default_set_request_schema

Name Schema
virtual_path_default_set
optional
virtual_path_default_set

virtual_path_default_set_response_schema

Type : < virtual_path_default_set_response_schema > array

virtual_path_default_set_response_schema

Name Schema
id
optional
id
name
optional
name
package_name
optional
package_name