One API. One token. Every endpoint.

Bearer token auth, OpenAPI specs, cursor pagination, and JSON:API responses. The modern way to build on NetCloud Manager.

Browse Endpoints

New to v3? Start with the two-minute quickstart.

Why v3

API v2

  • ✕ Four separate API key headers
  • ✕ Offset-based pagination
  • ✕ Custom response format
  • ✕ No OpenAPI spec
  • ✕ Single-page docs, no deep links

API v3 (GA)

  • ✓ Single Bearer token
  • ✓ Cursor-based pagination
  • ✓ JSON:API response format
  • ✓ OpenAPI 3.0 specs
  • ✓ Per-endpoint docs with Try It

First API call in 2 minutes

1. Get your Bearer token

In NCM, go to Tools → NetCloud API and generate a v3 token.

2. Set it as a variable

Set your token as an environment variable so every request can reuse it.

3. Make a request

Call any endpoint with the Bearer header — that's the whole flow.

JSON:API everywhere

Every v3 endpoint returns consistent, predictable responses.

Pagination

Cursor-based with page[after], page[before], and page[size]. No more offset math.

Filtering

Consistent filter[field] query parameters across all endpoints.

Authentication

One header. Every request. That's it.

Content Type

All requests and responses use the JSON:API media type.

Moving from v2 to v3

What changes, what stays the same.

API v2API v3
Base URLwww.cradlepointecm.com/api/v2/api.cradlepointecm.com/api/v3/
Auth4 headers: X-CP-API-ID, X-CP-API-KEY, X-ECM-API-ID, X-ECM-API-KEYAuthorization: Bearer <token>
Pagination?limit=20&offset=40?page[size]=20&page[after]=cursor
Filtering?state=online&group__in=1,2,3?filter[state]=online
Response formatCustom JSON with meta.next URLsJSON:API with data, links, meta
Spec formatSwagger 1.2 / noneOpenAPI 3.0
IDsSequential integersULIDs (string)

v3 migration progress

Available in v3

Endpoints available in v3 today:

  • subscriptions
  • users
  • private_cellular_networks
  • private_cellular_cores
  • private_cellular_sims
  • private_cellular_radios
  • private_cellular_radio_groups
  • private_cellular_radio_statuses
  • exchange_resources
  • exchange_sites

Coming to v3

High-traffic v2 endpoints being migrated next, based on usage data:

  • net_devices — 1.2M/day
  • net_device_metrics — 660K/day
  • locations — 407K/day
  • net_device_usage_samples — 356K/day
  • net_device_health — 166K/day
  • router_alerts — 118K/day
  • firmwares — 115K/day
  • configuration_managers — 112K/day
  • alerts — 75K/day
  • groups — 40K/day

The full v3 reference covers every available endpoint with schemas and a live request client.