# private cellular sims — NCM API

Beta. The SIMs enrolled in a private cellular network, each with its IMSI, ICCID, name, current state, and the time it last contacted the network. Read and update, since SIMs are enrolled elsewhere rather than created here. Useful for finding SIMs that have stopped checking in.

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

### GET /api/v3/beta/private_cellular_sims

private_cellular_sims_list

Return a list of private cellular sims.

> **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 |  |
| filter[network_id][isnull] | query | boolean | no |  |
| page[after] | query | string | no |  |
| page[before] | query | string | no |  |
| page[size] | query | integer | no |  |
| sort | query | array of string (iccid | name | -name | -iccid | -imsi | imsi) | no | Which field to use when ordering the results. |

**Example request**

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

**Response 200**

```json
{
  "data": [
    {
      "type": "private_cellular_sims",
      "id": "6646653849274042923569",
      "attributes": {
        "imsi": "664665384927404",
        "iccid": "6646653849274042923569",
        "name": "E300 Slot 2 Sim",
        "state": "DISABLED",
        "state_updated_at": "2023-04-18T21:12:18.425304Z",
        "last_contact_at": "2023-04-18T21:12:18.425307Z",
        "created_at": "2023-04-18T21:12:18.444429Z"
      },
      "relationships": {
        "network": {
          "data": null
        }
      },
      "links": {
        "self": "https://api.cradlepointecm.com/api/external/v3/beta/private_cellular_sims/6646653849274042923569"
      }
    },
    {
      "type": "private_cellular_sims",
      "id": "6646653849274042923567",
      "attributes": {
        "imsi": "664665384927404",
        "iccid": "6646653849274042923567",
        "name": "E300 Slot 2 Sim",
        "state": "ENABLED",
        "state_updated_at": "2023-04-18T21:11:19.006865Z",
        "last_contact_at": "2023-04-18T21:11:19.006868Z",
        "created_at": "2023-04-18T21:11:19.435471Z"
      },
      "relationships": {
        "network": {
          "data": null
        }
      },
      "links": {
        "self": "https://api.cradlepointecm.com/api/external/v3/beta/private_cellular_sims/6646653849274042923567"
      }
    },
    {
      "type": "private_cellular_sims",
      "id": "6646653849274042923560",
      "attributes": {
        "imsi": "664665384927404",
        "iccid": "6646653849274042923560",
        "name": "E300 Slot 1 Sim",
        "state": "ENABLED",
        "state_updated_at": "2023-04-18T21:12:29.237445Z",
        "last_contact_at": "2023-04-18T21:12:29.237448Z",
        "created_at": "2023-04-18T21:12:29.257004Z"
      },
      "relationships": {
        "network": {
          "data": {
            "type": "private_cellular_networks",
            "id": "01GYB3S4F02KHPSJJW21STKCVS"
          }
        }
      },
      "links": {
        "self": "https://api.cradlepointecm.com/api/v3/beta/private_cellular_sims/6646653849274042923560"
      }
    }
  ],
  "meta": {
    "pagination": {
      "before": null,
      "after": "eyJHU0kyUEsiOnsiUyI6IlRBXHUwMDAwVDQzdkd2WDVQVEN2aFZ5XHUwMDAwNCJ9LCJTSyI6eyJTIjoiU0lNXHUwMDAwNjY0NjY1Mzg0OTI3NDA0MjkyMzU2MCJ9LCJQSyI6eyJTIjoiU0lNXHUwMDAwNjY0NjY1Mzg0OTI3NDA0MjkyMzU2MCJ9LCJHU0kyU0siOnsiUyI6IklNXHUwMDAwNjY0NjY1Mzg0OTI3NDA0In19:1pp94n:FQJ99Npl933guT79Klm6t-MpFdGsXnjcQsAbTX_7CqU"
    }
  }
}
```

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

private_cellular_sims_retrieve

Get a single private cellular sim.

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

**Response 200**

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

private_cellular_sims_update

Update a single private cellular sim.

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

**Response 202**

```json
{
  "data": {
    "type": "private_cellular_sims",
    "id": "6646653849274042923569",
    "attributes": {
      "imsi": "664665384927404",
      "iccid": "6646653849274042923569",
      "name": "E300 Slot Test Sim",
      "state": "ENABLED",
      "state_updated_at": "2023-04-18T21:12:18.425304Z",
      "last_contact_at": "2023-04-18T21:12:18.425307Z",
      "created_at": "2023-04-18T21:12:18.444429Z"
    },
    "relationships": {
      "network": {
        "data": {
          "type": "private_cellular_networks",
          "id": "01GYCTB880PMDYEZ9B9FQAHC8N"
        }
      }
    },
    "links": {
      "self": "https://api.cradlepointecm.com/api/external/v3/beta/private_cellular_sims/6646653849274042923569"
    }
  }
}
```