### Error Response Example

Source: https://docs.cloud.cambiumnetworks.com/api/5.0.0/summary.html

An example of an error response when the access token request fails. Common errors include missing parameters or invalid client authentication.

```json
HTTP/1.1 400 Bad Request
Content-Type: application/json;charset=UTF-8
Cache-Control: no-store
Pragma: no-cache

{
    "error": "invalid_request"
    
}
```

--------------------------------

### GET /portals

Source: https://docs.cloud.cambiumnetworks.com/api/5.0.0/index.html

Retrieves a list of all guest access portals.

```APIDOC
## GET /portals

### Description
Returns list of guest access portals.

### Method
GET

### Endpoint
/portals
```

--------------------------------

### Accessing Resources via HTTP GET

Source: https://docs.cloud.cambiumnetworks.com/api/5.0.0/summary.html

This snippet shows the general format for accessing API resources using an HTTP GET request. The 'Authorization' header must contain the obtained 'access_token'.

```http
GET /api/v2/devices HTTP/1.1
Accept: application/json
Authorization: Bearer ACCESS_TOKEN
```

--------------------------------

### GET /api/v2/devices

Source: https://docs.cloud.cambiumnetworks.com/api/5.0.0/announcements.html

Deprecation notices for the GET /api/v2/devices endpoint.

```APIDOC
## GET /api/v2/devices

### Description
This endpoint retrieves device information. Several fields and keys are deprecated.

### Method
GET

### Endpoint
/api/v2/devices

### Parameters
#### Query Parameters
- **ap_group** (string) - Deprecated - Support for ap_group field is deprecated and will be removed in cnMaestro release 5.2.0, use profile_attached key instead.
- **location_type** (string) - Deprecated - Location type is deprecated and will be removed in cnMaestro release 5.2.0.
- **status** (string) - Deprecated - status key is deprecated and will be removed in cnMaestro release 5.2.0, use online key instead.

### Response
#### Success Response (200)
- **profile_attached** (string) - Use instead of ap_group.
- **online** (boolean) - Use instead of status.

### Deprecation Details
- `ap_group` field is deprecated and will be removed in cnMaestro release 5.2.0. Use `profile_attached` instead.
- `location` type is deprecated and will be removed in cnMaestro release 5.2.0.
- `status` key is deprecated and will be removed in cnMaestro release 5.2.0. Use `online` key instead.
```

--------------------------------

### Access Resources with Bearer Token

Source: https://docs.cloud.cambiumnetworks.com/api/5.0.0/summary.html

Once an access token is obtained, use it in the Authorization header with the 'Bearer' scheme to access protected API resources. This example demonstrates fetching devices.

```http
GET https://{server_url}/api/v2/devices HTTP/1.1
Accept: application/json
Authorization: Bearer ACCESS_TOKEN
```

--------------------------------

### GET /devices/wired_clients

Source: https://docs.cloud.cambiumnetworks.com/api/5.0.0/announcements.html

Deprecation notice for the wired clients endpoint.

```APIDOC
## GET /devices/wired_clients

### Description
This endpoint retrieves information about wired clients. The `ap_mac` field is deprecated.

### Method
GET

### Endpoint
/devices/wired_clients

### Deprecation Details
- The `ap_mac` field is deprecated and replaced with `device_mac` to accommodate non-Wi-Fi devices.
- This deprecation will be removed in cnMaestro release 5.3.0.
```

--------------------------------

### cnArcher API Endpoints

Source: https://docs.cloud.cambiumnetworks.com/api/5.0.0/announcements.html

Endpoints for retrieving cnArcher installation summaries.

```APIDOC
## GET /api/v2/cnarcher/installation/summary

### Description
Returns a list of SM Installation Summaries (PMP, ePMP).

### Method
GET

### Endpoint
/api/v2/cnarcher/installation/summary

### Response
#### Success Response (200)
- **summaries** (array) - A list of installation summary objects.
  - **mac** (string) - The MAC address of the SM.
  - **status** (string) - The installation status.

#### Response Example
{
  "summaries": [
    {
      "mac": "00:11:22:33:44:55",
      "status": "installed"
    }
  ]
}

## GET /api/v2/cnarcher/installation/summary/{mac}

### Description
Returns the installation summary for a specific SM (PMP, ePMP).

### Method
GET

### Endpoint
/api/v2/cnarcher/installation/summary/{mac}

### Parameters
#### Path Parameters
- **mac** (string) - Required - The MAC address of the SM.

### Response
#### Success Response (200)
- **summary** (object) - The installation summary object.
  - **mac** (string) - The MAC address of the SM.
  - **status** (string) - The installation status.

#### Response Example
{
  "summary": {
    "mac": "00:11:22:33:44:55",
    "status": "installed"
  }
}
```

--------------------------------

### GET /devices/clients

Source: https://docs.cloud.cambiumnetworks.com/api/5.0.0/announcements.html

