Skip to content

wan_branch_maps

Overview

API to add, modify, delete, and get configuration for wan-branch maps

Version information

Version : v2

URI scheme

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

Tags

  • wan_branch_maps : Operations related to wan_branch_maps

Paths

POST operation for wan_branch_maps

POST /wan_branch_maps

Description

Use this operation to add wan branch map entry

Responses

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

Produces

  • application/json

Tags

  • wan_branch_maps

Get operation for wan_branch_maps

GET /wan_branch_maps

Description

Use this operation to get the list of wan branch map entry

Responses

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

  • wan_branch_maps

PUT operation for wan_branch_maps

PUT /wan_branch_maps

Description

Use this operation to modify a wan branch map entry

Parameters

Type Name Schema
Body body
optional
wan_branch_maps_request_schema

Responses

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

  • wan_branch_maps

DELETE operation for wan_branch_maps

DELETE /wan_branch_maps/{deletePathParam}

Description

Use this operation to delete a wan branch map entry

Parameters

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

Responses

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

  • wan_branch_maps

Definitions

ErrorSchema

Name Schema
errorcode
optional
integer
errormessage
optional
string

id

Auto-generated ID. Use this ID to modify or delete a wan_branch_map

Type : integer

name

Wan resource name

Type : string

package_name

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

Type : string

service_name1

Intranet Service name

Type : string

service_name2

Intranet Service name

Type : string

sitename

Sitename

Type : string

tunnel_id

parent key, tunnel-id

Type : integer

wan_branch_maps

Name Schema
id
optional
id
name
optional
name
package_name
optional
package_name
service_name1
optional
service_name1
service_name2
optional
service_name2
sitename
optional
sitename
tunnel_id
optional
tunnel_id
wanname
optional
wanname

wan_branch_maps_delete_success_schema

Name Schema
wan_branch_maps
optional
wan_branch_maps

wan_branch_maps

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

wan_branch_maps_post_success_schema

Name Schema
wan_branch_maps
optional
wan_branch_maps

wan_branch_maps

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

wan_branch_maps_put_success_schema

Name Schema
wan_branch_maps
optional
wan_branch_maps

wan_branch_maps

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

wan_branch_maps_request_schema

Name Schema
wan_branch_maps
optional
wan_branch_maps

wan_branch_maps_response_schema

Type : < wan_branch_maps_response_schema > array

wan_branch_maps_response_schema

Name Schema
id
optional
id
name
optional
name
package_name
optional
package_name
service_name1
optional
service_name1
service_name2
optional
service_name2
sitename
optional
sitename
tunnel_id
optional
tunnel_id
wanname
optional
wanname

wanname

Wan resource name

Type : string