Update Multicast RP Config (v2.0)

PUT 
/v2.0/api/tenants/:tenant_id/sites/:site_id/elements/:element_id/multicastrps/:config_id

Updates the existing multicast RP config.

Request

Path Parameters

tenant_id stringrequired

ID of the tenant.

site_id stringrequired

ID of the site.

element_id stringrequired

ID of the element.

config_id stringrequired

The multicast config ID.

application/json

Body

Details of the Multicast RP config to be updated

description

The description of the multicast RP configuration.

groups Group[]required
The multicast group address. Max length 1024.
Array [
ipv4_prefix string
The IPv4 prefix of the for the multicast.
is_active_rp boolean
The Active RP for the multicast.
]
id string

The ID of the multicast RP.

ipv4_address stringrequired

The address of the IPv4.

name stringrequired

The resource name. Max length 128.

tags string[]

A information field that can be added to identify the event multicast RP config. Maximum 10 unique tags of length 1024 each are allowed.

Responses

200

Successful Operation

application/json

Schema

Schema

description

The description of the multicast RP configuration.

groups Group[]required
The multicast group address. Max length 1024.
Array [
ipv4_prefix string
The IPv4 prefix of the for the multicast.
is_active_rp boolean
The Active RP for the multicast.
]
id string

The ID of the multicast RP.

ipv4_address stringrequired

The address of the IPv4.

name stringrequired

The resource name. Max length 128.

tags string[]

A information field that can be added to identify the event multicast RP config. Maximum 10 unique tags of length 1024 each are allowed.

Example (from schema)

{
  "groups": [
    {
      "ipv4_prefix": "string",
      "is_active_rp": true
    }
  ],
  "id": "string",
  "ipv4_address": "string",
  "name": "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": "INVALID_JSON_INPUT"
      },
      {
        "code": "MULTICAST_RPCONFIG_INVALID_ADDRESS"
      },
      {
        "code": "MULTICAST_RPCONFIG_OVERLAPPING_ADDRESS"
      }
    ]
  }
}

Loading...