Fleet Resource
Organize and configure groups of Sim resources
To avoid ambiguity throughout this page, Sim (initial cap) refers to the Sim API resource. SIM (all caps) refers to the physical Subscriber Identity Module (that is, a SIM card) associated with a Sim resource.
A Fleet resource organizes and configures group of Sim resources:
https://supersim.api.korewireless.com/v1/FleetsA Sim resource must be assigned to a Fleet resource by specifying fleet on the Sim resource before it can activated.
Some of a Fleet resource's properties are immutable. If you wish to change a Super SIM's behavior, you may need to create a new Fleet resource and reassign the Sim resource to the new Fleet resource.
Data Limits
Data limits allow you to control how much data each Super SIM assigned to a Fleet can consume during its billing period (typically one month). It is important to note that when a device reaches its data limit, DNS traffic to public DNS is still allowed and may incur charges.
Once a SIM has used more than its allowed data limit, it will be blocked from exchanging additional data—except DNS traffic as noted above—until the current billing period ends.
When a new billing period begins, the data usage resets to zero, and the SIM is unblocked (if it was previously blocked).
Each SIM's data usage is measured independently, and each SIM receives the full amount of the data limit before being blocked. For example, if you set the data limit on your Fleet resource to 5 MB, every SIM assigned to that Fleet gets its own 5 MB of data to use. It is not a shared data pool.
SIMs will not be blocked exactly at their data limit. It is important to note that when a device reaches its data limit, DNS traffic to public DNS is still allowed and may incur charges. Usage records are generated every 6 minutes while a data session is active or when the session terminates. The aggregated usage from these is used to evaluate if a SIM has exceeded its data limit. If your device uses a significant amount of data between usage records being generated, it is possible to exceed your data limit by large amounts. You will be charged for all data used by your devices.
If you update your Fleet's data limit, it will take a few moments, typically five minutes or less, for the Super SIMs assigned to that Fleet to respect the new data limit while the cached value expires. If you increase the data limit and have SIMs that are blocked because their data usage exceeded the previous data limit, they will automatically be unblocked when the new data limit takes effect. Similarly, SIMs whose data usage for the current billing period exceeds the new data limit will be blocked, if they were not already, when the new data limit takes effect. It should not take longer than 15minutes for the new data limit to take effect for all of the Super SIMs on your Fleet.
You can use the BillingPeriods subresource and UsageRecords resource to calculate how much of a SIM's data limit has been used. See more details here.
API Authorization
Before you can make requests to this resource, you must have a valid bearer token. Review our API authorization guide to learn how to generate a token. Here's a curl example on how to define your access token in a header:
The examples below do not show the required Authorization header due to a bug. We're working on fixing that. In the meantime, be sure to include that in all of your requests.
Create a Fleet resource
Error while loading OpenAPI operation — Failed to fetch OpenAPI file
Fetch a Fleet resource
Error while loading OpenAPI operation — Failed to fetch OpenAPI file
Read multiple Fleet resources
Error while loading OpenAPI operation — Failed to fetch OpenAPI file
Update a Fleet resource
Error while loading OpenAPI operation — Failed to fetch OpenAPI file
Delete a Fleet
Customers can now delete unused and unwanted Fleets and their associated data. This can be done in Console: visit Super SIM > Fleets, click on the name of the Fleet you wish to delete, and click the Delete Fleet link at the bottom of the page. You will be asked to confirm your action before the Fleet is deleted. Fleets to which SIMs are currently assigned cannot be deleted.
Last updated
Was this helpful?