APB Tunnels

Manage tunnels

Get tunnels for a specific device

get

Retrieves information about tunnels associated with the specified device ID.

Path parameters

deviceIdstringRequired

The unique identifier of the device.

Responses

200

successful operation

application/json

tunnelIdstringOptional

The ID of the tunnel.

statusstringOptional

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

default

unexpected error

get

/tunnels/{deviceId}

HTTPcURLJavaScriptPython

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

[
  {
    "tunnelId": "text",
    "status": "text"
  }
]

Delete a specific tunnel

delete

Deletes the tunnel associated with the device ID and tunnel name.

Path parameters

deviceIdstringRequired

The unique identifier of the device.

namestringRequired

The name of the tunnel to be deleted.

Responses

200

successful operation

No content

default

unexpected error

delete

/tunnels/{deviceId}/{name}

HTTPcURLJavaScriptPython

DELETE /tunnels/{deviceId}/{name} HTTP/1.1
Accept: */*

No content

Create a new tunnel

post

Creates a new tunnel with the specified details.

Body

application/json

namestringOptional

Name of the tunnel

Default: default_tunnel

typestringOptional

Type of the tunnel

Default: strip

vlanstringOptional

VLAN configuration for the tunnel

Default: enable

vnistringOptional

VNI for the tunnel

Default: 4098

selectedIngressPortstringOptional

Ingress port selected for the tunnel

Default: Ethernet1/1

selectedEgressPortstringOptional

Egress port selected for the tunnel

Default: Ethernet1/2

gatewayIpstringOptional

Gateway IP for the tunnel

Default: 192.168.1.1

descriptionstringOptional

Description of the tunnel

Default: Default tunnel description

srcIpstringOptional

Source IP for the tunnel

Default: 10.10.10.1

dstIpstringOptional

Destination IP for the tunnel

Default: 10.10.10.2

deviceIpstringOptional

Device IP associated with the tunnel

Default: 192.168.0.100

deviceIdstringOptional

Device ID associated with the tunnel

Default: 1c34da237700

Responses

200

Tunnel created successfully

No content

default

Unexpected error

post

/tunnels

HTTPcURLJavaScriptPython

POST /tunnels HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 304

{
  "name": "default_tunnel",
  "type": "strip",
  "vlan": "enable",
  "vni": "4098",
  "selectedIngressPort": "Ethernet1/1",
  "selectedEgressPort": "Ethernet1/2",
  "gatewayIp": "192.168.1.1",
  "description": "Default tunnel description",
  "srcIp": "10.10.10.1",
  "dstIp": "10.10.10.2",
  "deviceIp": "192.168.0.100",
  "deviceId": "1c34da237700"
}

No content