Get alerts from LibreNMS with optional filters.

Get a specific alert from LibreNMS by ID.

Acknowledge an alert in LibreNMS by ID.

Unmute an alert in LibreNMS by ID.

List all alert rules from LibreNMS.

Returns: dict: The JSON response from the API.

Get details for a specific alert rule by ID.

Add a new alert rule to LibreNMS.

Edit an existing alert rule in LibreNMS.

Delete an alert rule from LibreNMS by ID.

List all alert templates from LibreNMS.

Returns: dict: The JSON response from the API.

Get a specific alert template from LibreNMS by ID.

Create a new alert template in LibreNMS.

Edit an existing alert template in LibreNMS.

Delete an alert template from LibreNMS by ID.

List bills from LibreNMS with optional filters.

Get a specific bill from LibreNMS by ID.

Get bill graph image from LibreNMS.

Get bill graph data from LibreNMS.

Get bill history from LibreNMS.

Get bill history graph from LibreNMS.

Get bill history graph data from LibreNMS.

Create or update a bill in LibreNMS.

Delete a bill from LibreNMS by ID.

List devices from LibreNMS with optional filters.

Add a new device to LibreNMS.

Get device details from LibreNMS by hostname.

Delete a device from LibreNMS by hostname.

Update device fields in LibreNMS.

List ports for a device from LibreNMS.

Get port info for a device by interface name.

Get device availability from LibreNMS.

Get device outages from LibreNMS.

Set device maintenance in LibreNMS.

List all device groups from LibreNMS.

Returns: dict: The JSON response from the API.

Add a new device group to LibreNMS.

Update a device group in LibreNMS.

Delete a device group from LibreNMS by name.

List devices in a device group from LibreNMS.

Set maintenance for a device group in LibreNMS.

Add devices to a device group in LibreNMS.

Remove devices from a device group in LibreNMS.

Trigger device rediscovery in LibreNMS.

Rename a device in LibreNMS.

Check if a device is currently in maintenance mode.

Get VLANs configured on a specific device.

Get network links for a specific device.

Add a custom event log entry for a device.

List the forwarding database (learned MAC addresses) for a device.

Each entry carries the port_id it was learned on, so this is the device-wide view of what is plugged into a switch.

List network access control (802.1X / MAB) sessions on a device.

Shows authenticated endpoints per port, including the authentication method and the assigned VLAN where the device reports it.

List the graph types available for a device.

Use this to discover the values accepted by the graph_type argument of device_graph, for example 'device_icmp_perf' or 'device_poller_perf'.

Render a device-level graph as an image.

Render a per-port graph as an image, for example interface traffic.

Some LibreNMS releases fail to render through the per-port endpoint and answer 500 with an empty graph type in the message. For 'bits' this tool then falls back to the port-group endpoint, which renders the same traffic data, so callers still get a graph without needing a port ID.

Render a traffic graph for one or more ports, by port ID.

Plots every supplied port on the same axes, which makes it useful for comparing members of a LAG. Unlike port_graph this takes numeric port IDs rather than interface names.

List available health graphs for a device.

Get health data by sensor type for a device.

Get a specific sensor by ID for a device.

List all sensors across all devices.

Get inventory for a device from LibreNMS.

Get flattened inventory for a device from LibreNMS.

List locations from LibreNMS.

Add a new location to LibreNMS.

Delete a location from LibreNMS by identifier.

Edit a location in LibreNMS.

Get a specific location from LibreNMS by identifier.

Set maintenance mode for all devices in a location.

Get event logs for a device from LibreNMS.

Get syslogs for a device from LibreNMS.

Get alert logs for a device from LibreNMS.

Get auth logs for a device from LibreNMS.

Add a syslog entry to LibreNMS via API sink.

Retrieve ARP entries from LibreNMS by search query.

List BGP sessions from LibreNMS with optional filters.

Returns: dict: The JSON response from the API.

Get BGP session from LibreNMS by ID.

Edit BGP session in LibreNMS by ID.

List all IP addresses from LibreNMS.

Returns: dict: The JSON response from the API.

List all VLANs from LibreNMS.

Returns: dict: The JSON response from the API.

List all links from LibreNMS.

Returns: dict: The JSON response from the API.

Look up a MAC address in the forwarding database.

List all OSPF instances from LibreNMS.

Returns: dict: The JSON response from the API.

List all OSPF ports/interfaces from LibreNMS.

Returns: dict: The JSON response from the API.

List all VRF (Virtual Routing and Forwarding) instances from LibreNMS.

Returns: dict: The JSON response from the API.

List network access control (802.1X / MAB) sessions across all devices.

Note that LibreNMS answers with a 404 and "Nac entry does not exist" rather than an empty list when nothing matches.

List devices tracked by Oxidized for config backup.

Get the stored device configuration from Oxidized for a specific device.

Search all Oxidized device configurations for a string.

Get poller group(s) from LibreNMS.

List port security configuration across all devices.

Covers switchport port-security state such as the maximum number of learned MAC addresses, violation mode and current status.

Get port security configuration for every port on a device.

Get port security configuration for a single port.

Get all ports from LibreNMS with optional filters.

Search ports in LibreNMS by search string.

Search ports in LibreNMS by specific field.

Search ports in LibreNMS by MAC address.

Get port info from LibreNMS by port ID.

Get port IP info from LibreNMS by port ID.

Get port transceiver info from LibreNMS by port ID.

Get port description from LibreNMS by port ID.

Update port description in LibreNMS by port ID.

List port groups from LibreNMS.

Returns: dict: The JSON response from the API.

Add a port group to LibreNMS.