APB VLAN

Manage VLANs

Get VLAN information for a specific device

get

Retrieves VLAN details associated with the specified device ID.

Path parameters

deviceIdstringRequired

The unique identifier of the device.

Responses

200

successful operation

application/json

vlanIdstringOptional

The ID of the VLAN.

namestringOptional

The name of the VLAN.

statusstringOptional

The status of the VLAN (e.g., active, inactive).

default

unexpected error

get

/vlan/{deviceId}

HTTPcURLJavaScriptPython

GET /vlan/{deviceId} HTTP/1.1
Accept: */*

[
  {
    "vlanId": "text",
    "name": "text",
    "status": "text"
  }
]

Create a new VLAN for a specific device

post

Creates a new VLAN associated with the specified device ID.

Path parameters

deviceIdstringRequired

The unique identifier of the device.

Body

application/json

vlan_idintegerOptional

The VLAN ID to be created

Default: 4010

Responses

200

VLAN created successfully

No content

default

unexpected error

post

/vlan/{deviceId}

HTTPcURLJavaScriptPython

POST /vlan/{deviceId} HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 16

{
  "vlan_id": 4010
}

No content

Delete a specific VLAN for a device

delete

Deletes the specified VLAN associated with the given device ID and VLAN ID.

Path parameters

deviceIdstringRequired

The unique identifier of the device.

vlanIdstringRequired

The unique identifier of the VLAN to be deleted.

Responses

200

VLAN deleted successfully

No content

default

unexpected error

delete

/vlan/{deviceId}/{vlanId}

HTTPcURLJavaScriptPython

DELETE /vlan/{deviceId}/{vlanId} HTTP/1.1
Accept: */*

No content

Get interface VLAN information for a device

get

Retrieves interface VLAN details associated with the specified device ID.

Path parameters

deviceIdstringRequired

The unique identifier of the device.

Responses

200

successful operation

application/json

interfaceIdstringOptional

The ID of the interface.

vlanIdstringOptional

The ID of the VLAN.

statusstringOptional

The status of the interface VLAN (e.g., active, inactive).

default

unexpected error

get

/interfaceVlan/{deviceId}

HTTPcURLJavaScriptPython

GET /interfaceVlan/{deviceId} HTTP/1.1
Accept: */*

[
  {
    "interfaceId": "text",
    "vlanId": "text",
    "status": "text"
  }
]

Create interface VLAN for a device

post

Creates an interface VLAN association for the specified device ID.

Path parameters

deviceIdstringRequired

The unique identifier of the device.

Body

application/json

interfaceIdstringOptional

The ID of the interface.

vlan_idintegerOptional

The VLAN ID to associate with the interface.

Default: 4010

Responses

200

Interface VLAN created successfully

No content

default

unexpected error

post

/interfaceVlan/{deviceId}

HTTPcURLJavaScriptPython

POST /interfaceVlan/{deviceId} HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 37

{
  "interfaceId": "text",
  "vlan_id": 4010
}

No content