instance_multicast_group_join

Groups can be referenced by name, IP address, or UUID. If the group doesn't exist, it's implicitly created with an auto-allocated IP from a multicast pool linked to the caller's silo. When referencing by UUID, the group must already exist.

Source IPs are optional for ASM addresses but required for SSM addresses (232.0.0.0/8 for IPv4, ff3x::/32 for IPv6). Duplicate IPs in the request are automatically deduplicated, with a maximum of 64 source IPs allowed.

put/v1/instances/{instance}/multicast-groups/{multicast_group}

Path Parameters

instance

Name or ID of the instance

multicast_group

Name, ID, or IP address of the multicast group

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

Query Parameters

project

Name or ID of the project

Request Body

Parameters for joining an instance to a multicast group.

When joining by IP address, the pool containing the multicast IP is auto-discovered from all linked multicast pools.

Object
ip_version

IP version for pool selection when creating a group by name. Required if both IPv4 and IPv6 default multicast pools are linked.

v4v6

The IP address version.

source_ips

Source IPs for source-filtered multicast (SSM). Optional for ASM groups, required for SSM groups (232.0.0.0/8, ff3x::/32).

Responses

Object
description

human-readable free-form text about a resource

id

unique, immutable, system-controlled identifier for each resource

instance_id

The ID of the instance that is a member of this group.

multicast_group_id

The ID of the multicast group this member belongs to.

multicast_ip

The multicast IP address of the group this member belongs to.

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

Source IP addresses for this member's multicast subscription.

  • ASM: Sources are optional. Empty array means any source is allowed. Non-empty array enables source filtering (IGMPv3/MLDv2). - SSM: Sources are required for SSM addresses (232/8, ff3x::/32).
state

Current state of the multicast group membership.

time_created

timestamp when this resource was created

time_modified

timestamp when this resource was last modified