UniFi
App · 9 actions
Read UniFi Site Manager hosts, devices, sites, ISP metrics and SD-WAN configurations.
Actions
| Action | What it does |
|---|---|
| Get host | Get Host by ID. |
| Get ISP metrics | Get ISP Metrics. |
| Get SD-WAN configuration | Get SD-WAN Config by ID. |
| Get SD-WAN configuration status | Get SD-WAN Config Status. |
| List devices | List Devices. |
| List hosts | List Hosts. |
| List SD-WAN configurations | List SD-WAN Configs. |
| List sites | List Sites. |
| Query ISP metrics | Query ISP Metrics. |
Get host
Get Host by ID.
Inputs
- Id
idtextRequired - Unique identifier of the host
Outputs
dataobject- Uni Fi response data.
Example output
{
"data": {
"data": {
"hardwareId": "example",
"id": "example",
"ipAddress": "example",
"isBlocked": false,
"lastConnectionStateChange": "example",
"latestBackupTime": "example",
"owner": false,
"registrationTime": "example",
"reportedState": {},
"type": "example",
"userData": {}
},
"httpStatusCode": 1,
"traceId": "example"
}
}Get ISP metrics
Get ISP Metrics.
Inputs
- Type
typetextRequired - Specifies whether metrics are returned using `5m` or `1h` intervalsOne of:
5m,1h. - Begin timestamp
beginTimestampdate and time - The earliest timestamp to retrieve data from (RFC3339 format)
- End timestamp
endTimestampdate and time - The latest timestamp to retrieve data up to (RFC3339 format)
- Duration
durationtext - Specifies the time range of metrics to retrieve, starting from when the request is made. Supports `24h` for 5-minute metrics, and `7d` or `30d` for 1-hour metrics. This parameter **cannot** be used with `beginTimestamp` or `endTimestamp`.One of:
24h,7d,30d.
Outputs
dataobject- Uni Fi response data.
Example output
{
"data": {
"data": [],
"httpStatusCode": 1,
"traceId": "example"
}
}Get SD-WAN configuration
Get SD-WAN Config by ID.
Inputs
- Id
idtextRequired - Unique identifier of the SD-WAN configuration
Outputs
dataobject- Uni Fi response data.
Example output
{
"data": {
"data": {
"hubs": [],
"id": "example",
"name": "example",
"settings": {
"hubsInterconnect": false,
"spokeStandardSettingsEnabled": false,
"spokeStandardSettingsValues": {
"primaryWan": "example",
"wanFailover": false
},
"spokeToHubRouting": "custom",
"spokeToHubTunnelsMode": "maxResiliency",
"spokesAutoScaleAndNatEnabled": false,
"spokesAutoScaleAndNatRange": "example",
"spokesIsolate": false
},
"spokes": [],
"type": "sdwan-hbsp",
"variant": "distributed"
},
"httpStatusCode": 1,
"traceId": "example"
}
}Get SD-WAN configuration status
Get SD-WAN Config Status.
Inputs
- Id
idtextRequired - Unique identifier of the SD-WAN configuration
Outputs
dataobject- Uni Fi response data.
Example output
{
"data": {
"data": {
"errors": [],
"fingerprint": "example",
"generateStatus": "OK",
"hubs": [],
"id": "example",
"lastGeneratedAt": 1,
"spokes": [],
"updatedAt": 1,
"warnings": []
},
"httpStatusCode": 1,
"traceId": "example"
}
}List devices
List Devices.
Inputs
- Host IDs[]
hostIdslist - List of host IDs to filter the results
- Time
timedate and time - Last processed timestamp of devices in RFC3339 format
- Page size
pageSizenumber - Number of records in a page.From 1 to 100.
- Next token
nextTokentext - Token for pagination to retrieve the next set of results
Outputs
dataobject- Uni Fi response data.
Example output
{
"data": {
"code": {},
"data": [],
"httpStatusCode": 1,
"nextToken": "example",
"traceId": "example"
}
}List hosts
List Hosts.
Inputs
- Page size
pageSizenumber - Number of records in a page.From 1 to 100.
- Next token
nextTokentext - Token for pagination to retrieve the next set of results
Outputs
dataobject- Uni Fi response data.
Example output
{
"data": {
"code": {},
"data": [],
"httpStatusCode": 1,
"nextToken": "example",
"traceId": "example"
}
}List SD-WAN configurations
List SD-WAN Configs.
Inputs
None.
Outputs
dataobject- Uni Fi response data.
Example output
{
"data": {
"data": [],
"httpStatusCode": 1,
"traceId": "example"
}
}List sites
List Sites.
Inputs
- Page size
pageSizenumber - Number of records in a page.From 1 to 100.
- Next token
nextTokentext - Token for pagination to retrieve the next set of results
Outputs
dataobject- Uni Fi response data.
Example output
{
"data": {
"code": {},
"data": [],
"httpStatusCode": 1,
"nextToken": "example",
"traceId": "example"
}
}Query ISP metrics
Query ISP Metrics.
Inputs
- Type
typetextRequired - Specifies whether metrics are returned using `5m` or `1h` intervalsOne of:
5m,1h. - Site
site_idtextRequired - Choose the site whose ISP metrics you want.
- Start
beginTimestampdate and time - Start of the metric range.
- End
endTimestampdate and time - End of the metric range.
Outputs
dataobject- Uni Fi response data.
Example output
{
"data": {
"data": {
"message": "example",
"metrics": [],
"status": "example"
},
"httpStatusCode": 1,
"traceId": "example"
}
}