Deprecation notices for the Wi-Fi Enterprise clients endpoint.

```APIDOC
## GET /devices/clients

### Description
This endpoint retrieves information about Wi-Fi clients. The `ap_mac` field and fields within the `radio` property are deprecated.

### Method
GET

### Endpoint
/devices/clients

### Deprecation Details
- The `ap_mac` field is deprecated and replaced with `device_mac` to accommodate non-Wi-Fi devices.
- `rx_bytes` and `tx_bytes` fields within the `radio` property are deprecated.
- These deprecations will be removed in cnMaestro release 5.3.0.
```

--------------------------------

### GET /devices/{mac}/performance

Source: https://docs.cloud.cambiumnetworks.com/api/5.0.0/index.html

Retrieves performance metrics for a specific device identified by its MAC address.

```APIDOC
## GET /devices/{mac}/performance

### Description
Returns single device performance.

### Method
GET

### Endpoint
/devices/{mac}/performance

### Parameters
#### Path Parameters
- **mac** (string) - Required - The MAC address of the device.
```

--------------------------------

### GET /api/v2/devices/{mac}/performance

Source: https://docs.cloud.cambiumnetworks.com/api/5.0.0/announcements.html

Deprecation notice for fields within the Device Performance API.

```APIDOC
## GET /api/v2/devices/{mac}/performance

### Description
This endpoint retrieves device performance data. Several performance-related fields are deprecated.

### Method
GET

### Endpoint
/api/v2/devices/{mac}/performance

### Deprecation Details
- `rx`, `tx`, `max_rx`, `min_rx`, `max_tx`, `min_tx` fields are deprecated and will be removed in cnMaestro release 5.2.0.
```

--------------------------------

### GET /msp/managed_accounts

Source: https://docs.cloud.cambiumnetworks.com/api/5.0.0/index.html

Retrieves a list of managed accounts for MSP users.

```APIDOC
## GET /msp/managed_accounts

### Description
Returns list of managed accounts.

### Method
GET

### Endpoint
/msp/managed_accounts
```

--------------------------------

### POST /networks

Source: https://docs.cloud.cambiumnetworks.com/api/5.0.0/index.html

Creates a new network within the system.

```APIDOC
## POST /networks

### Description
Create network

### Method
POST

### Endpoint
/networks
```

--------------------------------

### POST /ext-portals/login

Source: https://docs.cloud.cambiumnetworks.com/api/5.0.0/index.html

Handles external guest portal login requests.

```APIDOC
## POST /ext-portals/login

### Description
External guest portal login.

### Method
POST

### Endpoint
/ext-portals/login
```

--------------------------------

### On-Premises Access Token Request

Source: https://docs.cloud.cambiumnetworks.com/api/5.0.0/summary.html

This sample shows how to request an access token for an on-premises cnMaestro deployment. Ensure the correct server URL and credentials are used.

```http
POST https://{server_url}/api/v2/access/token HTTP/1.1
Content-Type: application/x-www-form-urlencoded

grant_type=client_credentials&client_id=s6BhdRkqt3&client_secret=s6BhdRkqt3&client_secret=7Fjfp0ZBr1KtDRbnfVdmIw
```

--------------------------------

### Cloud Access Token Request

Source: https://docs.cloud.cambiumnetworks.com/api/5.0.0/summary.html

This sample demonstrates requesting an access token for the cloud-hosted cnMaestro service. Use the provided cloud endpoint and your client credentials.

```http
POST https://cloud.cambiumnetworks.com/api/v2/access/token HTTP/1.1
Content-Type: application/x-www-form-urlencoded

grant_type=client_credentials&client_id=s6BhdRkqt3&client_secret=7Fjfp0ZBr1KtDRbnfVdmIw
```

--------------------------------

### Devices API

Source: https://docs.cloud.cambiumnetworks.com/api/5.0.0/index.html

Endpoints for device management, including onboarding, status, and remote operations.

```APIDOC
## GET /devices

### Description
Returns a list of devices.

### Method
GET

### Endpoint
/devices

## POST /devices

### Description
Onboard device.

### Method
POST

### Endpoint
/devices

## GET /devices/{mac}

### Description
Returns a device information.

### Method
GET

### Endpoint
/devices/{mac}

### Parameters
#### Path Parameters
- **mac** (string) - Required - The MAC address of the device.
```

--------------------------------

### WLAN Management API

Source: https://docs.cloud.cambiumnetworks.com/api/5.0.0/index.html

APIs for managing Enterprise WLANs and ePSK configurations.

