Skip to content

external-dns-unifios-webhook

Webhook provider for external-dns that integrates with UniFi OS DNS management. Enables automatic DNS record management in UniFi controllers (UniFi Dream Machine, Cloud Key, etc.) from Kubernetes.

Features

  • DNS Record Management

    Supports A, AAAA, CNAME, and TXT record types with automatic synchronization from Kubernetes resources.

  • Domain Filtering

    Flexible domain filtering with include/exclude patterns and regex support for precise control.

  • Health Monitoring

    Kubernetes-ready health checks and readiness probes for reliable operation.

  • Prometheus Metrics

    Built-in metrics endpoint for monitoring DNS operations and performance.

  • Structured Logging

    JSON logging with configurable levels for easy integration with log aggregation systems.

  • Minimal Footprint

    Lightweight container image built from scratch for security and efficiency.

  • Getting Started

    Install and configure the webhook in minutes.

    Quick Start

  • Configuration

    Environment variables and UniFi API setup.

    Configuration

  • Guides

    Integration guides and troubleshooting.

    Guides

  • Development

    Contributing and architecture documentation.

    Development

Requirements

Component Version Notes
external-dns v0.20.0+ Webhook provider support required
UniFi Controller Site API v2 Any modern UniFi controller

Compatibility

Works with any UniFi controller that supports Site API v2, including UniFi Dream Machine series, Cloud Key, and self-hosted UniFi Network Application.

Tested with: UniFi OS 4.3.9, UniFi Network 9.4.19

License

This project is licensed under the BSD-3-Clause License.