HomeGuidesAPI Reference
GuidesAPI ReferenceGitHubAirheads Developer CommunityLog In
API Reference
GuidesAPI ReferenceGitHubAirheads Developer Community

Create branch/micro-branch configuration

post
https://{api-base-url}/sdwan-config/v1/node_list///config/branch-config/

Data Center configuration for Branch/Microbranch groups. Branch/Microbranch groups can be configured using individual VPNC devices ('hubs' with 'hubs-type' set to HUB_TYPE_DEVICE) or VPNC clusters ('hub-clusters' with 'hubs-type' set to HUB_TYPE_CLUSTER)

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
enum
required

Defines the type of configuration node to which the config is being applied.

Allowed:
string
required

The value of the identifer for the configuration container. This value is interpreted according to node-type above. Invalid combinations of node-type and node-id will be rejected.

Body Params

JSON representation of branch-config config

string
enum
Defaults to HUB_TYPE_DEVICE

This indicates whether DC Preference uses induvidual VPNC devices ('hubs' list) or VPNC Clusters ('hub-clusters' list). Value 'HUB_TYPE_DEVICE' is used to indicate 'hubs' is configured. Value 'HUB_TYPE_CLUSTER' is used to indicate 'hub-clusters' is configured

Allowed:
hubs
array of objects
length ≤ 32

An ordered list of VPNC device identifiers.This can be configured only if 'hubs-type' is set to 'HUB_TYPE_DEVICE' under branch-config. The VPNC devices must be ordered such that devices belonging to same group are contiguous

hubs
string
enum
Defaults to CORRECT_ORDER

Read-only field to indicate if VPNCs in 'hubs' list are in correct order as per their Data-Center (Group) membership. VPNCs belonging to same group must be consecutive entries in 'hubs' list. If not, the load-balancing will not work as expected. The VPNCs in 'hubs' list should be re-ordered in such cases

Allowed:
hub-clusters
array of objects
length ≤ 8

An ordered list of VPNC clusters. This can be configured only if 'hubs-type' is set to 'HUB_TYPE_CLUSTER' under branch-config

hub-clusters
Responses

401

Unauthorized

403

Forbidden

413

Request-size limit exceeded

417

Request-size limit exceeded

429

API Rate limit exceeded

Updated about 2 years ago

Language
Credentials
Bearer
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 2 years ago