```APIDOC
## GET /wifi_enterprise/wlans

### Description
Returns a list of WLANs.

### Method
GET

### Endpoint
/wifi_enterprise/wlans

## POST /wifi_enterprise/wlans

### Description
Creates a new WLAN.

### Method
POST

### Endpoint
/wifi_enterprise/wlans

## GET /wifi_enterprise/wlans/{wlan_name}

### Description
Returns single WLAN information.

### Method
GET

### Endpoint
/wifi_enterprise/wlans/{wlan_name}

### Parameters
#### Path Parameters
- **wlan_name** (string) - Required - The name of the WLAN.

## PUT /wifi_enterprise/wlans/{wlan_name}

### Description
Updates an existing WLAN.

### Method
PUT

### Endpoint
/wifi_enterprise/wlans/{wlan_name}

### Parameters
#### Path Parameters
- **wlan_name** (string) - Required - The name of the WLAN to update.

## DELETE /wifi_enterprise/wlans/{wlan_name}

### Description
Deletes a WLAN.

### Method
DELETE

### Endpoint
/wifi_enterprise/wlans/{wlan_name}

### Parameters
#### Path Parameters
- **wlan_name** (string) - Required - The name of the WLAN to delete.

## DELETE /msp/managed_accounts/{managed_account}/wifi_enterprise/wlans/{wlan_name}

### Description
Deletes a WLAN under a managed account.

### Method
DELETE

### Endpoint
/msp/managed_accounts/{managed_account}/wifi_enterprise/wlans/{wlan_name}

### Parameters
#### Path Parameters
- **managed_account** (string) - Required - The managed account identifier.
- **wlan_name** (string) - Required - The name of the WLAN to delete.

## GET /wifi_enterprise/wlans/{wlan_name}/epsk

### Description
Returns a list of ePSK entries for a specified WLAN.

### Method
GET

### Endpoint
/wifi_enterprise/wlans/{wlan_name}/epsk

### Parameters
#### Path Parameters
- **wlan_name** (string) - Required - The name of the WLAN.

## POST /wifi_enterprise/wlans/{wlan_name}/epsk/generate

### Description
Generates ePSK entries for a WLAN.

### Method
POST

### Endpoint
/wifi_enterprise/wlans/{wlan_name}/epsk/generate

### Parameters
#### Path Parameters
- **wlan_name** (string) - Required - The name of the WLAN.

## PUT /wifi_enterprise/wlans/{wlan_name}/epsk/edit

### Description
Edits ePSK entries for a WLAN.

### Method
PUT

### Endpoint
/wifi_enterprise/wlans/{wlan_name}/epsk/edit

### Parameters
#### Path Parameters
- **wlan_name** (string) - Required - The name of the WLAN.

## POST /wifi_enterprise/wlans/{wlan_name}/epsk/delete

### Description
Deletes one or more existing ePSK entries.

### Method
POST

### Endpoint
/wifi_enterprise/wlans/{wlan_name}/epsk/delete

### Parameters
#### Path Parameters
- **wlan_name** (string) - Required - The name of the WLAN.
```

--------------------------------

### HTTP Standards and Headers

Source: https://docs.cloud.cambiumnetworks.com/api/5.0.0/summary.html

Overview of standard HTTP response codes and required request headers for the cnMaestro API.

```APIDOC
## HTTP Standards

### Request Headers
- **Authorization** (string) - Required - Used to send the Access Token. Example: `Authorization: Bearer <Access-Token>`
- **Accept** (string) - Required - Set to `application/json`
- **Content-Type** (string) - Required - Set to `application/json`

### HTTP Response Codes
- **200** - OK: Standard response for successful requests.
- **400** - Bad Request: Request validation error.
- **401** - Unauthorized: Authentication required.
- **403** - Forbidden: Access to resource not permitted.
- **404** - Not Found: Resource could not be located.
- **405** - Method Not Allowed: Method not supported for the resource.
- **413** - Payload Too Large: Request exceeds server limits.
- **422** - Unprocessable Entity: Server cannot process the request.
- **429** - Too Many Requests: Rate limit exceeded.
- **431** - Request Header Fields Too Large: Headers exceed size limits.
- **500** - Internal Server Error: Server-side error.
- **501** - Not Implemented: Method not recognized.
- **502** - Bad Gateway: Internal server error.
- **503** - Service Unavailable: Internal server error.
```

--------------------------------

### Access Resources

Source: https://docs.cloud.cambiumnetworks.com/api/5.0.0/summary.html

Once an access token is obtained, it can be used to authenticate requests to access various resources provided by the API.

```APIDOC
## Access Resources

### Description
Access API resources using a valid access token.

### Method
GET

### Endpoint
/api/v2/devices

### Parameters
#### Headers
- **Accept** (string) - Required - Specifies the desired response format, typically "application/json".
- **Authorization** (string) - Required - The access token obtained from the token endpoint, formatted as "Bearer ACCESS_TOKEN".

### Request Example
```http
GET /api/v2/devices HTTP/1.1
Accept: application/json
Authorization: Bearer ACCESS_TOKEN
```

### Response
#### Success Response (200)
- The response body will contain the requested resources in JSON format. Specific fields depend on the resource being accessed.

#### Response Example (for /api/v2/devices)
```json
{
  "devices": [
    {
      "id": "device-123",
      "name": "AccessPoint-01",
      "mac_address": "00:11:22:33:44:55"
    }
  ]
}
```
```

