Create IP Community List (v2.0)

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

Create an IP 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.

application/json

Body

Details of the community list to be created

as_path_regex_list ASPathRegex[]
The AS Path Regex expression list.
Array [
as_path_regex stringrequired
The AS Path Regex expression.
order int32
The order of the AS Path Regex.
permit boolean
The value true or false if AS path regex is allowed.
]
auto_generated boolean

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

description

The description of the access/community list. Max size = 1024.

id string

The ID of the access/community list.

name stringrequired

The name of the access/community list. Max size = 128.

tags string[]

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

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"
  ]
}

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": "ELEMENT_NOT_FOUND"
      },
      {
        "code": "ELEMENT_NOT_ASSIGNED_TO_SITE"
      },
      {
        "code": "NOT_SUPPORTED_BY_ELEMENT"
      },
      {
        "code": "INVALID_JSON_EXTRA_ATTRIBUTE"
      },
      {
        "code": "INVALID_COMMUNITY_LIST_NAME"
      },
      {
        "code": "MAX_LIMIT_FOR_COMMUNITY_LIST_EXCEEDS"
      },
      {
        "code": "COMMUNITY_LIST_ALREADY_DEFINED"
      }
    ]
  }
}

Loading...