Get Path Groups for Tenant (v2.1)

GET 
/v2.1/api/tenants/:tenant_id/pathgroups

List all the path groups for a tenant.

Request

Path Parameters

tenant_id stringrequired

ID of the tenant.

Responses

200

Successful Operation

application/json

Schema

Schema

count int32

The actual count.

id string

The ID.

tenant_id string

The tenant ID.

items PathGroup[]
Array [
description
The description of the path group. Max length 256.
id string
The ID of the path group.
name string
The name of the path group. Max length 128.
paths WANPath[]
List of paths in the group.
Array [
label string
The label to identify the path.
path_type stringrequired
Possible values: [vpn, direct, servicelink]
The path type.
]
]

Example (from schema)

{
  "count": 0,
  "id": "string",
  "tenant_id": "string",
  "items": [
    {
      "id": "string",
      "name": "string",
      "paths": [
        {
          "label": "string",
          "path_type": "vpn"
        }
      ]
    }
  ]
}

Loading...