--------------------------------

### Access Token Request with Authorization Header

Source: https://docs.cloud.cambiumnetworks.com/api/5.0.0/summary.html

Use this request to obtain an access token by including credentials in the Authorization header. Ensure the client ID and secret are base64 encoded and separated by a colon.

```http
POST /api/v2/access/token HTTP/1.1
Host: server.example.com
Authorization: Basic czZCaGRSa3F0MzpnWDFmQmF0M2JW
Content-Type: application/x-www-form-urlencoded

grant_type=client_credentials
```

--------------------------------

### Security API

Source: https://docs.cloud.cambiumnetworks.com/api/5.0.0/index.html

APIs for retrieving security-related information from NSE devices.

```APIDOC
## GET /devices/{mac}/threats

### Description
Returns threats captured by an NSE device.

### Method
GET

### Endpoint
/devices/{mac}/threats

### Parameters
#### Path Parameters
- **mac** (string) - Required - The MAC address of the NSE device.

## GET /devices/{mac}/vpn_sessions

### Description
Returns the client VPN sessions of an NSE device.

### Method
GET

### Endpoint
/devices/{mac}/vpn_sessions

### Parameters
#### Path Parameters
- **mac** (string) - Required - The MAC address of the NSE device.

## GET /devices/{mac}/vulnerable_clients

### Description
Returns all vulnerable clients of an NSE device.

### Method
GET

### Endpoint
/devices/{mac}/vulnerable_clients

### Parameters
#### Path Parameters
- **mac** (string) - Required - The MAC address of the NSE device.

## GET /devices/{mac}/clients/vulnerabilities

### Description
Returns vulnerabilities of all clients associated with an NSE device.

### Method
GET

### Endpoint
/devices/{mac}/clients/vulnerabilities

### Parameters
#### Path Parameters
- **mac** (string) - Required - The MAC address of the NSE device.

## GET /devices/clients/{client_mac}/vulnerabilities

### Description
Returns vulnerabilities of a single NSE client.

### Method
GET

### Endpoint
/devices/clients/{client_mac}/vulnerabilities

### Parameters
#### Path Parameters
- **client_mac** (string) - Required - The MAC address of the NSE client.
```

--------------------------------

### Access Token Request with Credentials in Body

Source: https://docs.cloud.cambiumnetworks.com/api/5.0.0/summary.html

Alternatively, pass client credentials directly in the request body for obtaining an access token. This method avoids the need for base64 encoding in the Authorization header.

```http
POST /api/v2/access/token HTTP/1.1
Host: server.example.com
Content-Type: application/x-www-form-urlencoded

grant_type=client_credentials&client_id=s6BhdRkqt3&client_secret=7Fjfp0ZBr1KtDRbnfVdmIw
```

--------------------------------

### 60 GHz cnWave API Endpoints

Source: https://docs.cloud.cambiumnetworks.com/api/5.0.0/announcements.html

Endpoints for managing and monitoring 60 GHz cnWave devices.

```APIDOC
## GET /api/v2/cnwave60/devices/{mac}/best_route

### Description
Returns the best route for the given node.

### Method
GET

### Endpoint
/api/v2/cnwave60/devices/{mac}/best_route

### Parameters
#### Path Parameters
- **mac** (string) - Required - The MAC address of the node.

### Response
#### Success Response (200)
- **route** (object) - Description of the best route.

#### Response Example
{
  "route": {
    "next_hop": "00:11:22:33:44:55",
    "metric": 10
  }
}

## POST /api/v2/cnwave60/devices/{mac}/iperf

### Description
Starts Iperf on the given node.

### Method
POST

### Endpoint
/api/v2/cnwave60/devices/{mac}/iperf

### Parameters
#### Path Parameters
- **mac** (string) - Required - The MAC address of the node.

### Request Example
{
  "duration": 60,
  "bandwidth": "100M"
}

### Response
#### Success Response (200)
- **status** (string) - The status of the Iperf test.

#### Response Example
{
  "status": "started"
}

## POST /api/v2/cnwave60/devices/{mac}/links/{link_name}/iperf

### Description
Starts Iperf on the given node and link node.

### Method
POST

### Endpoint
/api/v2/cnwave60/devices/{mac}/links/{link_name}/iperf

### Parameters
#### Path Parameters
- **mac** (string) - Required - The MAC address of the node.
- **link_name** (string) - Required - The name of the link.

### Request Example
{
  "duration": 60,
  "bandwidth": "100M"
}

### Response
#### Success Response (200)
- **status** (string) - The status of the Iperf test.

#### Response Example
{
  "status": "started"
}

## GET /api/v2/cnwave60/devices/{mac}/iperf /api/v2/cnwave60/devices/{mac}/links/{link_name}/iperf

### Description
Returns the Iperf results.

### Method
GET

### Endpoint
/api/v2/cnwave60/devices/{mac}/iperf or /api/v2/cnwave60/devices/{mac}/links/{link_name}/iperf

### Parameters
#### Path Parameters
- **mac** (string) - Required - The MAC address of the node.
- **link_name** (string) - Optional - The name of the link.

### Response
#### Success Response (200)
- **results** (object) - The Iperf test results.

#### Response Example
{
  "results": {
    "throughput": "95.5 Mbps",
    "jitter": "2 ms"
  }
}
```

