go-unifi
ReferenceOfficial APIOpenAPI SpecSites

List Local Sites

Retrieve a paginated list of local sites managed by this Network application. Site ID is required for other UniFi Network API calls. <details> <summary>Filterable properties (click to expand)</summary> |Name|Type|Allowed functions| |-|-|-| |`id`|`UUID`|`eq` `ne` `in` `notIn`| |`internalReference`|`STRING`|`eq` `ne` `in` `notIn`| |`name`|`STRING`|`eq` `ne` `in` `notIn`| </details>

GET
/v1/sites

Retrieve a paginated list of local sites managed by this Network application. Site ID is required for other UniFi Network API calls.

NameTypeAllowed functions
idUUIDeq ne in notIn
internalReferenceSTRINGeq ne in notIn
nameSTRINGeq ne in notIn

Authorization

ApiKey
X-Api-Key<token>

UniFi API key. Create one under Control Plane → Admins & Users → your admin → Create API Key (requires controller 9.0.114+).

In: header

Query Parameters

offset?integer
limit?integer
filter?string

Response Body

application/json

curl -X GET "https://example.com/v1/sites"
{  "offset": 0,  "limit": 25,  "count": 10,  "totalCount": 1000,  "data": [    {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "internalReference": "string",      "name": "string"    }  ]}

Update Network PUT

Update an existing network on a site.

List Countries GET

Returns ISO-standard country codes and names, used for region-based configuration or regulatory compliance. <details> <summary>Filterable properties (click to expand)</summary> |Name|Type|Allowed functions| |-|-|-| |`code`|`STRING`|`eq` `ne` `in` `notIn`| |`name`|`STRING`|`eq` `ne` `in` `notIn` `like`| </details>