Skip to main content
UniFi logo
  • Category: internet of things
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 9
  • Triggers: 0
  • Slug: UNIFI
  • Version: 00000000_00

Tools

Slug: UNIFI_GET_HOSTGet detailed information for one UniFi host by the Site Manager host ID returned by List Hosts.

Input Parameters

string
required
Site Manager host ID, normally obtained from List Hosts.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: UNIFI_GET_ISP_METRICSGet ISP performance metrics for all accessible sites, optionally limited by a relative duration or explicit timestamp bounds.

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: UNIFI_GET_SD_WAN_CONFIGGet the topology and settings of one SD-WAN configuration by ID.

Input Parameters

string
required
SD-WAN configuration ID, normally obtained from List SD-WAN Configs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: UNIFI_GET_SD_WAN_CONFIG_STATUSGet deployment, generation, WAN, tunnel, warning, and error status for one SD-WAN configuration.

Input Parameters

string
required
SD-WAN configuration ID, normally obtained from List SD-WAN Configs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: UNIFI_LIST_DEVICESList 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

array
Only return devices managed by these Site Manager host IDs.
integer
Maximum host-grouped device records to return in this page (1-500).
string
Continuation cursor returned by a previous call; omit for the first page.
string
Only return device data processed after this RFC3339 timestamp.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: UNIFI_LIST_HOSTSList UniFi hosts associated with the connected UI account. Use the returned host IDs with device filters, site metrics, and host detail tools.

Input Parameters

integer
Maximum hosts to return in this page (1-500).
string
Continuation cursor returned by a previous call; omit for the first page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: UNIFI_LIST_SD_WAN_CONFIGSList the SD-WAN configurations associated with the connected UI account.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: UNIFI_LIST_SITESList sites from UniFi Network applications associated with the connected UI account. Use returned host and site IDs for selected-site ISP metrics.

Input Parameters

integer
Maximum sites to return in this page (1-500).
string
Continuation cursor returned by a previous call; omit for the first page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: UNIFI_QUERY_ISP_METRICSGet 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

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not