Get Multicast Peer Groups (v2.1)

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

List all the multicast peer groups.

Request

Path Parameters

tenant_id stringrequired

The tenant ID.

Responses

200

Successful Operation

application/json

Schema

Schema

count int32

The actual count.

id string

The ID.

tenant_id string

The tenant ID.

items MulticastPeerGroupV2N1[]
Array [
description
The description of the multicast peer group. Max size = 256.
id string
The ID.
is_source_site_receiver boolean
True or False - Receive traffic from branch side sources to receive multicast traffic from another branch site.
name stringrequired
The name of the multicast peer group.
peer_sites MulticastPeerSite[]required
The peer sites ID.
Array [
peer_site_id string
The peer site ID.
]
tags string[]
An information field that can be added to identify the multicast peer group.
]

Example (from schema)

{
  "count": 0,
  "id": "string",
  "tenant_id": "string",
  "items": [
    {
      "id": "string",
      "is_source_site_receiver": true,
      "name": "string",
      "peer_sites": [
        {
          "peer_site_id": "string"
        }
      ],
      "tags": [
        "string"
      ]
    }
  ]
}

Loading...