--------------------------------

### Wi-Fi Enterprise API Endpoints

Source: https://docs.cloud.cambiumnetworks.com/api/5.0.0/announcements.html

Endpoints for managing Wi-Fi Enterprise clients.

```APIDOC
## GET /devices/{mac}/clients

### Description
Returns a list of clients at the device level with filters for wired, wireless, and all clients.

### Method
GET

### Endpoint
/devices/{mac}/clients

### Parameters
#### Path Parameters
- **mac** (string) - Required - The MAC address of the device.

#### Query Parameters
- **filter** (string) - Optional - Filters clients by 'wired', 'wireless', or 'all'. Defaults to 'all'.

### Response
#### Success Response (200)
- **clients** (array) - A list of client objects.
  - **client_mac** (string) - The MAC address of the client.
  - **ip_address** (string) - The IP address of the client.
  - **connection_type** (string) - The type of connection (wired/wireless).

#### Response Example
{
  "clients": [
    {
      "client_mac": "AA:BB:CC:DD:EE:FF",
      "ip_address": "192.168.1.100",
      "connection_type": "wireless"
    }
  ]
}
```

--------------------------------

### Access Token Response

Source: https://docs.cloud.cambiumnetworks.com/api/5.0.0/summary.html

The successful response contains the access token, token type, expiration time in seconds, and the redirect URI. Use the 'access_token' for subsequent authenticated requests.

```json
{
  "access_token":"2YotnFZFEjr1zCsicMWpAA",
  "token_type":"bearer",
  "expires_in":3600,
  "redirect_uri": "https://{server_url}"
  
}
```

--------------------------------

### Access Control API

Source: https://docs.cloud.cambiumnetworks.com/api/5.0.0/index.html

Endpoints for managing cnPilot Enterprise Access Control Policies.

```APIDOC
## GET /wifi_enterprise/access_control

### Description
Returns a list of Access control Policies (E-Series XV-Series).

### Method
GET

### Endpoint
/wifi_enterprise/access_control

## POST /wifi_enterprise/access_control

### Description
Create an Access Control Policy (E-Series XV-Series).

### Method
POST

### Endpoint
/wifi_enterprise/access_control

## GET /wifi_enterprise/access_control/{acp_name}

### Description
Returns single Access Control Policy information (E-Series XV-Series).

### Method
GET

### Endpoint
/wifi_enterprise/access_control/{acp_name}

### Parameters
#### Path Parameters
- **acp_name** (string) - Required - The name of the access control policy.
```

--------------------------------

### 60 GHz cnWave API

Source: https://docs.cloud.cambiumnetworks.com/api/5.0.0/index.html

APIs for managing 60 GHz cnWave networks, devices, and configurations.

