# private cellular networks — NCM API

Beta. The top-level object for a private cellular network, carrying the network name, TAC, high-availability setting and provisioning state. Full lifecycle: list, create, update and delete networks. Each network links to the private cellular cores acting as its mobility gateways, so start here before drilling into cores, radio groups or SIMs.

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

### GET /api/v3/beta/private_cellular_networks

private_cellular_networks_list

Return a list of private cellular networks

> **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_networks" \
  -H "Authorization: Bearer <token>"
```

**Response 200**

```json
{
  "links": {
    "next": "https://api.cradlepointecm.com/api/v3/beta/private_cellular_networks?sort=-name&page%5Bsize%5D=1&page%5Bafter%5D=eyJHU0kyUEsiOnsiUyI6Ik5XVEFcdTAwMDAwMDE2dTAwMDAwVFNHWFRcdTAwMDAzNDM3ODkifSwiU0siOnsiUyI6Ik5JXHUwMDAwMDFIMzJCRkNaMTNZSEhWOEgwUlg5MzFWUVkifSwiUEsiOnsiUyI6Ik5JXHUwMDAwMDFIMzJCRkNaMTNZSEhWOEgwUlg5MzFWUVkifSwiR1NJMlNLIjp7IlMiOiJOQU1cdTAwMDBjb252ZXJ0LXRvLUhBIn19%3A1qDe5q%3AriMLaJxzUttWJxbovv5kvyKHzhY2ahpZnEFlJHsadWU",
    "prev": null
  },
  "data": [
    {
      "type": "private_cellular_networks",
      "id": "01H32BFCZ13YHHV8H0RX931VQY",
      "attributes": {
        "name": "sample HA",
        "core_ip": null,
        "ha_enabled": true,
        "mobility_gateway_virtual_ip": "77.77.77.77",
        "state": "PROVISIONED",
        "status": "OK",
        "tac": "0086",
        "created_at": "2023-06-16T14:59:13.505102Z",
        "updated_at": "2023-06-23T06:30:01.739158Z"
      },
      "relationships": {
        "mobility_gateways": {
          "data": [
            {
              "type": "private_cellular_cores",
              "id": "01H1YSEVB73FA8XMA55FSBA0XP"
            },
            {
              "type": "private_cellular_cores",
              "id": "01H1YT2158H6CS2GG348A2VK68"
            }
          ]
        }
      },
      "links": {
        "self": "https://api.cradlepointecm.com/api/v3/beta/private_cellular_networks/01H32BFCZ13YHHV8H0RX931VQY"
      }
    },
    {
      "type": "private_cellular_networks",
      "id": "01H32BFCZ13YHHV8H0RX931VMR",
      "attributes": {
        "name": "same non-HA",
        "core_ip": "7.7.7.7",
        "ha_enabled": false,
        "mobility_gateway_virtual_ip": null,
        "state": "PROVISIONED",
        "status": "OK",
        "tac": "0086",
        "created_at": "2023-06-16T14:59:13.505102Z",
        "updated_at": "2023-06-23T06:30:01.739158Z"
      },
      "relationships": {
        "mobility_gateways": {
          "data": [
            {
              "type": "private_cellular_cores",
              "id": "01H1YSEVB73FA8XMA55FSBA0ZR"
            }
          ]
        }
      },
      "links": {
        "self": "https://api.cradlepointecm.com/api/v3/beta/private_cellular_networks/01H32BFCZ13YHHV8H0RX931VMR"
      }
    }
  ],
  "meta": {
    "page": {
      "before": null,
      "after": "eyJHU0kyUEsiOnsiUyI6Ik5XVEFcdTAwMDAwMDE2dTAwMDAwVFNHWFRcdTAwMDAzNDM3ODkifSwiU0siOnsiUyI6Ik5JXHUwMDAwMDFIMzJCRkNaMTNZSEhWOEgwUlg5MzFWUVkifSwiUEsiOnsiUyI6Ik5JXHUwMDAwMDFIMzJCRkNaMTNZSEhWOEgwUlg5MzFWUVkifSwiR1NJMlNLIjp7IlMiOiJOQU1cdTAwMDBjb252ZXJ0LXRvLUhBIn19:1qDe5q:riMLaJxzUttWJxbovv5kvyKHzhY2ahpZnEFlJHsadWU",
      "size": 2
    }
  }
}
```

### POST /api/v3/beta/private_cellular_networks

private_cellular_networks_create

Create a single private cellular network.

> **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_networks" \
  -H "Authorization: Bearer <token>"
```

**Response 201**

```json
{
  "data": {
    "type": "private_cellular_networks",
    "id": "01GYCRXFANP1SQFYY7C5F40CDW",
    "attributes": {
      "name": "PCN Network HA",
      "core_ip": "8.8.8.8",
      "ha_enabled": true,
      "mobility_gateway_virtual_ip": "2.2.2.2",
      "state": "PROVISIONING",
      "status": "NONE",
      "tac": "0086",
      "created_at": "2023-04-19T12:48:01.365655Z",
      "updated_at": "2023-04-19T12:48:01.365655Z"
    },
    "relationships": {
      "mobility_gateways": {
        "data": [
          {
            "type": "private_cellular_cores",
            "id": "01GYCRHPXTVD7N5DZJYBGE4A90"
          },
          {
            "type": "private_cellular_cores",
            "id": "01GXWWC55XVHTSRKR47203GEFN"
          }
        ]
      }
    },
    "links": {
      "self": "https://api.cradlepointecm.com/api/v3/beta/private_cellular_networks/01GYCRXFANP1SQFYY7C5F40CDW"
    }
  }
}
```

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

private_cellular_networks_retrieve

Get a single private cellular network.

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

**Response 200**

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

private_cellular_networks_update

Update a single private cellular network

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

**Response 202**

```json
{
  "data": {
    "type": "private_cellular_networks",
    "id": "01GYCRXFANP1SQFYY7C5F40CDW",
    "attributes": {
      "name": "PCN Network HA",
      "core_ip": "8.8.8.8",
      "ha_enabled": true,
      "mobility_gateway_virtual_ip": "2.2.2.2",
      "state": "PROVISIONING",
      "status": "NONE",
      "tac": "0086",
      "created_at": "2023-04-19T12:48:01.365655Z",
      "updated_at": "2023-04-19T12:48:01.365655Z"
    },
    "relationships": {
      "mobility_gateways": {
        "data": [
          {
            "type": "private_cellular_cores",
            "id": "01GYCRHPXTVD7N5DZJYBGE4A90"
          },
          {
            "type": "private_cellular_cores",
            "id": "01GXWWC55XVHTSRKR47203GEFN"
          }
        ]
      }
    },
    "links": {
      "self": "https://api.cradlepointecm.com/api/v3/beta/private_cellular_networks/01GYCRXFANP1SQFYY7C5F40CDW"
    }
  }
}
```

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

private_cellular_networks_destroy

Delete a single private cellular network.

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

**Response 204** — No response body