Unifi icon

Unifi

Interact with Unifi API

Site → Get Site Health

AI-generated

Summary

Retrieve the health status of a specific UniFi site identified by its site ID.

Inputs

  • siteId (required) — The unique identifier of the site to retrieve health information for, found in the "name" field of the response from the "Get Sites" operation.
  • splitIntoItems — Whether to return each entry of the site health data as a separate item (true) or to return the raw response as a single item (false). Defaults to true.

Output shape

a list of JSON items representing the health data of the specified site when splitIntoItems is true; otherwise a single JSON item containing the raw response object

The response is an array of objects when splitIntoItems is true, each object per site health entry. If splitIntoItems is false, the output is a single item with the full raw response. Errors include authentication and permissions issues with descriptive messages.

Examples

Example 1: Get Site Health with item splitting

Set resource to Site, operation to Get Site Health, specify siteId, and enable Split Into Items (default true). The output is multiple items each containing a single site health record.

Discussion