Resources

The Internal (legacy) API exposes every resource as plain methods on the client (also reachable via c.Internal()). They follow a strict naming convention, so this page maps the resources rather than transcribing hundreds of generated struct fields — for those, browse the unifi package on pkg.go.dev.

The convention

Most resources expose the same five methods, named <Verb><Resource>:

So the Network row below means CreateNetwork, GetNetwork, ListNetwork, UpdateNetwork, DeleteNetwork. Every method takes a context.Context first and a site name string ("default"); Get returns ErrNotFound when the resource doesn't exist, while List returns an empty slice (and a nil error) when there are none. In the tables below, CRUD is shorthand for all five; deviations are spelled out.

package main

import (
	"context"
	"errors"
	"fmt"
	"log"

	"github.com/filipowm/go-unifi/v2/unifi"
)

func main() {
	ctx := context.Background()
	c, err := unifi.NewClient(&unifi.ClientConfig{URL: "https://unifi.example.com", APIKey: "your-api-key"})
	if err != nil {
		log.Fatal(err)
	}

	networks, err := c.ListNetwork(ctx, "default")
	if err != nil {
		log.Fatalf("list networks: %v", err)
	}
	for _, n := range networks {
		fmt.Printf("%s (%s)\n", n.Name, n.Purpose)
	}

	// Device and User add convenience by-MAC variants.
	dev, err := c.GetDeviceByMAC(ctx, "default", "00:11:22:33:44:55")
	if err != nil && !errors.Is(err, unifi.ErrNotFound) {
		log.Fatal(err)
	}
	_ = dev
}

Networking

Firewall

Wireless

Devices

Clients & Users

Sites & System

Layout & Media

Guest portal & hotspot

See also