udm-pro-api-client
An API client for communicating with the Unifi UDM-PRO. Currently, it only has functionality for querying the network app for the list of connected, and/or configured, clients and generating a hosts file representation of those entries.
This is known to work with UniFi OS UDM Pro 1.12.22 and Network 7.1.68.
Configuration
The client can be configured with any sort of configuration file supported by Viper. All features of the client, except one, are also configurable by environment variables. The exception is host aliases (described below).
By default, the client will look for a file named udm-pro-api-client with
an appropriate extension (e.g. .yaml). A specific configuration file can
be specified with the environment variable API_CLIENT_CONFIG_FILE, e.g.:
$ API_CLIENT_CONFIG_FILE=/opt/api-client.yaml udm-pro-api-clientA full configuration in yaml is:
# Specifies the remote IP address of the UDM-PRO.
# Env var: API_CLIENT_ADDRESS
address: 192.168.1.1
# Specifies the username to connect to the UDM-PRO with.
# Env var: API_CLIENT_USERNAME
username: api
# Specifies the password to connect to the UDM-PRO with.
# Env var: API_CLIENT_PASSWORD
password: super-secret
# Indicates if only statically assigned clients should be considered.
# These are clients that have had an IP address assigned to them through the
# Network OS interface instead of randomly assigned from the pool of available
# dynamic IP addresses.
# Env var: API_CLIENT_FIXED_ONLY
# Default: true
fixed_only: true
# Indicates if all discovered hostnames should be lowercased before writing to
# the hosts file that Dnsmasq will read.
# Env var: API_CLIENT_LOWERCASE_HOSTNAMES
# Default: true
lowercase_hostnames: true
# A set of names and IP addresses to add to the hosts file that Dnsmasq will
# read. This allows for setting of names that the UDM-PRO does not manage, For
# example, the UDM-PRO itself.
# This is not configurable via envionment variables.
# Default: an empty list.
host_aliases:
- name: router
ip_address: 192.168.1.1