# UniFi integration

> UniFi Site Manager cloud API (hosts, sites, devices, ISP metrics, SD-WAN) plus the UniFi Network and Protect application APIs through the Site Manager cloud connector.

- Authentication: apiKey

## Tools (159)

- **Connector - DELETE**: Forward a request to a console's local application API through the cloud connector.
- **Connector - GET**: Forward a request to a console's local application API through the cloud connector.
- **Connector - PATCH**: Forward a request to a console's local application API through the cloud connector.
- **Connector - POST**: Forward a request to a console's local application API through the cloud connector.
- **Connector - PUT**: Forward a request to a console's local application API through the cloud connector.
- **Get Host by ID**: Retrieves detailed information about a specific host by ID.
- **Get ISP Metrics**: Retrieves ISP metrics data for all sites linked to the UI account's API key.
- **Get SD-WAN Config by ID**: Retrieves detailed information about a specific SD-WAN configuration by ID.
- **Get SD-WAN Config Status**: Retrieves the status of a specific SD-WAN configuration, including deployment progress, errors, and associated hubs.
- **List Devices**: Retrieves a list of UniFi devices managed by hosts where the UI account making the API call is the owner or a super admin.
- **List Hosts**: Retrieves a list of all hosts associated with the UI account making the API call.
- **List SD-WAN Configs**: Retrieves a list of all SD-WAN configurations associated with the UI account making the API call.
- **List Sites**: Retrieves a list of all sites (from hosts running the UniFi Network application) associated with the UI account making the API call.
- **Network: Adopt Devices**: Adopt a device to a site.
- **Network: Create ACL Rule**: Create a new user defined ACL rule on a site.
- **Network: Create Custom Firewall Zone**: Create a new custom firewall zone on a site.
- **Network: Create DNS Policy**: Create a new DNS policy on a site.
- **Network: Create Firewall Policy**: Create a new firewall policy on a site.
- **Network: Create Network**: Create a new network on a site.
- **Network: Create Traffic Matching List**: Create a new traffic matching list on a site.
- **Network: Create Wifi Broadcast**: Create a new Wifi Broadcast on the specified site.
- **Network: Delete ACL Rule**: Delete an existing user defined ACL rule on a site.
- **Network: Delete Custom Firewall Zone**: Delete a custom firewall zone from a site.
- **Network: Delete DNS Policy**: Delete an existing DNS policy on a site.
- **Network: Delete Firewall Policy**: Delete an existing firewall policy on a site.
- **Network: Delete Network**: Delete an existing network on a site.
- **Network: Delete Traffic Matching List**: Delete an exist traffic matching list on a site.
- **Network: Delete Voucher**: Remove a specific Hotspot voucher.
- **Network: Delete Vouchers**: Remove Hotspot vouchers based on the specified filter criteria.
- **Network: Delete Wifi Broadcast**: Delete an existing Wifi Broadcast from the specified site.
- **Network: Execute Adopted Device Action**: Perform an action on an specific adopted device.
- **Network: Execute Client Action**: Perform an action on a specific connected client.
- **Network: Execute Port Action**: Perform an action on a specific device port.
- **Network: Generate Vouchers**: Create one or more Hotspot vouchers.
- **Network: Get ACL Rule**: Get ACL Rule
- **Network: Get Adopted Device Details**: Retrieve detailed information about a specific adopted device, including firmware versioning, uplink state, details about device features and interfaces (ports, radios) and other key attributes.
- **Network: Get Application Info**: Retrieve general information about the UniFi Network application.
- **Network: Get Connected Client Details**: Retrieve detailed information about a specific connected client, including name, IP address, MAC address, connection type and access information.
- **Network: Get DNS Policy**: Retrieve specific DNS policy.
- **Network: Get Firewall Policy**: Retrieve specific firewall policy.
- **Network: Get Firewall Zone**: Get a firewall zone on a site.
- **Network: Get LAG Details**: Retrieve LAG details.
- **Network: Get Latest Adopted Device Statistics**: Retrieve the latest real-time statistics of a specific adopted device, such as uptime, data transmission rates, CPU and memory utilization.
- **Network: Get MC-LAG Domain**: Retrieve MC-LAG Domain details.
- **Network: Get Network Details**: Retrieve detailed information about a specific network.
- **Network: Get Network References**: Retrieve references to a specific network.
- **Network: Get Switch Stack**: Retrieve Switch Stack details.
- **Network: Get Traffic Matching List**: Get an exist traffic matching list on a site.
- **Network: Get User-Defined ACL Rule Ordering**: Retrieve user-defined ACL rule ordering on a site.
- **Network: Get User-Defined Firewall Policy Ordering**: Retrieve user-defined firewall policy ordering for a specific source/destination zone pair.
- **Network: Get Voucher Details**: Retrieve details of a specific Hotspot voucher.
- **Network: Get Wifi Broadcast Details**: Retrieve detailed information about a specific Wifi.
- **Network: List ACL Rules**: Retrieve a paginated list of all ACL rules on a site.
- **Network: List Adopted Devices**: Retrieve a paginated list of all adopted devices on a site, including basic device information.
- **Network: List Connected Clients**: Retrieve a paginated list of all connected clients on a site, including physical devices (computers, smartphones) and active VPN connections.
- **Network: List Countries**: Returns ISO-standard country codes and names, used for region-based configuration or regulatory compliance.
- **Network: List Devices Pending Adoption**: Retrieve a paginated list of devices pending adoption, including basic device information.
- **Network: List Device Tags**: Returns all device tags defined within a site, which can be used for WiFi Broadcast assignments.
- **Network: List DNS Policies**: Retrieve a paginated list of all DNS policies on a site.
- **Network: List DPI Application Categories**: Returns predefined Deep Packet Inspection (DPI) application categories used for traffic identification and filtering.
- **Network: List DPI Applications**: Lists DPI-recognized applications grouped under categories.
- **Network: List Firewall Policies**: Retrieve a list of all firewall policies on a site.
- **Network: List Firewall Zones**: Retrieve a list of all firewall zones on a site.
- **Network: List LAGs**: Retrieve a paginated list of all LAGs (Link Aggregation Groups) on a site.
- **Network: List Local Sites**: Retrieve a paginated list of local sites managed by this Network application.
- **Network: List MC-LAG Domains**: Retrieve a paginated list of all MC-LAG Domains on a site.
- **Network: List Networks**: Retrieve a paginated list of all Networks on a site.
- **Network: List Radius Profiles**: Returns available RADIUS authentication profiles, including configuration origin metadata.
- **Network: List Site-To-Site VPN Tunnels**: Retrieve a paginated list of all site-to-site VPN tunnels on a site.
- **Network: List Switch Stacks**: Retrieve a paginated list of all Switch Stacks on a site.
- **Network: List Traffic Matching Lists**: Retrieve all traffic matching lists on a site.
- **Network: List Vouchers**: Retrieve a paginated list of Hotspot vouchers.
- **Network: List VPN Servers**: Retrieve a paginated list of all VPN servers on a site.
- **Network: List WAN Interfaces**: Returns available WAN interface definitions for a given site, including identifiers and names.
- **Network: List Wifi Broadcasts**: Retrieve a paginated list of all Wifi Broadcasts on a site.
- **Network: Patch Firewall Policy**: Patch an existing firewall policy on a site.
- **Network: Remove (Unadopt) Device**: Removes (unadopts) an adopted device from the site.
- **Network: Reorder User-Defined ACL Rules**: Reorder user-defined ACL rules on a site.
- **Network: Reorder User-Defined Firewall Policies**: Reorder user-defined firewall policies for a specific source/destination zone pair.
- **Network: Update ACL Rule**: Update an existing user defined ACL rule on a site.
- **Network: Update DNS Policy**: Update an existing DNS policy on a site.
- **Network: Update Firewall Policy**: Update an existing firewall policy on a site.
- **Network: Update Firewall Zone**: Update a firewall zone on a site.
- **Network: Update Network**: Update an existing network on a site.
- **Network: Update Traffic Matching List**: Update an exist traffic matching list on a site.
- **Network: Update Wifi Broadcast**: Update an existing Wifi Broadcast on the specified site.
- **Protect: Activate relay output**: Control a relay output state.
- **Protect: Create arm profile**: Create a new arm profile.
- **Protect: Create live view**: Create a new live view
- **Protect: Create RTSPS streams for camera**: Returns RTSPS stream URLs for specified quality levels
- **Protect: Create talkback session for camera**: Returns the talkback stream URL and audio configuration for a specific camera
- **Protect: Delete arm profile**: Delete an arm profile by ID.
- **Protect: Delete camera RTSPS stream**: Remove the RTSPS stream for a specified camera
- **Protect: Disable arm alarm**: Disable the arm alarm feature.
- **Protect: Enable arm alarm**: Enable the arm alarm feature using the currently selected arm profile.
- **Protect: Get alarm hub details**: Get detailed information about a specific alarm hub
- **Protect: Get all alarm hubs**: Get detailed information about all alarm hubs
- **Protect: Get all arm profiles**: Get a list of all arm profiles.
- **Protect: Get all bridges**: Get detailed information about all bridges
- **Protect: Get all cameras**: Get detailed information about all cameras
- **Protect: Get all chimes**: Get detailed information about all chimes
- **Protect: Get all fobs**: Get detailed information about all fobs
- **Protect: Get all identity users**: Get all UniFi Identity users with enrolled credentials (NFC cards, fingerprints).
- **Protect: Get all lights**: Get detailed information about all lights
- **Protect: Get all link stations**: Get detailed information about all link stations (non-alarm hub gateways)
- **Protect: Get all live views**: Get detailed information about all live views
- **Protect: Get all relays**: Get detailed information about all relays
- **Protect: Get all sensors**: Get detailed information about all sensors
- **Protect: Get all sirens**: Get detailed information about all sirens
- **Protect: Get all speakers**: Get detailed information about all speakers
- **Protect: Get all users**: Get all Protect users.
- **Protect: Get all viewers**: Get detailed information about all viewers
- **Protect: Get application information**: Get generic information about the Protect application
- **Protect: Get bridge details**: Get detailed information about a specific bridge
- **Protect: Get camera details**: Get detailed information about a specific camera
- **Protect: Get camera snapshot**: Get a snapshot image from a specific camera.
- **Protect: Get chime details**: Get detailed information about a specific chime
- **Protect: Get device asset files**: Get a list of all device asset files
- **Protect: Get fob details**: Get detailed information about a specific fob
- **Protect: Get identity user details**: Get detailed information about a specific UniFi Identity user.
- **Protect: Get light details**: Get detailed information about a specific light
- **Protect: Get link station details**: Get detailed information about a specific link station (non-alarm hub gateways)
- **Protect: Get live view details**: Get detailed information about a specific live view
- **Protect: Get NVR details**: Get detailed information about the NVR
- **Protect: Get relay details**: Get detailed information about a specific relay
- **Protect: Get RTSPS streams for camera**: Returns existing RTSPS stream URLs for camera
- **Protect: Get sensor details**: Get detailed information about a specific sensor
- **Protect: Get siren details**: Get detailed information about a specific siren
- **Protect: Get speaker details**: Get detailed information about a specific speaker
- **Protect: Get user details**: Get detailed information about a specific Protect user.
- **Protect: Get viewer details**: Get detailed information about a specific viewer
- **Protect: Ingest a POS transaction**: Records a point of sale transaction as a camera event so the transaction details can be overlaid on recorded footage.
- **Protect: Move PTZ camera to preset**: Adjust the PTZ camera position to a specified preset
- **Protect: Patch alarm hub settings**: Patch the settings for a specific alarm hub
- **Protect: Patch bridge settings**: Patch the settings for a specific bridge
- **Protect: Patch camera settings**: Patch the settings for a specific camera
- **Protect: Patch chime settings**: Patch the settings for a specific chime
- **Protect: Patch fob settings**: Patch the settings for a specific fob
- **Protect: Patch light settings**: Patch the settings for a specific light
- **Protect: Patch link station settings**: Patch the settings for a specific link station
- **Protect: Patch live view configuration**: Patch the configuration about a specific live view
- **Protect: Patch relay settings**: Patch the settings for a specific relay
- **Protect: Patch sensor settings**: Patch the settings for a specific sensor
- **Protect: Patch siren settings**: Patch the settings for a specific siren
- **Protect: Patch speaker settings**: Patch the settings for a specific speaker
- **Protect: Patch viewer settings**: Patch the settings for a specific viewer
- **Protect: Permanently disable camera microphone**: Disable the microphone for a specific camera.
- **Protect: Play siren**: Activate the siren alarm for the specified duration.
- **Protect: Send a webhook to the alarm manager**: Send a webhook to the alarm manager to trigger configured alarms
- **Protect: Set current arm profile**: Set the current arm profile to be used when enabling the arm alarm.
- **Protect: Start a camera PTZ patrol**: Start a camera PTZ patrol
- **Protect: Stop active camera PTZ patrol**: Stop active camera PTZ patrol
- **Protect: Stop siren**: Stop an active siren.
- **Protect: Test siren sound**: Test the siren sound for 5 seconds at the specified volume.
- **Protect: Test speaker sound**: Test the speaker sound at the specified volume.
- **Protect: Trigger alarm hub output**: Trigger an alarm hub output channel.
- **Protect: Update arm profile**: Update an existing arm profile.
- **Protect: Upload device asset file**: Upload a new device asset file
- **Query ISP Metrics**: Retrieves ISP metrics data based on specific query parameters.

Connect UniFi in General Input: https://www.generalinput.com/apps/unifi