Create IP Prefix List (v2.1)

POST 
/v2.1/api/tenants/:tenant_id/sites/:site_id/elements/:element_id/routing_prefixlists

Create an IP Prefix 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 prefix list to be created

auto_generated boolean

The value true or false for auto-generated prefix list for an element.

description

The description of the prefix filter list. Max size = 1024.

id string

The ID of the prefix filter list.

name stringrequired

The name of the prefix filter list. Max size = 128.

prefix_filter_list RoutingPrefixFilterV2N1[]
The details of the prefix filter list used to filter routes.
Array [
ge int32
The prefix filter value for ge operator should be within the range 1-32.
ipv6_prefix string
The IPv4 prefixes.
le int32
The prefix filter value for le operator should be within the range 1-32.
order int32
The order of the prefix filter.
permit boolean
The permit of the IP community string = Permit or Deny.
prefix string
The valid prefix filters.
]
tags string[]

A information field that can be added to identify the prefix filter 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 prefix list for an element.

description

The description of the prefix filter list. Max size = 1024.

id string

The ID of the prefix filter list.

name stringrequired

The name of the prefix filter list. Max size = 128.

prefix_filter_list RoutingPrefixFilterV2N1[]
The details of the prefix filter list used to filter routes.
Array [
ge int32
The prefix filter value for ge operator should be within the range 1-32.
ipv6_prefix string
The IPv4 prefixes.
le int32
The prefix filter value for le operator should be within the range 1-32.
order int32
The order of the prefix filter.
permit boolean
The permit of the IP community string = Permit or Deny.
prefix string
The valid prefix filters.
]
tags string[]

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

Example (from schema)

{
  "auto_generated": true,
  "id": "string",
  "name": "string",
  "prefix_filter_list": [
    {
      "ge": 0,
      "ipv6_prefix": "string",
      "le": 0,
      "order": 0,
      "permit": true,
      "prefix": "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": "PREFIX_LIST_PREFIX_NOT_SUPPORTED"
      }
    ]
  }
}

Loading...