[OBS-4235] New API Endpoints - Observium

Details

Type: Improvement
Resolution: Fixed
Priority: Minor
Fix Version/s: None
Affects Version/s: Professional Edition
Component/s: API
Labels:
None

Description

Hello,

it would be great to have some additions to the api like the following:

/vlans/id - get details of a vlan with device ids and port ids

/ports/?ifVlan= - search interfaces by vlan like ifAlias. Maybe include tagged vlans

Attachments

Activity

[OBS-4235] New API Endpoints

Adam Armstrong added a comment - 2022/08/31 05:13 PM

I think I avoided creating VLAN API endpoints because the data is not entirely reliable. We see untagged vlans (ifVlan) and tagged vlans via different routes, so it's difficult to include all of the information and it might well be somewhat inaccurate/misleading if people rely on it for planning purposes.

I've added filtering by ifVlan in r12268. I've also added a very basic /vlans/$id/ endpoint in r12270

This per-vlan endpoint could get very messy, as you might want the actual port and device entity data. I'm just returning the port_id and device_id at the moment.

adam.

Adam Armstrong added a comment - 2022/08/31 05:13 PM I think I avoided creating VLAN API endpoints because the data is not entirely reliable. We see untagged vlans (ifVlan) and tagged vlans via different routes, so it's difficult to include all of the information and it might well be somewhat inaccurate/misleading if people rely on it for planning purposes. I've added filtering by ifVlan in r12268. I've also added a very basic /vlans/$id/ endpoint in r12270 This per-vlan endpoint could get very messy, as you might want the actual port and device entity data. I'm just returning the port_id and device_id at the moment. adam.

People

Assignee:: Adam Armstrong

Reporter:: Philipp Rehs

Votes:: 0 Vote for this issue

Watchers:: 2 Start watching this issue

Dates

Created:: 2022/08/25 09:14 AM

Updated:: 2022/08/31 05:13 PM

Resolved:: 2022/08/31 05:13 PM