POST /ariel/flow_vlans
Creates a new flow VLAN field as specified by input parameters.
MIME Type |
---|
application/json |
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. |
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.
|
{ "customer_vlan_id": 42, "enterprise_vlan_id": 42, "id": 42 } |
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
- 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
{
"customer_vlan_id": 42,
"enterprise_vlan_id": 42,
"id": 42
}