Get Access List for Element (v2.1)

GET 
/v2.1/api/tenants/:tenant_id/sites/:site_id/elements/:element_id/routing_aspathaccesslists

List all the access lists for the element.

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.

Responses

200

Successful Operation

application/json

Schema

Schema

• Array [
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 lists.

description

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

id string

The ID of the access list.

name stringrequired

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

tags string[]

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

• ]
count int32

The actual count.

id string

The ID.

tenant_id string

The tenant ID.

items RoutingAccessListV2N1[]
Array [
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 lists.
description
The description of the access list. Max size = 1024.
id string
The ID of the access list.
name stringrequired
The name of the access list. Max size = 128.
tags string[]
A information field that can be added to identify the access list. Maximum 10 unique tags of length 1024 each are allowed.
]

Example (from schema)

{
  "count": 0,
  "id": "string",
  "tenant_id": "string",
  "items": [
    {
      "as_path_regex_list": [
        {
          "as_path_regex": "string",
          "order": 0,
          "permit": true
        }
      ],
      "auto_generated": 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_ASSIGNED_TO_SITE"
      }
    ]
  }
}

Loading...