Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

 

GET /ariel/flow_vlans

 

Retrieves a list of available flow VLAN IDs in the Ariel database.

Retrieves a list of available flow VLAN IDs in the Ariel database.

Table 1: GET /ariel/flow_vlans Resource Details

MIME Type

application/json

Table 2: GET /ariel/flow_vlans Request Parameter Details

Parameter

Type

Optionality

Data Type

MIME Type

Description

Range

header

Optional

String

text/plain

Optional - Use this parameter to restrict the number of elements that are returned in the list to a specified range. The list is indexed starting at zero.

filter

query

Optional

String

text/plain

Optional - This parameter is used to restrict the elements in a list base on the contents of various fields.

fields

query

Optional

String

text/plain

Optional - Use this parameter to specify which fields you would like to get back in the response. Fields that are not named are excluded. Specify subfields in brackets and multiple fields in the same object are separated by commas.

Table 3: GET /ariel/flow_vlans Response Codes

HTTP Response Code

Unique Code

Description

200

 

The flow VLAN ID list was retrieved.

500

1000

An error occurred while the flow VLAN ID list was being retrieved.

Response Description

An array of flow VLAN ID objects. A flow VLAN ID object contains the following fields:

  • id - Long - The ID of the flow VLAN field.

  • enterprise_vlan_id - Short - The enterprise VLAN ID.

  • customer_vlan_id - Short - The customer VLAN ID.

Response Sample