Managed network

Networks Nimag manages with UniFi: devices and Wi-Fi.

GET/services/{service_id}/unifiA managed network
POST/services/{service_id}/unifi/devices/{device_id}/restartRestart a device
GET/services/{service_id}/unifi/wifiWi-Fi networks
PUT/services/{service_id}/unifi/wifi/{wlan_id}/passwordChange a Wi-Fi password
POST/services/{service_id}/unifi/adoptAdopt a device

A managed network

GET/services/{service_id}/unifi

Needs the permission network:read

Its devices and their state.

Path

service_idrequired string (uuid)

Response 200

`name`required	string
`devices`required	object[]
`id`required	string
`name`required	string
`model`required	string
`kind`required	string
`mac`required	string
`ip`required	string \| null
`state`required	string
`firmware`required	string \| null
`firmware_updatable`required	boolean
`uptime_seconds`required	integer \| null
`clients`required	integer
`online`required	integer
`clients`required	integer

curl "https://portal.nimag.net/api/v1/services/{service_id}/unifi" \
  -H "Authorization: Bearer nck_…"

{
  "name": "string",
  "devices": [
    {
      "id": "string",
      "name": "string",
      "model": "string",
      "kind": "string",
      "mac": "string",
      "ip": "string",
      "state": "string",
      "firmware": "string",
      "firmware_updatable": true,
      "uptime_seconds": 0,
      "clients": 0
    }
  ],
  "online": 0,
  "clients": 0
}

Restart a device

POST/services/{service_id}/unifi/devices/{device_id}/restart

Needs the permission network:devices:manage

The device goes offline for a minute or two.

Path

`service_id`required	string (uuid)
`device_id`required	string

Response 202: Successful Response.

curl -X POST "https://portal.nimag.net/api/v1/services/{service_id}/unifi/devices/{device_id}/restart" \
  -H "Authorization: Bearer nck_…"

"string"

Wi-Fi networks

GET/services/{service_id}/unifi/wifi

Needs the permission network:read

Path

service_idrequired string (uuid)

Response 200

`id`required	string
`name`required	string
`enabled`required	boolean
`security`required	string
`guest`required	boolean
`hidden`required	boolean
`bands`required	string[]
`password`required	string \| null
`password_changeable`required	boolean

curl "https://portal.nimag.net/api/v1/services/{service_id}/unifi/wifi" \
  -H "Authorization: Bearer nck_…"

[
  {
    "id": "string",
    "name": "string",
    "enabled": true,
    "security": "string",
    "guest": true,
    "hidden": true,
    "bands": [
      "string"
    ],
    "password": "string",
    "password_changeable": true
  }
]

Change a Wi-Fi password

PUT/services/{service_id}/unifi/wifi/{wlan_id}/password

Needs the permission network:wifi:manage

Every device on that network has to join it again with the new password.

Path

`service_id`required	string (uuid)
`wlan_id`required	string

Body (JSON)

passwordrequired string up to 63 characters

Response 204: no content.

curl -X PUT "https://portal.nimag.net/api/v1/services/{service_id}/unifi/wifi/{wlan_id}/password" \
  -H "Authorization: Bearer nck_…" \
  -H "Content-Type: application/json" \
  -d '{
    "password": "string"
  }'

Adopt a device

POST/services/{service_id}/unifi/adopt

Needs the permission network:devices:manage

Adds a new device to the network.

Path

service_idrequired string (uuid)

Body (JSON)

macrequired string up to 32 characters

Response 202

`mac`required	string
`model`required	string

curl -X POST "https://portal.nimag.net/api/v1/services/{service_id}/unifi/adopt" \
  -H "Authorization: Bearer nck_…" \
  -H "Content-Type: application/json" \
  -d '{
    "mac": "string"
  }'

{
  "mac": "string",
  "model": "string"
}