Get Community List (v2.0)

GET 
/v2.0/api/tenants/:tenant_id/sites/:site_id/elements/:element_id/routing_ipcommunitylists/:config_id

Lists a specific community list.

Request

Path Parameters

tenant_id stringrequired

ID of the tenant.

site_id stringrequired

The ID of the site.

element_id stringrequired

The ID of the element.

config_id stringrequired

The BGP peer config ID.

Responses

200

Successful Operation

application/json

Schema

Schema

auto_generated boolean

The value true or false for auto-generated IP community lists.

community_list RoutingIPCommunity[]
The details of the IP community lists.
Array [
community_str stringrequired
The community string. Max size = 256.
permit boolean
The permit of the IP community sctring = Permit or Deny.
]
description

The description of the IP community list. Max size = 1024.

id string

The ID of the IP community list.

name stringrequired

The name of the IP community list. Max size = 128.

tags string[]

A information field that can be added to identify the IP community list. Maximum 10 unique tags of length 1024 each are allowed.

Example (from schema)

{
  "auto_generated": true,
  "community_list": [
    {
      "community_str": "string",
      "permit": true
    }
  ],
  "id": "string",
  "name": "string",
  "tags": [
    "string"
  ]
}

Loading...