> ## Documentation Index
> Fetch the complete documentation index at: https://docs.neoagent.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Cradlepoint API

> Read Cradlepoint routers in NetCloud Manager: state, WAN links, failovers, signal, throughput and alerts; reboot, run speed tests and change settings with the approvals you set

An agent with this tool answers an NCM alert or a "the internet is down" ticket from the client's NetCloud Manager data: is the router online, which WAN link it uses, when it failed over and whether it came back, and how strong and fast its links are. It can reboot a router, run a speed test and change one setting, with the approvals you set.

> [!NOTE]
>
> Automatically enabled when you configure Cradlepoint permissions in your agent workflow. No manual toggle needed.

## What It Does

* Find the client's NCM accounts from the [Organization Mapping](https://docs.neoagent.io/integrations/cradlepoint/overview.md#your-clients-accounts-are-mapped-automatically)
* Read routers with their state and since when, and each WAN and LAN link's connection state, carrier, signal and address
* Read failovers, with when each started and ended and which link carried the site
* Read router alerts and logs, interface health, signal, usage and throughput samples
* Reboot a router, run and read a speed test, and change a router's configuration, group or name
* Manage alert rules, push destinations, apps and subaccounts
* With the API v3 token: subscriptions and licensing, Starlink dishes, LAN clients, modem upgrades and eSIM, Remote Connect, NetCloud Exchange, private cellular, users and roles, and Wi-Fi passwords

The agent calls NCM through the [Vendor API](https://docs.neoagent.io/agents/tools/vendor-api.md) tool, with `cradlepoint` as the vendor id. [Sandbox](https://docs.neoagent.io/agents/tools/built-in/sandbox.md) scripts can call it too, under the same permissions; a script never reads Wi-Fi passwords.

## Permission Groups

| Group | What it covers |
| - | - |
| **Devices** | Routers, WAN and LAN interfaces, locations, batteries, LAN devices and clients, the product and firmware catalogs |
| **Status & Performance** | State history, interface health, signal, usage and throughput, failovers, Starlink diagnostics. Read only |
| **Reboots & Speed Tests** | Reboot a router or a group, run speed tests, reboot or stow a Starlink dish |
| **Configuration & Groups** | Router configurations and the groups routers inherit settings from |
| **Alerts & Logs** | Alerts, router logs, the activity log, alert rules and push destinations |
| **Device Apps** | SDK apps, versions, bindings and their state |
| **Modem Firmware & eSIM** | Modem upgrades and eSIM profiles |
| **Remote Connect** | Remote Connect on routers and its profiles |
| **NetCloud Exchange** | Exchange sites and resources |
| **Private Cellular** | Private cellular networks, radios and SIMs |
| **Accounts** | Accounts, subaccounts, tenants and organization migrations |
| **Subscriptions & Licensing** | Subscriptions and licensing jobs |
| **Users & Access** | Users and their roles |
| **Wi-Fi Passwords** | The Wi-Fi passwords of named routers. Neo keeps them out of the run log |

## Access Profiles

> [accordion] Read Only
>
> Every group Read Only, and Wi-Fi Passwords off.

> [accordion] Helpdesk
>
> Devices, Reboots & Speed Tests and Configuration & Groups can change, each change after a technician approves it. Every other group is Read Only, and Wi-Fi Passwords off.

> [accordion] IT Admin
>
> Every group can change. Users & Access, Remote Connect, NetCloud Exchange and Subscriptions & Licensing ask a technician first.

> [accordion] Full Automation
>
> Every change runs on its own, except the ones that always ask.

These always ask a technician: unregistering a router, deleting an account, an organization migration, any change to a user or a role, and any change that sends a password, a Wi-Fi key or a secret.

## On a ticket

On a ticket, every call names one of the NCM accounts mapped to the ticket's company, and Neo checks that each router or record the call names is in that account before it sends it. Lists of every account's routers, users, locations, alert rules and every API v3 call are not sent. With no ticket company (a chat, or a scheduled agent with no ticket), the agent reads every account.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.