APB Port Groups

Manage port groups

Get Port Groups

get

Returns port group details of the specified network device.

Path parameters

deviceIdstringRequired

device identifier

Responses

200

successful operation

No content

default

unexpected error

get

/devices/{deviceId}/portgroups

HTTPcURLJavaScriptPython

GET /devices/{deviceId}/portgroups HTTP/1.1
Accept: */*

No content

Create port group

post

Create a new port group

Path parameters

deviceIdstringRequired

device identifier

Body

application/json

idstringOptionalExample: 1

add_memberarrayOptionalExample: ["Ethernet0","Ethernet1"]

Responses

200

successful operation

No content

default

unexpected error

post

/devices/{deviceId}/portgroups

HTTPcURLJavaScriptPython

POST /devices/{deviceId}/portgroups HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 49

{
  "id": "1",
  "add_member": [
    "Ethernet0",
    "Ethernet1"
  ]
}

No content

Update a Port Group

put

Update a specific port group

Path parameters

deviceIdstringRequired

device identifier

groupIdstringRequired

port group identifier

Body

application/json

idstringOptionalExample: 1

add_memberarrayOptionalExample: ["Ethernet0","Ethernet1"]

Responses

200

successful operation

No content

default

unexpected error

put

/devices/{deviceId}/portgroups/{groupId}

HTTPcURLJavaScriptPython

PUT /devices/{deviceId}/portgroups/{groupId} HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 49

{
  "id": "1",
  "add_member": [
    "Ethernet0",
    "Ethernet1"
  ]
}

No content

Delete a Port Group

delete

Delete a specific port group

Path parameters

deviceIdstringRequired

device identifier

groupIdstringRequired

port group identifier

Responses

200

successful operation

No content

default

unexpected error

delete

/devices/{deviceId}/portgroups/{groupId}

HTTPcURLJavaScriptPython

DELETE /devices/{deviceId}/portgroups/{groupId} HTTP/1.1
Accept: */*

No content