API ReferenceNew CentralGuidesMRT APIConfiguration API
GithubAirheads Developer Community
API Reference

Create a Gateway Cluster Intent profile

List of GW Cluster Intent Profiles.

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

GW Cluster intent Profile name.

Query Params
string

LOCAL - To create local objects. SHARED - To create shared objects. Default - Defaults to SHARED if not provided

string

Scope at which local object needs to be created. Mandatory if object-type = LOCAL. Should not be provided for object-type = SHARED.

string

Device function for which the local object needs to be created. Mandatory if object_type = LOCAL. Should not be provided for object_type = SHARED.

Body Params

profilebody object

string
enum
Defaults to CM_MANUAL

Cluster-Mode decides how the cluster profiles are formed automatically. Setting cluster-mode type to CM_MANUAL will disable the auto-formation of the cluster profiles.

Show Details
CM_MANUALAuto-clustering is disabled.
CM_SITEAuto-clustering is formed at Site level.
Allowed:
boolean
Defaults to false

Enable or disable the CoA.

coa-vrrp
object

CoA-VRRP configuration

string
length between 1 and 256

User comment.

int32
500 to 65535

Minimum Heartbeat Threshold in milliseconds.

boolean
Defaults to false

Enable or disable the ipv6 mode in auto cluster profiles

int32
1 to 4094

VLAN to be used for forwarding multicast traffic to upstream router.

string
length between 1 and 63

GW Cluster intent Profile name.

Responses

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