Skip to content

panw_branch_maps

Overview

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

Version information

Version : v2

URI scheme

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

Tags

  • panw_branch_maps : Operations related to panw_branch_maps

Paths

POST operation for panw_branch_maps

POST /panw_branch_maps

Description

Use this operation to add panw branch map entry

Parameters

Type Name Schema
Body body
optional
panw_branch_maps_request_schema

Responses

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

  • panw_branch_maps

Get operation for panw_branch_maps

GET /panw_branch_maps

Description

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

Responses

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

  • panw_branch_maps

PUT operation for panw_branch_maps

PUT /panw_branch_maps

Description

Use this operation to modify a panw branch map entry

Responses

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

  • panw_branch_maps

DELETE operation for panw_branch_maps

DELETE /panw_branch_maps/{deletePathParam}

Description

Use this operation to delete a panw 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 panw_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

  • panw_branch_maps

Definitions

ErrorSchema

Name Schema
errorcode
optional
integer
errormessage
optional
string

appobj

Application object to specify the match criteria

Type : string

bandwidth

bandwidth

Type : string

id

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

Type : integer

package_name

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

Type : string

panw_branch_maps

Name Schema
appobj
optional
appobj
bandwidth
optional
bandwidth
id
optional
id
package_name
optional
package_name
primarywanlink
optional
primarywanlink
psk
optional
psk
region
optional
region
secondarywanlink
optional
secondarywanlink
sitename
optional
sitename
tunnel_id
optional
tunnel_id

panw_branch_maps_delete_success_schema

Name Schema
panw_branch_maps
optional
panw_branch_maps

panw_branch_maps

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

panw_branch_maps_post_success_schema

Name Schema
panw_branch_maps
optional
panw_branch_maps

panw_branch_maps

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

panw_branch_maps_put_success_schema

Name Schema
panw_branch_maps
optional
panw_branch_maps

panw_branch_maps

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

panw_branch_maps_request_schema

Name Schema
panw_branch_maps
optional
panw_branch_maps

panw_branch_maps_response_schema

Type : < panw_branch_maps_response_schema > array

panw_branch_maps_response_schema

Name Schema
appobj
optional
appobj
bandwidth
optional
bandwidth
id
optional
id
package_name
optional
package_name
primarywanlink
optional
primarywanlink
psk
optional
psk
region
optional
region
secondarywanlink
optional
secondarywanlink
sitename
optional
sitename
tunnel_id
optional
tunnel_id

primary wanlink name

Type : string

psk

pre shared key for network objects

Type : string

region

VPN endpoint location

Type : string

secondary wanlink name

Type : string

sitename

Sitename

Type : string

tunnel_id

parent key, tunnel-id

Type : integer