Skip to content

Create VLAN

POST
/api/vlans
 
curl --request POST \
  --url http://localhost:3000/api/vlans \
  --header 'Content-Type: application/json' \
  --cookie session=<session> \
  --data '{ "name": "example", "vid": 1, "groupId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "siteId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "status": "active", "description": "example" }'

Authorizations

Section titled “Authorizations ”

Request Body required

Section titled “Request Body required ”
Media type application/json
object
name
required
string
vid
required
integer
>= 1 <= 4094
groupId
string format: uuid
siteId
string format: uuid
status
string
default: active
description
string

Responses

Section titled “ Responses ”

201

Section titled “201 ”

Vlan created

Media type application/json
object
data
object
id
required
string format: uuid
vid
required
integer
>= 1 <= 4094
name
required
string
groupId
string format: uuid
nullable
siteId
string format: uuid
nullable
status
required
string
default: active
description
string
nullable
createdAt
required
string format: date-time
updatedAt
required
string format: date-time
Example 
{
  "data": {
    "status": "active"
  }
}

400

Section titled “400 ”

Validation error — name required, vid must be 1–4094

Media type application/json
object
error
required
string
Example 
{
  "error": "Not found"
}

401

Section titled “401 ”

Not authenticated

Media type application/json
object
error
required
string
Example 
{
  "error": "Not found"
}