# private cellular radios — NCM API

Beta. The physical radios broadcasting your private cellular networks, including serial number, FCC ID, and the install geometry: location, height, antenna azimuth, downtilt and gain. Read and update: list radios, inspect one by ID, or amend its record. For live signal and health, see private cellular radio statuses.

Base URL: https://api.cradlepointecm.com

## Authentication

This is a v3 endpoint (`/api/v3/` path). Send a Bearer token on every request:

```http
Authorization: Bearer <token>
```

Tokens are generated in the NCM UI under API Keys. The v2 and v3 auth schemes are NOT interchangeable: v2 API-key headers are rejected on v3 endpoints.

### GET /api/v3/beta/private_cellular_radios

Get private cellular radios

Return a list of private cellular radios.

> **Beta:** This endpoint is served on a `/beta/` path. Beta endpoints are still evolving and may change without the stability guarantees of GA endpoints.

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| page[after] | query | string | no |  |
| page[before] | query | string | no |  |
| page[size] | query | integer | no |  |
| sort | query | array of string (-name | name) | no | Which field to use when ordering the results. |

**Example request**

```bash
curl "https://api.cradlepointecm.com/api/v3/beta/private_cellular_radios" \
  -H "Authorization: Bearer <token>"
```

**Response 200**

```json
{
  "data": {
    "type": "private_cellular_radio_statuses",
    "id": "01GZDYERMREKE42562B8NAY5MV",
    "attributes": {
      "admin_state": "disabled",
      "ipv4_address": null,
      "last_update_time": "2023-05-02T09:59:49",
      "online_status": "disabled",
      "s1_status": "disconnected",
      "time_synchronization": "out_of_sync",
      "ethernet_status": "down",
      "operational_status": "down",
      "ipsec_status": "disconnected",
      "connected_ues": 0,
      "boot_time": 0,
      "cbrs_sas_status": null,
      "operating_tx_power": 0
    },
    "relationships": {
      "cell": {
        "data": {
          "type": "private_cellular_radios",
          "id": "01GZDYERMREKE42562B8NAY5MV"
        }
      }
    }
  }
}
```

### GET /api/v3/beta/private_cellular_radios/{id}

Get private cellular radios by ID

Get a single private cellular radio.

> **Beta:** This endpoint is served on a `/beta/` path. Beta endpoints are still evolving and may change without the stability guarantees of GA endpoints.

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| id | path | string | yes |  |

**Example request**

```bash
curl "https://api.cradlepointecm.com/api/v3/beta/private_cellular_radios/{id}" \
  -H "Authorization: Bearer <token>"
```

**Response 200**

### PUT /api/v3/beta/private_cellular_radios/{id}

Update private cellular radios by ID

Update a single private cellular radio.

> **Beta:** This endpoint is served on a `/beta/` path. Beta endpoints are still evolving and may change without the stability guarantees of GA endpoints.

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| id | path | string | yes |  |

**Request body**

**Example request**

```bash
curl -X PUT "https://api.cradlepointecm.com/api/v3/beta/private_cellular_radios/{id}" \
  -H "Authorization: Bearer <token>"
```

**Response 200**