SIMs

Retrieve information for all SIMs

get

Returns detailed information for all registered SIMs.

Minimum package requirement for SIM location, modem model, and modem manufacturer information: Fleet

Minimum package requirement for SIM alert threshold information: Pro

Using parameters will focus the records returned in the response.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

next_pagestringOptional

Used for pagination of records.

Example: MDAyNDY0OTk5

limitstringOptional

The max number of records returned. Limit can be between 1 and 1000 records. Default is 1000 records.

Example: 10

filterone ofOptional

Filter SIMs based on various criteria. Can be provided as a single filter or multiple filters.

Single filter format: filter=key:value

Multiple filters format: filter[]=key:value&filter[]=key2:value2

Supported filter types:

online - Boolean filter for SIM online status

Format: online:true or online:false

activated - Boolean filter for SIM activation status

Format: activated:true or activated:false

connector - Filter by Connector name

Format: connector:<connector-name>

network_whitelist - Filter by Network List name

Format: network_whitelist:<whitelist-name>

Example: filter[]=online:true&filter[]=connector:foobar

stringOptional

string[]Optional

Responses

200

application/json

Responseobject

get

/sims

GET /sims HTTP/1.1
Host: api.onomondo.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

{
  "count": 1,
  "limit": 20,
  "offset": 0,
  "total": 1,
  "sims": [
    {
      "id": "000002418",
      "iccid": "89457387300000024185",
      "label": null,
      "network_whitelist": "Americas",
      "imei_lock": null,
      "connector": null,
      "activated": false,
      "ipv4": "100.66.131.197",
      "online": false,
      "online_at": null,
      "last_came_online_at": "2021-11-01T12:13:39.627Z",
      "network": {
        "name": null,
        "country": null,
        "country_code": null,
        "mcc": null,
        "mnc": null
      },
      "technologies": {
        "sms": true,
        "2g_3g": true,
        "4g": true
      },
      "usage": 0,
      "tags": [
        {
          "name": "Supplier",
          "id": "a5023f47-1db8-425e-b664-dc0b8921f644",
          "can_write": false,
          "color": "#5ba571"
        },
        {
          "name": "Steens Products",
          "id": "4c21c1ce-0e3d-445f-8b3a-9d918a9acd89",
          "can_write": false,
          "color": "#441212"
        }
      ]
    }
  ]
}

Retrieve information for a specific SIM

get

Returns detailed information for a specific SIM.

Minimum package requirement for SIM location, modem model, and modem manufacturer information: Fleet

Minimum package requirement for SIM alert threshold information: Pro

By default, we suggest to use the SIM ID that can be found on the SIM card itself or from SIMs page in the web app. You can also use the ICCID value, if that is available.

Note that the location and device_info fields are optional, meaning that they are only present if the information is available.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

sim_idstringRequiredExample: 000000001

Responses

200

application/json

Responseobject

get

/sims/{sim_id}

GET /sims/{sim_id} HTTP/1.1
Host: api.onomondo.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

{
  "id": "{{sim_id}}",
  "msisdn": "882360011968393",
  "iccid": "89457387300002791013",
  "label": "Bene-getting-started-device",
  "network_whitelist": "bene-excellent-testing-whitelist",
  "imei_lock": null,
  "imei": "861340049971524",
  "imsi": "234500027179101",
  "connector": "getting-started",
  "activated": true,
  "ipv4": "100.68.153.152",
  "online_at": "2021-11-01T12:13:39.627Z",
  "last_came_online_at": "2021-11-01T12:13:39.627Z",
  "network": {
    "name": "Telia",
    "country": "Denmark",
    "country_code": "DK",
    "mcc": "238",
    "mnc": "20"
  },
  "usage": 97606,
  "tags": [
    {
      "name": "ConnectivityCheck Success",
      "id": "8ebab849-af20-43ae-b59a-13e70e2a9932",
      "can_write": false,
      "color": null
    }
  ],
  "online": true,
  "data_limit": {
    "used": 248,
    "total": 10000000,
    "type": "hourly",
    "period": "2021110112",
    "alert_threshold": null,
    "resets_at": "2021-11-01T13:00:00.000Z"
  },
  "location": {
    "lat": 55.6821716,
    "lng": 12.5824411,
    "cell_id": 41963030,
    "location_area_code": null,
    "accuracy": 568
  },
  "device_info": {
    "model": "SARA-R410M",
    "manufacturer": "u-blox"
  }
}

Find SIMs

get

Retrieves a list of SIMs filtered by partial SIM ID, label, or exact ICCID match.

Minimum package requirement for SIM location, modem model, and modem manufacturer information: Fleet

