Skip to content

zen_branch_maps

Overview

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

Version information

Version : v2

URI scheme

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

Tags

  • zen_branch_maps : Operations related to zen_branch_maps

Paths

POST operation for zen_branch_maps

POST /zen_branch_maps

Description

Use this operation to add zen branch map entry

Parameters

Type Name Schema
Body body
optional
zen_branch_maps_request_schema

Responses

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

Consumes

  • application/json

Produces

  • application/json

Tags

  • zen_branch_maps

Get operation for zen_branch_maps

GET /zen_branch_maps

Description

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

Responses

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

  • zen_branch_maps

PUT operation for zen_branch_maps

PUT /zen_branch_maps

Description

Use this operation to modify a zen branch map entry

Responses

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

Produces

  • application/json

Tags

  • zen_branch_maps

DELETE operation for zen_branch_maps

DELETE /zen_branch_maps/{deletePathParam}

Description

Use this operation to delete a zen 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 zen_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

  • zen_branch_maps

Definitions

ErrorSchema

Name Schema
errorcode
optional
integer
errormessage
optional
string

app_object

Application object name

Type : string

fqdn_id

unique id for the FQDN name

Type : integer

id

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

Type : integer

location_id

location id generated by zscaler portal

Type : integer

package_name

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

Type : string

primary_vpn

primary vpn name

Type : string

secondary_vpn

secondary vpn name

Type : string

sitename

Sitename

Type : string

tunnel_id

parent key, tunnel-id

Type : integer

vpn_id

vpn credential id generated by zscaler portal

Type : integer

vpn_psk

vpn credential psk for the tunnel

Type : string

wanlink name

Type : string

zen_branch_maps

Name Schema
app_object
optional
app_object
fqdn_id
optional
fqdn_id
id
optional
id
location_id
optional
location_id
package_name
optional
package_name
primary_vpn
optional
primary_vpn
secondary_vpn
optional
secondary_vpn
sitename
optional
sitename
tunnel_id
optional
tunnel_id
vpn_id
optional
vpn_id
vpn_psk
optional
vpn_psk
wanlink
optional
wanlink

zen_branch_maps_delete_success_schema

Name Schema
zen_branch_maps
optional
zen_branch_maps

zen_branch_maps

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

zen_branch_maps_post_success_schema

Name Schema
zen_branch_maps
optional
zen_branch_maps

zen_branch_maps

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

zen_branch_maps_put_success_schema

Name Schema
zen_branch_maps
optional
zen_branch_maps

zen_branch_maps

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

zen_branch_maps_request_schema

Name Schema
zen_branch_maps
optional
zen_branch_maps

zen_branch_maps_response_schema

Type : < zen_branch_maps_response_schema > array

zen_branch_maps_response_schema

Name Schema
app_object
optional
app_object
fqdn_id
optional
fqdn_id
id
optional
id
location_id
optional
location_id
package_name
optional
package_name
primary_vpn
optional
primary_vpn
secondary_vpn
optional
secondary_vpn
sitename
optional
sitename
tunnel_id
optional
tunnel_id
vpn_id
optional
vpn_id
vpn_psk
optional
vpn_psk
wanlink
optional
wanlink