```APIDOC
## GET /cnwave60/networks/{network_id}/controller

### Description
Returns controller information for a given network.

### Method
GET

### Endpoint
/cnwave60/networks/{network_id}/controller

### Parameters
#### Path Parameters
- **network_id** (string) - Required - The ID of the network.

## GET /cnwave60/networks/{network_id}/configuration

### Description
Retrieves the network configuration.

### Method
GET

### Endpoint
/cnwave60/networks/{network_id}/configuration

### Parameters
#### Path Parameters
- **network_id** (string) - Required - The ID of the network.

## PUT /cnwave60/networks/{network_id}/configuration

### Description
Updates the network configuration.

### Method
PUT

### Endpoint
/cnwave60/networks/{network_id}/configuration

### Parameters
#### Path Parameters
- **network_id** (string) - Required - The ID of the network.

## PUT /cnwave60/networks/{network_id}/optimization/{optimization_type}

### Description
Performs network configuration optimization.

### Method
PUT

### Endpoint
/cnwave60/networks/{network_id}/optimization/{optimization_type}

### Parameters
#### Path Parameters
- **network_id** (string) - Required - The ID of the network.
- **optimization_type** (string) - Required - The type of optimization to perform.

## GET /cnwave60/networks/{network_id}/controller/configuration

### Description
Retrieves the controller configuration for a network.

### Method
GET

### Endpoint
/cnwave60/networks/{network_id}/controller/configuration

### Parameters
#### Path Parameters
- **network_id** (string) - Required - The ID of the network.

## PUT /cnwave60/networks/{network_id}/controller/configuration

### Description
Updates the controller configuration for a network.

### Method
PUT

### Endpoint
/cnwave60/networks/{network_id}/controller/configuration

### Parameters
#### Path Parameters
- **network_id** (string) - Required - The ID of the network.

## GET /cnwave60/networks/{network_id}/devices/overrides

### Description
Retrieves device configuration overrides for a network.

### Method
GET

### Endpoint
/cnwave60/networks/{network_id}/devices/overrides

### Parameters
#### Path Parameters
- **network_id** (string) - Required - The ID of the network.

## PUT /cnwave60/networks/{network_id}/devices/overrides

### Description
Updates device configuration overrides for a network.

### Method
PUT

### Endpoint
/cnwave60/networks/{network_id}/devices/overrides

### Parameters
#### Path Parameters
- **network_id** (string) - Required - The ID of the network.

## GET /cnwave60/devices/{mac}/configuration

### Description
Retrieves the configuration for a specific device.

### Method
GET

### Endpoint
/cnwave60/devices/{mac}/configuration

### Parameters
#### Path Parameters
- **mac** (string) - Required - The MAC address of the device.

## PUT /cnwave60/devices/{mac}/configuration

### Description
Updates the configuration for a specific device.

### Method
PUT

### Endpoint
/cnwave60/devices/{mac}/configuration

### Parameters
#### Path Parameters
- **mac** (string) - Required - The MAC address of the device.

## POST /cnwave60/devices

### Description
Creates a new device.

### Method
POST

### Endpoint
/cnwave60/devices

## PUT /cnwave60/devices/{mac}

### Description
Edits an existing device.

### Method
PUT

### Endpoint
/cnwave60/devices/{mac}

### Parameters
#### Path Parameters
- **mac** (string) - Required - The MAC address of the device to edit.

## POST /cnwave60/networks/{network_id}/sites

### Description
Creates a new site within a network.

### Method
POST

### Endpoint
/cnwave60/networks/{network_id}/sites

### Parameters
#### Path Parameters
- **network_id** (string) - Required - The ID of the network.

## PUT /cnwave60/networks/{network_id}/sites/{site_id}

### Description
Edits an existing site within a network.

### Method
PUT

### Endpoint
/cnwave60/networks/{network_id}/sites/{site_id}

### Parameters
#### Path Parameters
- **network_id** (string) - Required - The ID of the network.
- **site_id** (string) - Required - The ID of the site to edit.

## DELETE /cnwave60/networks/{network_id}/sites/{site_id}

### Description
Deletes a site from a network.

### Method
DELETE

### Endpoint
/cnwave60/networks/{network_id}/sites/{site_id}

### Parameters
#### Path Parameters
- **network_id** (string) - Required - The ID of the network.
- **site_id** (string) - Required - The ID of the site to delete.

## GET /cnwave60/networks/{network_id}/links

### Description
Retrieves the links topology for a network.

### Method
GET

### Endpoint
/cnwave60/networks/{network_id}/links

### Parameters
#### Path Parameters
- **network_id** (string) - Required - The ID of the network.

## POST /cnwave60/networks/{network_id}/links

### Description
Creates a new link within a network.

### Method
POST

### Endpoint
/cnwave60/networks/{network_id}/links

### Parameters
#### Path Parameters
- **network_id** (string) - Required - The ID of the network.

## DELETE /cnwave60/networks/{network_id}/links/{link_name}

### Description
Deletes a link from a network.

### Method
DELETE

### Endpoint
/cnwave60/networks/{network_id}/links/{link_name}

### Parameters
#### Path Parameters
- **network_id** (string) - Required - The ID of the network.
- **link_name** (string) - Required - The name of the link to delete.

## PUT /cnwave60/networks/{network_id}/links/{link_name}/{link_operation}

### Description
Performs an operation on a link.

### Method
PUT

### Endpoint
/cnwave60/networks/{network_id}/links/{link_name}/{link_operation}

### Parameters
#### Path Parameters
- **network_id** (string) - Required - The ID of the network.
- **link_name** (string) - Required - The name of the link.
- **link_operation** (string) - Required - The operation to perform on the link.

## GET /cnwave60/networks/{network_id}/links/statistics

### Description
Returns statistics for network links.

### Method
GET

### Endpoint
/cnwave60/networks/{network_id}/links/statistics

### Parameters
#### Path Parameters
- **network_id** (string) - Required - The ID of the network.

## GET /cnwave60/devices/{mac}/links/statistics

### Description
Returns statistics for a device's links.

### Method
GET

### Endpoint
/cnwave60/devices/{mac}/links/statistics

### Parameters
#### Path Parameters
- **mac** (string) - Required - The MAC address of the device.

## GET /cnwave60/devices/{mac}/links/{link_name}/statistics

### Description
Returns statistics for a specific link of a device.

### Method
GET

### Endpoint
/cnwave60/devices/{mac}/links/{link_name}/statistics

### Parameters
#### Path Parameters
- **mac** (string) - Required - The MAC address of the device.
- **link_name** (string) - Required - The name of the link.

## GET /cnwave60/devices/{mac}/links/{link_name}/performance

### Description
Returns performance data for a specific link of a device.

### Method
GET

### Endpoint
/cnwave60/devices/{mac}/links/{link_name}/performance

### Parameters
#### Path Parameters
- **mac** (string) - Required - The MAC address of the device.
- **link_name** (string) - Required - The name of the link.

## POST /cnwave60/networks/{network_id}/jobs

### Description
Creates a software update job for 60 GHz cnWave devices.

### Method
POST

### Endpoint
/cnwave60/networks/{network_id}/jobs

### Parameters
#### Path Parameters
- **network_id** (string) - Required - The ID of the network.

## PUT /cnwave60/networks/{network_id}/software_images/sync

### Description
Initiates a software image synchronization for 60 GHz cnWave devices.

### Method
PUT

### Endpoint
/cnwave60/networks/{network_id}/software_images/sync

### Parameters
#### Path Parameters
- **network_id** (string) - Required - The ID of the network.

## GET /cnwave60/networks/{network_id}/software_images

### Description
Returns the software image synchronization status for a network.

### Method
GET

### Endpoint
/cnwave60/networks/{network_id}/software_images

### Parameters
#### Path Parameters
- **network_id** (string) - Required - The ID of the network.

## PUT /cnwave60/devices/{mac}/topology_scan

### Description
Runs a topology scan on the given node.

### Method
PUT

### Endpoint
/cnwave60/devices/{mac}/topology_scan

### Parameters
#### Path Parameters
- **mac** (string) - Required - The MAC address of the device.

## PUT /cnwave60/devices/{mac}/replace_node

### Description
Performs a Replace Node operation on the given MAC address.

### Method
PUT

### Endpoint
/cnwave60/devices/{mac}/replace_node

### Parameters
#### Path Parameters
- **mac** (string) - Required - The MAC address of the device.

## GET /cnwave60/devices/{mac}/best_route

### Description
Gets the best route for the given MAC address.

### Method
GET

### Endpoint
/cnwave60/devices/{mac}/best_route

### Parameters
#### Path Parameters
- **mac** (string) - Required - The MAC address of the device.

## POST /cnwave60/devices/{mac}/iperf

### Description
Runs an Iperf test on the given node.

### Method
POST

### Endpoint
/cnwave60/devices/{mac}/iperf

### Parameters
#### Path Parameters
- **mac** (string) - Required - The MAC address of the device.

## GET /cnwave60/devices/{mac}/iperf

### Description
Gets Iperf results for the given node.

### Method
GET

### Endpoint
/cnwave60/devices/{mac}/iperf

### Parameters
#### Path Parameters
- **mac** (string) - Required - The MAC address of the device.

## POST /cnwave60/devices/{mac}/links/{link_name}/iperf

### Description
Runs an Iperf test between two link nodes.

### Method
POST

### Endpoint
/cnwave60/devices/{mac}/links/{link_name}/iperf

### Parameters
#### Path Parameters
- **mac** (string) - Required - The MAC address of the device.
- **link_name** (string) - Required - The name of the link.

## GET /cnwave60/devices/{mac}/links/{link_name}/iperf

### Description
Gets Iperf results for the given node and link.

### Method
GET

### Endpoint
/cnwave60/devices/{mac}/links/{link_name}/iperf

### Parameters
#### Path Parameters
- **mac** (string) - Required - The MAC address of the device.
- **link_name** (string) - Required - The name of the link.
```

