---
canonical_url: "https://docs.composio.dev/toolkits/unifi"
markdown_url: "https://docs.composio.dev/toolkits/unifi.md"
product: "platform"
version: null
last_updated: null
---

# UniFi

Monitor UniFi Site Manager inventory, internet health metrics, and SD-WAN configurations across the connected UI account's sites. This toolkit excludes arbitrary Cloud Connector requests and all local Network, Protect, Mobility, Carrier Fabric, and InnerSpace API surfaces.

- **Category:** internet of things
- **Auth:** API_KEY
- **Composio-managed OAuth available?** N/A
- **Tools:** 9
- **Triggers:** 0
- **Slug:** `UNIFI`
- **Version:** 00000000_00

## Tools

### Get Host

**Slug:** `UNIFI_GET_HOST`

Get detailed information for one UniFi host by the Site Manager host ID returned by List Hosts.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `host_id` | string | Yes | Site Manager host ID, normally obtained from List Hosts. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get ISP Metrics

**Slug:** `UNIFI_GET_ISP_METRICS`

Get ISP performance metrics for all accessible sites, optionally limited by a relative duration or explicit timestamp bounds.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `duration` | string ("24h" | "7d" | "30d") | No | Optional relative lookback. Use 24h with interval=5m; use 7d or 30d with interval=1h. Cannot be combined with timestamps. |
| `interval` | string ("5m" | "1h") | Yes | Metric interval: 5m for recent high-resolution data or 1h for longer history. |
| `end_timestamp` | string | No | Optional explicit-range end in RFC3339 format. Cannot be combined with duration. |
| `begin_timestamp` | string | No | Optional explicit-range start in RFC3339 format. Cannot be combined with duration. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get SD-WAN Config

**Slug:** `UNIFI_GET_SD_WAN_CONFIG`

Get the topology and settings of one SD-WAN configuration by ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `config_id` | string | Yes | SD-WAN configuration ID, normally obtained from List SD-WAN Configs. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get SD-WAN Config Status

**Slug:** `UNIFI_GET_SD_WAN_CONFIG_STATUS`

Get deployment, generation, WAN, tunnel, warning, and error status for one SD-WAN configuration.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `config_id` | string | Yes | SD-WAN configuration ID, normally obtained from List SD-WAN Configs. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Devices

**Slug:** `UNIFI_LIST_DEVICES`

List UniFi devices managed by hosts where the connected UI account is an owner or super admin. Results are grouped by host and can be filtered by host ID or by the last processed device timestamp.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `host_ids` | array | No | Only return devices managed by these Site Manager host IDs. |
| `page_size` | integer | No | Maximum host-grouped device records to return in this page (1-500). |
| `next_cursor` | string | No | Continuation cursor returned by a previous call; omit for the first page. |
| `updated_after` | string | No | Only return device data processed after this RFC3339 timestamp. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Hosts

**Slug:** `UNIFI_LIST_HOSTS`

List UniFi hosts associated with the connected UI account. Use the returned host IDs with device filters, site metrics, and host detail tools.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page_size` | integer | No | Maximum hosts to return in this page (1-500). |
| `next_cursor` | string | No | Continuation cursor returned by a previous call; omit for the first page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List SD-WAN Configs

**Slug:** `UNIFI_LIST_SD_WAN_CONFIGS`

List the SD-WAN configurations associated with the connected UI account.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Sites

**Slug:** `UNIFI_LIST_SITES`

List sites from UniFi Network applications associated with the connected UI account. Use returned host and site IDs for selected-site ISP metrics.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page_size` | integer | No | Maximum sites to return in this page (1-500). |
| `next_cursor` | string | No | Continuation cursor returned by a previous call; omit for the first page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Query ISP Metrics

**Slug:** `UNIFI_QUERY_ISP_METRICS`

Get ISP performance metrics for selected host/site pairs. Each site can specify its own RFC3339 time bounds. Always inspect partial_success, status, and message: UniFi can return usable metrics for only the accessible subset with HTTP 200.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sites` | array | Yes | One or more host/site pairs to query. Empty arrays are rejected. |
| `interval` | string ("5m" | "1h") | Yes | Metric interval: 5m for recent high-resolution data or 1h for longer history. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |