Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

 

POST /ariel/flow_vlans

 

Creates a new flow VLAN field as specified by input parameters.

Table 1: POST /ariel/flow_vlans Resource Details

MIME Type

application/json

Table 2: POST /ariel/flow_vlans Request Parameter Details

Parameter

Type

Optionality

Data Type

MIME Type

Description

fields

header

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: POST /ariel/flow_vlans Request Body Details

Parameter

Data Type

MIME Type

Description

Sample

body

Object

application/json

Only the enterprise VLAN ID and customer VLAN ID can be set when creating a new flow VLAN field. All other fields are ignored.

  • id - Int - The ID of the flow VLAN field. Cannot be updated by POST.

  • enterprise_vlan_id - Short - The enterprise VLAN ID for the flow VLAN domain configuration field. The value must be in the range 0 - 4095, where 0 indicates the enterprise VLAN field is non-existent.

  • customer_vlan_id - Short - The customer VLAN ID for the flow VLAN domain configuration field. The value must be in the range 1 - 4095.

{ "customer_vlan_id": 42, "enterprise_vlan_id": 42, "id": 42 }

Table 4: POST /ariel/flow_vlans Response Codes

HTTP Response Code

Unique Code

Description

201

 

The flow VLAN field has been successfully created.

409

1020

A flow VLAN ID object parameter already exists and belongs to a domain.

422

1022

The VLAN provided was invalid. Customer VLAN ID must be between 1 and 4095.

422

1023

The VLAN provided was invalid. Enterprise VLAN ID must be between 0 and 4095 and customer VLAN ID must be between 1 and 4095.

422

1024

The VLAN provided was invalid. Enterprise VLAN ID must be between 0 and 4095.

500

1025

An error occurred while the flow VLAN field was being created.

Response Description

New flow VLAN ID object. A flow VLAN ID object contains the following fields:

  • id - Int - 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