Custom API Servers

A collection of lightweight custom API services designed to expose system and network metrics for integration with the Homepage Dashboard.

Overview

This project provides custom API servers that expose system-level and network metrics not natively available in the Homepage Dashboard widgets. These APIs are intended to be consumed by a Homepage instance to extend its monitoring capabilities.

Homepage Dashboard: https://gethomepage.dev

While Homepage includes built-in widgets for common metrics, certain key statistics required for more comprehensive monitoring are missing. This project was created to bridge that gap by providing purpose-built APIs tailored to specific monitoring needs.

Components

Custom External pfSense API

This API calculates total inbound and outbound traffic metrics for each network interface on a pfSense firewall.

• Hosted as a Docker container
• Fetches data from the pfSense REST API
• Filters and aggregates interface-level traffic metrics
• Requires the pfSense REST API package to be installed and configured on the firewall
• Uses a read-only API key for security

pfSense REST API documentation: https://pfrest.org/

***All metrics in GB

Custom Docker Host Monitoring API

This API monitors system and container-level metrics of a Docker host.

Exposed metrics include:

• CPU usage
• Memory usage
• Swap usage
• Network inbound and outbound traffic
• Disk usage
• List of actively running Docker containers

Key characteristics:

• Deployed as a Docker container

• Monitors the host operating system

• Requires explicit configuration of:

  • Network interfaces to monitor
  • Filesystems to track disk usage

• Designed for safe, read-only access to host resources