UnifiAPI

1.0.0

PowerShell module for interacting with the Ubiquiti UniFi Controller API. Provides functions to manage UniFi network infrastructure including sites, devices, WLAN configurations, firmware updates, backups, and more.

Minimum PowerShell version

7.0

Installation Options

Copy and Paste the following command to install this package using PowerShellGet More Info

Install-Module -Name UnifiAPI

Copy and Paste the following command to install this package using Microsoft.PowerShell.PSResourceGet More Info

Install-PSResource -Name UnifiAPI

You can deploy this package directly to Azure Automation. Note that deploying packages with dependencies will deploy all the dependencies to Azure Automation. Learn More

Manually download the .nupkg file to your system's default download location. Note that the file won't be unpacked, and won't include any dependencies. Learn More

Owners

Copyright

(c) Chris Taylor. All rights reserved.

Package Details

Author(s)

  • Chris Taylor

Tags

UniFi Ubiquiti ChrisTaylorCodes

Functions

Get-UnifiAdmins Get-UnifiSiteAdmins Grant-UnifiSuperAdmin New-UnifiSiteAdmin Remove-UnifiSiteAdmin Revoke-UnifiSuperAdmin Get-UnifiSiteClients Connect-Unifi Disconnect-Unifi Invoke-UnifiApi Get-UnifiDevices Get-UnifiDisconnectedWaps Invoke-UnifiDeviceAction Remove-UnifiDevice Set-UnifiDeviceMigration Get-UnifiSiteFirewallGroups Get-UnifiSiteFirewallRules New-UnifiSiteFirewallRule Get-UnifiFirmware Test-UnifiFirmwareStatus Update-UnifiFirmware Get-UnifiAlert Get-UnifiLog Get-UnifiSiteDynamicDNS Get-UnifiSiteNetworks Get-UnifiSitePortForwards Get-UnifiSiteRouting Get-UnifiSiteRadiusAccounts Get-UnifiSiteRadiusProfiles Get-UnifiKnownRogue Get-UnifiNeighborAP Get-UnifiRogue Get-UnifiSiteAlarms Get-UnifiSiteBackup Get-UnifiSites Get-UnifiSiteSettings Get-UnifiSiteUserGroups Get-UnifiSiteWarnings Import-UnifiSiteBackup New-UnifiSite New-UnifiSiteMigration New-UnifiSiteUserGroup Remove-UnifiSite Remove-UnifiSiteUserGroup Set-UnifiSite Set-UnifiSiteSettings Set-UnifiSiteUserGroup Clear-UnifiSiteAlarm Get-UnifiSiteEvents Get-UnifiSiteHealth Get-UnifiSiteStatistics Get-UnifiControllerStatus Get-UnifiCurrentUser Get-UnifiDiagnostic Get-UnifiEventStrings Get-UnifiSiteCountryCodes Get-UnifiSiteSwitchProfiles Get-UnifiSiteSystemInfo Get-UnifiSiteTags Get-UnifiSiteTimezones Get-UnifiWLANConfigs Get-UnifiWLANGroups New-UnifiWLAN New-UnifiWLANGroup Remove-UnifiWLAN Remove-UnifiWLANGroup Set-UnifiWLAN Set-UnifiWLANGroup

PSEditions

Core

Dependencies

This module has no dependencies.

Release Notes

## Version 1.0.0

### Initial Public Release
- 68 public functions for comprehensive UniFi Controller API management
- PowerShell 7.0+ (Core only) support
- Pipeline input support for `SiteName` parameter across all site-scoped functions
- Automatic pagination support via `-Paginate` parameter in `Invoke-UnifiApi`
- Full `[OutputType()]` declarations on all functions
- Input validation for MAC addresses and IP addresses
- Support for all HTTP methods including Patch
- Centralized HTTP request handling with proper error sanitization
- Comprehensive Pester 5.6.1 test suite
- CI/CD pipeline for automated testing and publishing

FileList

Version History

Version Downloads Last updated
1.0.0 (current version) 6,998 1/22/2026