--------------------------------

### Security API Endpoints

Source: https://docs.cloud.cambiumnetworks.com/api/5.0.0/announcements.html

Endpoints for retrieving security-related information from NSE devices.

```APIDOC
## GET /devices/{mac}/threats

### Description
Returns a list of threats captured by an NSE device for the provided timeframe.

### Method
GET

### Endpoint
/devices/{mac}/threats

### Parameters
#### Path Parameters
- **mac** (string) - Required - The MAC address of the NSE device.

#### Query Parameters
- **start_time** (string) - Optional - The start of the timeframe (e.g., ISO 8601 format).
- **end_time** (string) - Optional - The end of the timeframe (e.g., ISO 8601 format).

### Response
#### Success Response (200)
- **threats** (array) - A list of threat objects.
  - **type** (string) - The type of threat.
  - **timestamp** (string) - The time the threat was detected.

#### Response Example
{
  "threats": [
    {
      "type": "malware",
      "timestamp": "2023-10-27T10:00:00Z"
    }
  ]
}

## GET /devices/{mac}/vpn_sessions

### Description
Returns the VPN sessions of an NSE device along with other session-related details.

### Method
GET

### Endpoint
/devices/{mac}/vpn_sessions

### Parameters
#### Path Parameters
- **mac** (string) - Required - The MAC address of the NSE device.

### Response
#### Success Response (200)
- **sessions** (array) - A list of VPN session objects.
  - **user** (string) - The username of the VPN session.
  - **ip_address** (string) - The IP address of the VPN client.
  - **start_time** (string) - The start time of the session.

#### Response Example
{
  "sessions": [
    {
      "user": "admin",
      "ip_address": "10.0.0.5",
      "start_time": "2023-10-27T09:00:00Z"
    }
  ]
}

## GET /devices/{mac}/vulnerable_clients

### Description
Returns all vulnerable clients of an NSE device along with individual client details.

### Method
GET

### Endpoint
/devices/{mac}/vulnerable_clients

### Parameters
#### Path Parameters
- **mac** (string) - Required - The MAC address of the NSE device.

### Response
#### Success Response (200)
- **vulnerable_clients** (array) - A list of vulnerable client objects.
  - **client_mac** (string) - The MAC address of the vulnerable client.
  - **vulnerabilities** (array) - A list of vulnerabilities found.

#### Response Example
{
  "vulnerable_clients": [
    {
      "client_mac": "AA:BB:CC:DD:EE:FF",
      "vulnerabilities": ["CVE-2023-1234", "CVE-2023-5678"]
    }
  ]
}

## GET /devices/{mac}/clients/vulnerabilities

### Description
Returns vulnerabilities of all clients associated with an NSE device.

### Method
GET

### Endpoint
/devices/{mac}/clients/vulnerabilities

### Parameters
#### Path Parameters
- **mac** (string) - Required - The MAC address of the NSE device.

### Response
#### Success Response (200)
- **client_vulnerabilities** (object) - An object mapping client MAC addresses to their vulnerabilities.

#### Response Example
{
  "client_vulnerabilities": {
    "AA:BB:CC:DD:EE:FF": ["CVE-2023-1234"],
    "11:22:33:44:55:66": ["CVE-2023-5678"]
  }
}

## GET /devices/clients/{client_mac}/vulnerabilities

### Description
Returns vulnerabilities of a single NSE client.

### Method
GET

### Endpoint
/devices/clients/{client_mac}/vulnerabilities

### Parameters
#### Path Parameters
- **client_mac** (string) - Required - The MAC address of the client.

### Response
#### Success Response (200)
- **vulnerabilities** (array) - A list of vulnerabilities found for the client.

#### Response Example
{
  "vulnerabilities": ["CVE-2023-1234"]
}
```

