Update Multicast Peer Group (v2.1)

PUT 
/v2.1/api/tenants/:tenant_id/multicastpeergroups/:peer_group_id

Update a multicast peer group.

Request

Path Parameters

tenant_id stringrequired

The tenant ID.

peer_group_id stringrequired

The multicast peer group ID.

application/json

Body

Details of the multicast peer group to be updated

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.

Responses

200

Successful Operation

application/json

Schema

Schema

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)

{
  "id": "string",
  "is_source_site_receiver": true,
  "name": "string",
  "peer_sites": [
    {
      "peer_site_id": "string"
    }
  ],
  "tags": [
    "string"
  ]
}

400

Bad Request

application/json

Schema

Schema

_error ErrorResponse[]
Array [
code string
The error code.
message string
The error message.
]

Example (from schema)

{
  "_error": [
    {
      "code": "string",
      "message": "string"
    }
  ]
}

Example

{
  "value": {
    "_error": [
      {
        "code": "MULTICAST_INVALID_PEER_SITE"
      }
    ]
  }
}

Loading...