# private cellular radio groups — NCM API

Beta. Named collections of radios within a private cellular network, so configuration can be applied to several radios at once. Full lifecycle: list, create, update and delete groups. Each group belongs to a network; the radios themselves live under private cellular radios.

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

### GET /api/v3/beta/private_cellular_radio_groups

private_cellular_radio_groups_list

Return a list of private cellular radio groups.

> **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 |
| --- | --- | --- | --- | --- |
| filter[network_id] | query | string | no |  |
| 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_radio_groups" \
  -H "Authorization: Bearer <token>"
```

**Response 200**

```json
{
  "links": {
    "next": "https://api.cradlepointecm.com/api/v3/beta/private_cellular_radio_groups?sort=-name&page%5Bsize%5D=2&page%5Bafter%5D=eyJTSyI6eyJTIjoiTE9cdTAwMDAwMUgzSkNUSjhWS1pLODBZSjNGQ0VIUkpCSiJ9LCJHU0kzUEsiOnsiUyI6IkxPVEFcdTAwMDAwMDE2dTAwMDAwVFNHWFRcdTAwMDAzNDM3ODkifSwiUEsiOnsiUyI6IkxPXHUwMDAwMDFIM0pDVEo4VktaSzgwWUozRkNFSFJKQkoifSwiR1NJM1NLIjp7IlMiOiJOQU1cdTAwMDAxIn19%3A1qDeI6%3AF8NDh6GTOxMAQILk8jAc9yCNyjE_0MH1aih2erAkKS4",
    "prev": null
  },
  "data": [
    {
      "type": "private_cellular_radio_groups",
      "id": "01H3V0XF0G9GEYQGRQGE6DKQSP",
      "attributes": {
        "name": "Bg v3 RG",
        "description": "descriptions",
        "created_at": "2023-06-26T04:55:40.816191Z",
        "updated_at": "2023-06-26T04:55:40.816191Z"
      },
      "relationships": {
        "network": {
          "data": {
            "type": "private_cellular_networks",
            "id": "01H3TX413TZPXTVR59ZHQF1N11"
          }
        }
      },
      "links": {
        "self": "https://api.cradlepointecm.com/api/v3/beta/private_cellular_radio_groups/01H3V0XF0G9GEYQGRQGE6DKQSP"
      }
    },
    {
      "type": "private_cellular_radio_groups",
      "id": "01H3JCTJ8VKZK80YJ3FCEHRJBJ",
      "attributes": {
        "name": "1",
        "description": "1",
        "created_at": "2023-06-22T20:30:38.875701Z",
        "updated_at": "2023-06-22T20:35:21.642693Z"
      },
      "relationships": {
        "network": {
          "data": {
            "type": "private_cellular_networks",
            "id": "01H32BFCZ13YHHV8H0RX931VQY"
          }
        }
      },
      "links": {
        "self": "https://api.cradlepointecm.com/api/v3/beta/private_cellular_radio_groups/01H3JCTJ8VKZK80YJ3FCEHRJBJ"
      }
    }
  ],
  "meta": {
    "page": {
      "before": null,
      "after": "eyJTSyI6eyJTIjoiTE9cdTAwMDAwMUgzSkNUSjhWS1pLODBZSjNGQ0VIUkpCSiJ9LCJHU0kzUEsiOnsiUyI6IkxPVEFcdTAwMDAwMDE2dTAwMDAwVFNHWFRcdTAwMDAzNDM3ODkifSwiUEsiOnsiUyI6IkxPXHUwMDAwMDFIM0pDVEo4VktaSzgwWUozRkNFSFJKQkoifSwiR1NJM1NLIjp7IlMiOiJOQU1cdTAwMDAxIn19:1qDeI6:F8NDh6GTOxMAQILk8jAc9yCNyjE_0MH1aih2erAkKS4",
      "size": 2
    }
  }
}
```

### POST /api/v3/beta/private_cellular_radio_groups

private_cellular_radio_groups_create

Create a single private cellular radio group.

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

**Request body**

**Example request**

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

**Response 201**

```json
{
  "data": {
    "type": "private_cellular_radio_groups",
    "id": "01GYB3W5CVJDQWSCBH8EMJDYPC",
    "attributes": {
      "name": "Location1",
      "description": "descriptions",
      "created_at": "2023-04-18T21:21:03.899417Z",
      "updated_at": "2023-04-18T21:21:03.899417Z"
    },
    "relationships": {
      "network": {
        "data": {
          "type": "private_cellular_networks",
          "id": "01GYB3S4F02KHPSJJW21STKCVS"
        }
      }
    },
    "links": {
      "self": "https://api.cradlepointecm.com/api/v3/beta/private_cellular_radio_groups/01GYB3W5CVJDQWSCBH8EMJDYPC"
    }
  }
}
```

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

private_cellular_radio_groups_retrieve

Get a single private cellular radio group.

> **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_radio_groups/{id}" \
  -H "Authorization: Bearer <token>"
```

**Response 200**

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

private_cellular_radio_groups_update

Update a single private cellular radio group.

> **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_radio_groups/{id}" \
  -H "Authorization: Bearer <token>"
```

**Response 202**

```json
{
  "data": {
    "type": "private_cellular_radio_groups",
    "id": "01GYCZ61A7QJ2TZKEG72XX337F",
    "attributes": {
      "name": "Modified Location name",
      "description": "descriptions",
      "created_at": "2023-04-19T14:37:33.383996Z",
      "updated_at": "2023-04-19T14:41:36.821778Z"
    },
    "relationships": {
      "network": {
        "data": {
          "type": "private_cellular_networks",
          "id": "01GYCTB880PMDYEZ9B9FQAHC8N"
        }
      }
    },
    "links": {
      "self": "https://api.cradlepointecm.com/api/v3/beta/private_cellular_radio_groups/01GYCZ61A7QJ2TZKEG72XX337F"
    }
  }
}
```

### DELETE /api/v3/beta/private_cellular_radio_groups/{id}

private_cellular_radio_groups_destroy

Delete a single private cellular radio group.

> **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 -X DELETE "https://api.cradlepointecm.com/api/v3/beta/private_cellular_radio_groups/{id}" \
  -H "Authorization: Bearer <token>"
```

**Response 204** — No response body