Data usage limits are a great way to prevent a device from unknowingly using large amounts of data. In this guide, we go over setting data limits in bulk using the REST API.
Note:If you aren't familiar with APIs, we highly recommend checking out our Introduction to Hologram's REST API guide as well as using Postman to make the API calls mentioned in this guide.
All API requests require your API Key to be included in the header, which is detailed in the introduction guide. For brevity's sake, this guide does not include the header information.
Set data usage limits using the API example
1) Get a list of LinkIDs for the SIMs you want to add a data limit to. The easiest way to do this is downloading a CSV
of the devices in your organization, which is described here.
2) Make the following API request:
POST https://dashboard.hologram.io/api/1/links/cellular/overagelimit
Body
{
"linkids":[LINKID_1,LINKID_2,...LINKID_N],
"limit: DESIRED_DATA_LIMIT_IN_BYTES
}
Note: If you do not want the device(s) to have a data usage limit, set the limit
to -1
.
Data usage limits come into effect after the data session in which the limit is reached. Therefore, there is a chance that your device consumes more data than allowed via the Data usage limit feature.