openapi: 3.0.0 info: title: cnMaestro RESTful API description: | cnMaestro supports a RESTful API, allowing customers to read data and perform operations programmatically using their client applications. The API is supported over HTTPS, and messages are exchanged in JSON format. Modern programming languages have rich support for RESTful interfaces. cnMaestro API leverages OAuth 2.0 Client Credentials Grant. The Client Credentials grant type is used by clients to obtain an access token [Read More](/api/3.1.1/summary.html) [Announcements: New APIs / Deprecation notice](/api/3.1.1/announcements.html) version: 3.1.1 # contact: # name: Cambium Support # url: https://www.cambiumnetworks.com/support/contact-support/ # email: support@cambiumnetworks.com # Relative links are broken for externalDocs in swagger v4, uncomment these once they are fixed. For now they are part of description # externalDocs: # description: "Announcements: New APIs / Deprecation notice" # url: /help/api/announcements.html servers: - url: /api/v1 - url: /api/v2 components: securitySchemes: oAuth: type: oauth2 flows: clientCredentials: tokenUrl: /api/v2/access/token # bearerAuth: # type: http # scheme: bearer # bearerFormat: JWT examples: mac: summary: MAC address of device value: name: mac name: summary: Name of the device value: name: name security: - oAuth: [] # - bearerAuth: [] paths: # /access/token: # $ref: 'access_token#/token.generate.1' # /access/token: # $ref: 'access_token#/token.generate.2' # /access/validate_token: # $ref: 'access_token#/token.validate' /devices: $ref: 'devices/basic.yaml#/devices' /devices/{mac}: $ref: 'devices/basic.yaml#/devices.mac' /devices/{mac}/reboot: $ref: 'devices/action.yaml#/devices.mac.reboot' /devices/{mac}/ping: $ref: 'devices/action.yaml#/devices.mac.ping' /devices/{mac}/cli: $ref: 'devices/action.yaml#/devices.mac.cli' /devices/{mac}/pull_config: $ref: 'devices/action.yaml#/devices.mac.pull_config' /devices/{mac}/traceroute: $ref: 'devices/action.yaml#/devices.mac.traceroute' /devices/{mac}/wifi_perf: $ref: 'devices/action.yaml#/devices.mac.wifiperf' /devices/{mac}/disconnect_clients: $ref: 'devices/action.yaml#/devices.mac.disconnect.clients' /networks: $ref: 'topology.yaml#/networks' /networks/{network_id}: $ref: 'topology.yaml#/networks.nid' /msp/managed_accounts/{managed_account}/networks/{network_id}: $ref: 'topology.yaml#/msp.networks.nid' /networks/{network_id}/sites: $ref: 'topology.yaml#/sites' /networks/{network_id}/sites/{site_id}: $ref: 'topology.yaml#/sites.sid' /msp/managed_accounts/{managed_account}/networks/{network_id}/sites/{site_id}: $ref: 'topology.yaml#/msp.sites.sid' /networks/{network_id}/towers: $ref: 'topology.yaml#/towers' /networks/{network_id}/towers/{tower_id}: $ref: 'topology.yaml#/towers.tid' /msp/managed_accounts/{managed_account}/networks/{network_id}/towers/{tower_id}: $ref: 'topology.yaml#/msp.towers.tid' /alarms: $ref: 'devices/notification.yaml#/alarms' /alarms/history: $ref: 'devices/notification.yaml#/alarms.history' /events: $ref: 'devices/notification.yaml#/events' /msp/managed_accounts: $ref: 'msp.yaml#/managed.account' /msp/managed_accounts/{account_name}: $ref: 'msp.yaml#/managed.account.mcid' /msp/managed_services: $ref: 'msp.yaml#/managed.service' /msp/managed_services/{service_name}: $ref: 'msp.yaml#/managed.service.id' /users/sessions: $ref: 'users.yaml#/user.session' /portals: $ref: 'guest_portal.yaml#/guest.portal' /portals/{portal_id}: $ref: 'guest_portal.yaml#/guest.portal.id' /portals/{portal_id}/events: $ref: 'guest_portal.yaml#/guest.portal.id.events' /portals/{portal_id}/whitelist: $ref: 'guest_portal.yaml#/guest.portal.id.whitelist' /portals/{portal_id}/vouchers/{voucher_plan}: $ref: 'guest_portal.yaml#/guest.portal.id.vouchers.plan' /portals/{portal_id}/vouchers/{voucher_plan}/generate: $ref: 'guest_portal.yaml#/guest.portal.id.vouchers.plan.generate' /ext-portals/login: $ref: 'guest_portal.yaml#/guest.ext.portal.login' /ext-portals/logout: $ref: 'guest_portal.yaml#/guest.ext.portal.logout' /devices/clients: $ref: 'devices/wifi/clients.yaml#/devices.wifi.clients' /devices/clients/{client_mac}: $ref: 'devices/wifi/clients.yaml#/devices.wifi.clients.mac' /devices/{mac}/clients/{client_mac}: $ref: 'devices/wifi/clients.yaml#/devices.wifi.mac.clients.mac' /devices/wired_clients: $ref: 'devices/wifi/clients.yaml#/devices.wifi.wired.clients' /devices/wired_clients/{client_mac}: $ref: 'devices/wifi/clients.yaml#/devices.wifi.wired.clients.mac' /devices/{mac}/wired_clients/{client_mac}: $ref: 'devices/wifi/clients.yaml#/devices.wifi.mac.wired.clients.mac' /devices/mesh/peers: $ref: 'devices/wifi/mesh_peers.yaml#/devices.wifi.mesh.peers' /devices/mesh/peers/{peer_mac}: $ref: 'devices/wifi/mesh_peers.yaml#/devices.wifi.mesh.peers.mac' /devices/mesh/peers/end_hosts/{end_host_mac}: $ref: 'devices/wifi/mesh_peers.yaml#/devices.wifi.mesh.peers.end_hosts' /devices/{mac}/mesh/peers/{peer_mac}: $ref: 'devices/wifi/mesh_peers.yaml#/devices.wifi.mac.mesh.peers.mac' /devices/{mac}/clients/summary: $ref: 'devices/wifi/clients.yaml#/devices.wifi.mac.clients.summary' /devices/{mac}/clients/{client_mac}/summary: $ref: 'devices/wifi/clients.yaml#/devices.wifi.mac.clients.mac.summary' /devices/statistics: $ref: 'devices/stats.yaml#/devices.statistics' /devices/{mac}/statistics: $ref: 'devices/stats.yaml#/devices.mac.statistics' /devices/{mac}/performance: $ref: 'devices/stats.yaml#/devices.mac.performance' /jobs: $ref: 'jobs.yaml#/jobs' /jobs/{job_id}: $ref: 'jobs.yaml#/jobs.id' /jobs/{job_id}/details: $ref: 'jobs.yaml#/jobs.id.details' /configuration/commit: $ref: 'devices/configuration/config.yaml#/commit' /wifi_enterprise/ap_groups: $ref: 'devices/configuration/wifi_enterprise/ap_group.yaml#/ap_groups' /wifi_enterprise/ap_groups/{ap_group_name}: $ref: 'devices/configuration/wifi_enterprise/ap_group.yaml#/ap_groups.id' /msp/managed_accounts/{managed_account}/wifi_enterprise/ap_groups/{ap_group_name}: $ref: 'devices/configuration/wifi_enterprise/ap_group.yaml#/msp.ap_groups.id' /wifi_xirrus/ap_groups: $ref: 'devices/configuration/wifi_aos/ap_group.yaml#/aos.ap_groups' /wifi_xirrus/ap_groups/{ap_group_name}: $ref: 'devices/configuration/wifi_aos/ap_group.yaml#/aos.ap_groups.id' /msp/managed_accounts/{managed_account}/wifi_xirrus/ap_groups/{ap_group_name}: $ref: 'devices/configuration/wifi_aos/ap_group.yaml#/aos.msp.ap_groups.id' /wifi_enterprise/wlans: $ref: 'devices/configuration/wifi_enterprise/wlan.yaml#/wlans' /wifi_enterprise/wlans/{wlan_name}: $ref: 'devices/configuration/wifi_enterprise/wlan.yaml#/wlans.id' /msp/managed_accounts/{managed_account}/wifi_enterprise/wlans/{wlan_name}: $ref: 'devices/configuration/wifi_enterprise/wlan.yaml#/msp.wlans.id' /wifi_enterprise/wlans/{wlan_name}/epsk: $ref: 'devices/configuration/wifi_enterprise/wlan.yaml#/epsk' /wifi_enterprise/wlans/{wlan_name}/epsk/generate: $ref: 'devices/configuration/wifi_enterprise/wlan.yaml#/epsk.generate' /wifi_enterprise/wlans/{wlan_name}/epsk/delete: $ref: 'devices/configuration/wifi_enterprise/wlan.yaml#/epsk.delete' /cnwave60/networks/{network_id}/controller: $ref: 'topology.yaml#/cnwave60.networks.details' /cnwave60/networks/{network_id}/configuration: $ref: 'devices/configuration/cnwave60/config.yaml#/network.configuration' /cnwave60/networks/{network_id}/optimization/{optimization_type}: $ref: 'devices/configuration/cnwave60/config.yaml#/network.configuration.optimization' /cnwave60/networks/{network_id}/controller/configuration: $ref: 'devices/configuration/cnwave60/config.yaml#/controller.configuration' /cnwave60/networks/{network_id}/devices/overrides: $ref: 'devices/configuration/cnwave60/config.yaml#/devices.overrides' /cnwave60/devices/{mac}/configuration: $ref: 'devices/configuration/cnwave60/config.yaml#/device.configuration' /cnwave60/devices: $ref: 'devices/configuration/cnwave60/topology.yaml#/devices' /cnwave60/devices/{mac}: $ref: 'devices/configuration/cnwave60/topology.yaml#/devices.mac' /cnwave60/networks/{network_id}/sites: $ref: 'devices/configuration/cnwave60/topology.yaml#/networks.sites' /cnwave60/networks/{network_id}/sites/{site_id}: $ref: 'devices/configuration/cnwave60/topology.yaml#/networks.sites.sid' /cnwave60/networks/{network_id}/links: $ref: 'devices/configuration/cnwave60/topology.yaml#/networks.links' /cnwave60/networks/{network_id}/links/{link_name}: $ref: 'devices/configuration/cnwave60/topology.yaml#/networks.links.link_name' /cnwave60/networks/{network_id}/links/{link_name}/{link_operation}: $ref: 'devices/action.yaml#/networks.links.link_name.link_operation' /cnwave60/networks/{network_id}/links/statistics: $ref: 'devices/stats.yaml#/networks.nid.links.statistics' /cnwave60/devices/{mac}/links/statistics: $ref: 'devices/stats.yaml#/devices.mac.links.statistics' /cnwave60/devices/{mac}/links/{link_name}/statistics: $ref: 'devices/stats.yaml#/devices.mac.links.name.statistics' /cnwave60/devices/{mac}/links/{link_name}/performance: $ref: 'devices/stats.yaml#/devices.mac.links.name.performance' /cnwave60/networks/{network_id}/jobs: $ref: 'jobs.yaml#/cnwave60.network.jobs' /cnwave60/networks/{network_id}/software_images/sync: $ref: 'jobs.yaml#/cnwave60.network.software_images.sync' /cnwave60/networks/{network_id}/software_images: $ref: 'jobs.yaml#/cnwave60.network.software_images' #all the tags name should be added in index.html file for left menu tags: # - name: Access-Token # description: Access Token related API - name: Alarms description: Alarms related APIs - name: AP Groups description: 'cnPilot Enterprise AP Group related APIs' - name: Configuration description: Configuration-related APIs - name: Devices description: Devices related APIs - name: Events description: Events related APIs - name: Guest-Access description: cnPilot Enterprise Guest Access Portal related APIs - name: Jobs description: Software/Configuration Jobs related APIs - name: MSP description: Managed Service Provider related APIs - name: Networks description: Networks related APIs - name: Performance description: Device performance related APIs - name: Sessions description: User sessions related APIs - name: Sites description: Sites related APIs - name: Statistics description: Device statistics related APIs - name: Towers description: Towers related APIs - name: Wi-Fi description: Wi-Fi related APIs - name: WLANs description: cnPilot Enterprise WLAN and ePSK related APIs - name: 60 GHz cnWave description: 60 GHz cnWave related APIs