Minimum package requirement for SIM alert threshold information: Pro

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

searchstringRequired

A partial SIM id or label, as well as a complete ICCID.

Example: ?search=foobar

limitstringOptional

Without this parameter the default is 10. Limit can be between 1 and 1000 records.

Example: 10

offsetstringOptional

The number of first records returned. Used for pagination of records, otherwise will default to 0.

Example: 20

Responses

200

application/json

Responseobject

get

/sims/find

GET /sims/find?search=text HTTP/1.1
Host: api.onomondo.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

{
  "count": 3,
  "limit": 10,
  "offset": 0,
  "total": 3,
  "sims": [
    {
      "id": "000002273",
      "iccid": "89457387300000022734",
      "label": "iphone",
      "network_whitelist": "DK-UK-Only",
      "imei_lock": null,
      "connector": null,
      "activated": true,
      "online_at": "2020-09-30T05:52:21.953Z",
      "last_came_online_at": "2020-09-30T05:52:21.953Z",
      "network": {
        "name": "Telia",
        "country": "Denmark",
        "country_code": "DK",
        "mcc": "238",
        "mnc": "20"
      },
      "ipv4": "100.64.237.173",
      "usage": 568222249,
      "tags": [
        {
          "name": "Product A",
          "id": "aef0c9c8-f6d5-4e93-a330-1f59d5093d92",
          "can_write": false,
          "color": "#5b8fa5"
        }
      ],
      "location": {
        "lat": null,
        "lng": null,
        "cell_id": 39457,
        "location_area_code": 632,
        "accuracy": null
      }
    },
    {
      "id": "000002417",
      "iccid": "89457387300000024177",
      "label": "test-device",
      "network_whitelist": "nordics-only",
      "imei_lock": null,
      "connector": null,
      "activated": true,
      "online_at": null,
      "last_came_online_at": "2020-09-30T05:52:21.953Z",
      "network": {
        "name": null,
        "country": null,
        "country_code": null,
        "mcc": null,
        "mnc": null
      },
      "ipv4": "100.66.131.195",
      "usage": 0,
      "tags": [
        {
          "name": "Steens Products",
          "id": "4c21c1ce-0e3d-445f-8b3a-9d918a9acd89",
          "can_write": false,
          "color": "#441212"
        }
      ]
    },
    {
      "id": "000002418",
      "iccid": "89457387300000024185",
      "label": null,
      "network_whitelist": "Americas",
      "imei_lock": null,
      "connector": null,
      "activated": false,
      "online_at": null,
      "last_came_online_at": "2020-09-30T05:52:21.953Z",
      "network": {
        "name": null,
        "country": null,
        "country_code": null,
        "mcc": null,
        "mnc": null
      },
      "ipv4": "100.66.131.197",
      "usage": 0,
      "tags": [
        {
          "name": "Steens Products",
          "id": "4c21c1ce-0e3d-445f-8b3a-9d918a9acd89",
          "can_write": false,
          "color": "#441212"
        },
        {
          "name": "Supplier",
          "id": "a5023f47-1db8-425e-b664-dc0b8921f644",
          "can_write": false,
          "color": "#5ba571"
        }
      ]
    }
  ]
}

Update specific SIM

patch

Updates configurable parameters for the specified SIM.

Minimum package requirement for updating SIM alert: Pro

This request takes a JSON body. Only the properties that are being updated need to be included.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

sim_idstringRequiredExample: 000000001

Header parameters

Content-TypestringOptionalExample: application/json

Body

labelstring · nullableOptional

A string alias of the SIM, null if no alias to be assigned.

Example: My IoT Device

network_whiteliststring · nullableOptional

Name of the Network List attached, null if no Network List should be attached.

Example: production-whitelist

imei_lockstring · nullableOptional

String IMEI of device the SIM should be locked to (if presented in network signaling) or a null value.

Example: 123456789012345

connectorstring · nullableOptional

Name of Connector attached, set to null if no Connector should be attached.

Example: my-connector

activatedbooleanOptional

Boolean to activate and deactivate the SIM.

Example: true

tagsstring[]Optional

An array of Tag IDs to be associated with a SIM. Tag IDs require string format and can be obtained using GET /tags endpoint. Caution: Include all Tags you want to keep plus any new ones, as this replaces the entire list of Tags.

Example: ["tag-id-1","tag-id-2"]

Responses

200

application/json

Responseobject

patch

/sims/{sim_id}

PATCH /sims/{sim_id} HTTP/1.1
Host: api.onomondo.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 48

{
  "label": "Updated Device Name",
  "activated": true
}

200

