Update Multicast Peer Group (v2.0)

PUT 
/v2.0/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 multicast peer group descriptions.

id string

The multicast peer group ID.

name stringrequired

The name of the multicast peer group. Max limit = 128.

peer_sites MulticastPeerSite[]required
The multicast peer site ID.
Array [
peer_site_id string
The peer site ID.
]
tags string[]

A information field that can be added to identify the multicast peer group. Maximum 10 unique tags of length 128 each are allowed.

Responses

200

Successful Operation

application/json

Schema

Schema

description

The multicast peer group descriptions.

id string

The multicast peer group ID.

name stringrequired

The name of the multicast peer group. Max limit = 128.

peer_sites MulticastPeerSite[]required
The multicast peer site ID.
Array [
peer_site_id string
The peer site ID.
]
tags string[]

A information field that can be added to identify the multicast peer group. Maximum 10 unique tags of length 128 each are allowed.

Example (from schema)

{
  "id": "string",
  "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...