--------------------------------

### Retrieve Access Token

Source: https://docs.cloud.cambiumnetworks.com/api/5.0.0/summary.html

This endpoint is used to obtain an access token required for authenticating API requests. It supports two methods for providing credentials: via the Authorization header or within the request body.

```APIDOC
## Retrieve Access Token

### Description
Obtain an access token for API authentication.

### Method
POST

### Endpoint
/api/v2/access/token

### Parameters
#### Request Body
- **grant_type** (string) - Required - Must be set to "client_credentials".
- **client_id** (string) - Optional - Your client ID. Can be omitted if using Authorization header.
- **client_secret** (string) - Optional - Your client secret. Can be omitted if using Authorization header.

### Request Example (Using Authorization Header)
```http
POST /api/v2/access/token HTTP/1.1
Host: server.example.com
Authorization: Basic BASE64(<client_id>:<client_secret>)
Content-Type: application/x-www-form-urlencoded

grant_type=client_credentials
```

### Request Example (Using Request Body)
```http
POST /api/v2/access/token HTTP/1.1
Host: server.example.com
Content-Type: application/x-www-form-urlencoded

grant_type=client_credentials&client_id=s6BhdRkqt3&client_secret=7Fjfp0ZBr1KtDRbnfVdmIw
```

### Response
#### Success Response (200)
- **access_token** (string) - The obtained access token.
- **token_type** (string) - The type of token, usually "bearer".
- **expires_in** (integer) - The token's validity in seconds.
- **redirect_uri** (string) - The redirect URI associated with the token.

#### Response Example
```json
{
  "access_token":"2YotnFZFEjr1zCsicMWpAA",
  "token_type":"bearer",
  "expires_in":3600,
  "redirect_uri": "https://{server_url}"
}
```

#### Error Response (400)
- **error** (string) - Describes the error encountered (e.g., "invalid_request", "invalid_client").

#### Error Response Example
```json
{
  "error": "invalid_request"
}
```
```

--------------------------------

### Alarms API

Source: https://docs.cloud.cambiumnetworks.com/api/5.0.0/index.html

Endpoints for retrieving active and historical alarm data.

```APIDOC
## GET /alarms

### Description
Returns a list of active alarms.

### Method
GET

### Endpoint
/alarms

## GET /alarms/history

### Description
Returns a list of alarms.

### Method
GET

### Endpoint
/alarms/history
```

=== COMPLETE CONTENT === This response contains all available snippets from this library. No additional content exists. Do not make further requests.