Welcome to the Cradlepoint NetCloud Manager API

The NetCloud Manager API is a RESTful API available to Cradlepoint customers for programmatic access to their NetCloud services. The NetCloud Manager API is used to programmatically perform many of the same functions as can be performed in the NetCloud Manager user interface. This allows for integration and automation between NetCloud Manager and customer software systems.

Important: You are currently viewing the API portal as a non-logged in user. If you are a customer, log into the portal using the steps below in ACCESSING THE API PORTAL AS A LOGGED-IN USER.

NetCloud Manager API Use Cases

Managing Users

View, add, delete, and change permissions for your account's users

Reacting to Events on your Routers

Use Webhooks to send alert notifications to your code.

Tracking Mobile Routers

Quickly identify where mobile routers are located, and where they have been.

Checking for Failovers

Review your routers that are in a failover state.

Updates, New Endpoints and Features

Date Description
07/12/2023 Beta release of API v3 endpoints for Private Cellular Networks, Commerce (subscriptions, asset_endpoints), and User Management (users v3).
01/17/2024

When working with the users v3 endpoint (beta), note that the attributes object for collaborator users contains a reduced set of data.

Collaborator users attributes: email, first_name, last_name, and timeout fields.

Users attributes: email, first_name, last_name, is_active, last_login, and pending_email fields.

API Deprecation Notes

Continued evolution of the NetCloud Manager API requires the deprecation of both endpoints and of data fields used in endpoints that no longer return accurate information.

This page lists the NetCloud Manager API endpoints and endpoint fields that have been deprecated.

References to the following endpoints and fields must be removed from your code by their deprecation date. Continuing to reference these endpoints and fields after their deprecation date will result in your code failing.

 

Deprecated Endpoints, Fields and other Functionality

 

Description: NetCloud Manager Web and API traffic is updating to a new Certificate Authority (CA) on August 15, 2024, and the following must be addressed by August 1st, 2024:
Deprecation Date: 08/01/2024
How does this affect me?

  • If you are not using one of the Supported Browsers, you may not be able to login and use NetCloud Manager.
  • API clients must trust the CA Google Trust Services. Most modern API clients will work without issue, but some older clients may need to be updated to continue working.

Additional Detail:

  • NetCloud Manager leverages Cloudflare for protecting the site from potentially malicious traffic. This provider is deprecating support from the current CA in use, DigiCert, so NetCloud Manager is updating to a supported CA, Google Trust Services.
  • To test whether your API client works with this CA ahead of the official migration, you can leverage
    https://validate-gts.cradlepointecm.com
  • API clients that do not trust the new CA would report an "SSL verification error" (or similar).


Endpoint: routers
Deprecation Date: 09/30/2024
Fields: overlay_network_binding
Reason: Deprecated
Actions to take:

If you reference the overlay_network_binding data field in scripts when using the routers endpoint, you must remove those references by September 30, 2024, or your script may encounter unexpected errors.

The endpoint base path for the routers endpoint remains:

https://www.cradlepointecm.com/api/v2/routers/
given NetCloud API v2.


Endpoint: overlay_network_bindings
Deprecation Date: 09/30/2024
Fields: All
Reason: Deprecated
Actions to take: If you reference the overlay_network_bindings endpoint in your scripts, you must remove those references by September 30, 2024, or your script may encounter unexpected errors.

Endpoint: forwarding_lan_details
Deprecation Date: 09/30/2024
Fields: All
Reason: Deprecated
Actions to take: If you reference the forwarding_lan_details endpoint in your scripts, you must remove those references by September 30, 2024, or your script may encounter unexpected errors.

Endpoint: net_devices
Deprecation Date: 12/31/2023
Fields: is_upgrade_available
Reason: This field no longer returns accurate information.
Actions to take: Remove any references you have to this field in your code. Note that this field still displays in responses but does not contains accurate information.

 

Accessing the API portal as a logged-in user

 

Cradlepoint customers can access the API portal as a logged-in users to view important account information like API keys (API v2) and API usage statistics. Use the following steps to log in to the API portal

  1. Log in to NetCloud Manager
  2. Navigate to the TOOLS page.
  3. Click NetCloud API and then click the API Portal link to access the API Portal.

For other ways to extend and integrate with NetCloud, see the NetCloud Extensibility Solutions page.

NetCloud Manager API Documentation