multicast_group_list

List multicast groups
get/v1/multicast-groups

Query Parameters

limit

Maximum number of items returned by a single call

page_token

Token returned by previous call to retrieve the subsequent page

sort_by

Supported set of sort modes for scanning by name or id

Responses

Object
items

list of items on this page of results

View of a Multicast Group

Object
description

human-readable free-form text about a resource

id

unique, immutable, system-controlled identifier for each resource

ip_pool_id

The ID of the IP pool this resource belongs to.

multicast_ip

The multicast IP address held by this resource.

mvlan

Multicast VLAN (MVLAN) for egress multicast traffic to upstream networks. None means no VLAN tagging on egress.

name

unique, mutable, user-controlled identifier for each resource

Names must begin with a lower case ASCII letter, be composed exclusively of lowercase ASCII, uppercase ASCII, numbers, and '-', and may not end with a '-'. Names cannot be a UUID, but they may contain a UUID. They can be at most 63 characters long.

source_ips

Union of all member source IP addresses (computed, read-only).

This field shows the combined source IPs across all group members. Individual members may subscribe to different sources; this union reflects all sources that any member is subscribed to. Empty array means no members have source filtering enabled.

state

Current state of the multicast group.

time_created

timestamp when this resource was created

time_modified

timestamp when this resource was last modified

next_page

token used to fetch the next page of results (if any)