Topology Groups

Topology Groups define the overlay topology (hub-spoke, mesh, etc.) for SD-WAN. Unlike Config and Policy Groups, Topology Groups do not have device association endpoints — they apply at the fabric level.

Create a Topology Group

POST/v1/topology-groupCreate topology group

Headers

X-XSRF-TOKEN: <X-XSRF-TOKEN>
Authorization: Bearer {{apikey}}
Content-Type: application/json

Request body

{
  "name": "Hub-Spoke-Topology",
  "description": "Hub-spoke topology for branch-to-DC connectivity",
  "solution": "sdwan",
  "topology": {
    "devices": [
      {
        "criteria": {
          "tag": {
            "key": "role",
            "value": "hub"
          }
        },
        "unsupportedFeatures": []
      },
      {
        "criteria": {
          "tag": {
            "key": "role",
            "value": "spoke"
          }
        },
        "unsupportedFeatures": []
      }
    ],
    "siteDevices": 2
  }
}

Field	Type	Required	Description
name	string	✅	Unique name
description	string	✅	Description
solution	string	✅	sdwan only
topology	object	❌	Topology definition
topology.devices[]	array	❌	Device selection criteria (tag-based)
topology.devices[].criteria	object	❌	Tag-based device matching
topology.devices[].unsupportedFeatures	array	❌	Features not supported on this device role
topology.siteDevices	integer	❌	Number of devices per site (1–20)

Response — 200 OK:

{
  "id": "tg-uuid-0001-0002-0003-000000000001"
}

---

List / Get / Edit / Delete

Operation	Method	Endpoint
List all	GET	/v1/topology-group
Get by ID	GET	/v1/topology-group/{topologyGroupId}
Edit	PUT	/v1/topology-group/{topologyGroupId}
Delete	DELETE	/v1/topology-group/{topologyGroupId}

---

Deploy / Deactivate Topology

POST/v1/topology-group/{topologyGroupId}/deployDeploy or deactivate topology

Headers

X-XSRF-TOKEN: <X-XSRF-TOKEN>
Authorization: Bearer {{apikey}}
Content-Type: application/json

Deploy:

Request body

{}

Deactivate:

Request body

{
  "deactivateTopology": true
}

Response — 200 OK:

{
  "parentTaskId": "task-uuid-topo-deploy-001"
}

💡 Tip: Set "deactivateTopology": true to remove/deactivate the topology overlay without deleting the group definition.

---

Preview Topology

POST/v1/topology-group/{topologyGroupId}/previewPreview topology

Headers

X-XSRF-TOKEN: <X-XSRF-TOKEN>
Authorization: Bearer {{apikey}}
Content-Type: application/json

Request body

Empty {} or with optional preview parameters.

Response — 200 OK: Returns a preview of the topology configuration that would be applied.