{
  "id": "000279101",
  "msisdn": "882360011968393",
  "iccid": "89457387300002791013",
  "label": "test-device",
  "network_whitelist": "bene-excellent-testing-whitelist",
  "imei_lock": null,
  "imei": "861340049971524",
  "imsi": "234500027179101",
  "connector": "getting-started",
  "activated": true,
  "ipv4": "100.68.153.152",
  "online_at": null,
  "network": {
    "name": "Telia",
    "country": "Denmark",
    "country_code": "DK",
    "mcc": "238",
    "mnc": "20"
  },
  "usage": 97854,
  "tags": [
    {
      "name": "getting-started product",
      "id": "4c21c1ce-0e3d-445f-8b3a-9d918a9acd89",
      "can_write": false,
      "color": "#AB7D63"
    },
    {
      "name": "Developer",
      "id": "a5023f47-1db8-425e-b664-dc0b8921f644",
      "can_write": true,
      "color": "#5ba571"
    }
  ],
  "data_limit": {
    "used": 744,
    "total": 10000000,
    "type": "hourly",
    "period": "2021110112",
    "alert_threshold": null,
    "resets_at": "2021-11-01T13:00:00.000Z"
  },
  "location": {
    "lat": 55.6821716,
    "lng": 12.5824411,
    "cell_id": 41963030,
    "location_area_code": null,
    "accuracy": 568
  }
}

Bulk SIM Update

patch

Updates configuration parameters for multiple SIMs simultaneously.

Minimum package requirement for updating SIM alert: Pro

This request takes a JSON body. Only the properties that are being updated needs to be included. All properties that can be updated by a single SIM update can be added to the bulk call.

LIMIT: 20 SIMs per call

sims is the only one field in the body, which consists of an array of SIM update objects.

Each object needs to have the field id, which is the 9 character SIM ID.

ICCID is not accepted but can be connected to a SIM ID by taking the first 9 of the last 10 numbers of the ICCID. Here is an ICCID example with the SIM ID in bold:

8945738730-000001934-2

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Header parameters

Content-TypestringOptionalExample: application/json

Body

Responses

200

text/plain

Responsestring

patch

/sims/bulk

PATCH /sims/bulk HTTP/1.1
Host: api.onomondo.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 313

{
  "sims": [
    {
      "id": "000001934",
      "connector": "https-connector",
      "data_limit": {
        "total": 50000000,
        "type": "monthly",
        "alert_threshold": 25000000
      }
    },
    {
      "id": "000279139",
      "label": "jasons-device",
      "data_limit": {
        "total": 1000000,
        "type": "hourly",
        "alert_threshold": 750000
      }
    },
    {
      "id": "000210799",
      "network_whitelist": "{{network_whitelist}}"
    }
  ]
}

200

{"id":"000001934","success":true}
{"id":"000279139","success":true}
{"id":"000210799","success":true}

Add Tag to list of Tags of a SIM

put

Adds the Tag with the Tag ID to the given SIM. Will throw a 400 error if the Tag already is associated with the SIM.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

sim_idstringRequiredExample: 000000001

tag_idstringRequiredExample: 7b6c2c22-dab6-482d-af43-0d673c6717fd

Body

Responses

200

application/json

Responseobject

400

Bad Request

application/json

put

/sims/{sim_id}/tags/{tag_id}

PUT /sims/{sim_id}/tags/{tag_id} HTTP/1.1
Host: api.onomondo.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "message": "ok"
}

Remove Tag from list of Tags of a SIM

delete

Removes the Tag with Tag ID from the given SIM. Will throw a 400 error if the Tag is not currently associated with the SIM.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

sim_idstringRequiredExample: 000000001

tag_idstringRequiredExample: 7b6c2c22-dab6-482d-af43-0d673c6717fd

Responses

200

application/json

Responseobject

400

Bad Request

application/json

delete

/sims/{sim_id}/tags/{tag_id}

DELETE /sims/{sim_id}/tags/{tag_id} HTTP/1.1
Host: api.onomondo.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "message": "ok"
}

PreviousAPI Reference NextNetwork Lists

Last updated 5 months ago

hashtagRetrieve information for all SIMs

hashtagRetrieve information for a specific SIM

hashtagFind SIMs

hashtagUpdate specific SIM

hashtagBulk SIM Update

hashtagAdd Tag to list of Tags of a SIM

hashtagRemove Tag from list of Tags of a SIM

Retrieve information for all SIMs

Retrieve information for a specific SIM

Find SIMs

Update specific SIM

Bulk SIM Update

Add Tag to list of Tags of a SIM

Remove Tag from list of Tags of a SIM