UniFi

App · 9 actions

Read UniFi Site Manager hosts, devices, sites, ISP metrics and SD-WAN configurations.

Actions

ActionWhat it does
Get hostGet Host by ID.
Get ISP metricsGet ISP Metrics.
Get SD-WAN configurationGet SD-WAN Config by ID.
Get SD-WAN configuration statusGet SD-WAN Config Status.
List devicesList Devices.
List hostsList Hosts.
List SD-WAN configurationsList SD-WAN Configs.
List sitesList Sites.
Query ISP metricsQuery ISP Metrics.

Get host

Get Host by ID.

Inputs

IdidtextRequired
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

TypetypetextRequired
Specifies whether metrics are returned using `5m` or `1h` intervalsOne of: 5m, 1h.
Begin timestampbeginTimestampdate and time
The earliest timestamp to retrieve data from (RFC3339 format)
End timestampendTimestampdate and time
The latest timestamp to retrieve data up to (RFC3339 format)
Durationdurationtext
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

IdidtextRequired
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

IdidtextRequired
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
Timetimedate and time
Last processed timestamp of devices in RFC3339 format
Page sizepageSizenumber
Number of records in a page.From 1 to 100.
Next tokennextTokentext
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 sizepageSizenumber
Number of records in a page.From 1 to 100.
Next tokennextTokentext
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 sizepageSizenumber
Number of records in a page.From 1 to 100.
Next tokennextTokentext
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

TypetypetextRequired
Specifies whether metrics are returned using `5m` or `1h` intervalsOne of: 5m, 1h.
Sitesite_idtextRequired
Choose the site whose ISP metrics you want.
StartbeginTimestampdate and time
Start of the metric range.
EndendTimestampdate 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"
  }
}

On this page