multicast_group_view

The group can be specified by name, UUID, or multicast IP address. (e.g., "224.1.2.3" or "ff38::1").

get/v1/multicast-groups/{multicast_group}

Path Parameters

multicast_group

Name, ID, or IP address of the multicast group

Can be a UUID, a name, or an IP address

Responses

200

successful operation

Object
description

Human-readable free-form text about a resource

has_any_source_member

True if any member joined without specifying source IPs (any-source).

When true, at least one member receives traffic from any source rather than filtering to specific sources.

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.

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

Deduplicated union of source IPs specified by members.

Contains only sources from members that joined with explicit source_ips. Members using any-source multicast (empty source_ips) do not contribute, so a non-empty value does not imply all members use source filtering. For SSM addresses (232/8, ff3x::/32), this is always non-empty.

state

Current state of the multicast group.

time_created

Timestamp when this resource was created

time_modified

Timestamp when this resource was last modified

4XX

Error

Object
message
request_id
5XX

Error

Object
message
request_id