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/Fleets

A 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:

curl -L "https://supersim.api.korewireless.com/v1/Sims" -H "Authorization: Bearer <YOUR_ACCESS_TOKEN>" 

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

post

Create a Fleet

Authorizations

OAuth

OAuth2clientCredentialsRequired

Token URL:

Body

application/x-www-form-urlencoded

NetworkAccessProfilestringRequired

The SID or unique name of the Network Access Profile that will control which cellular networks the Fleet's SIMs can connect to.

UniqueNamestringOptional

An application-defined string that uniquely identifies the resource. It can be used in place of the resource's sid in the URL to address the resource.

DataEnabledbooleanOptional

Defines whether SIMs in the Fleet are capable of using 2G/3G/4G/LTE/CAT-M data connectivity. Defaults to true.

DataLimitintegerOptional

The total data usage (download and upload combined) in Megabytes that each Super SIM assigned to the Fleet can consume during a billing period (normally one month). Value must be between 1MB (1) and 2TB (2,000,000). Defaults to 1GB (1,000).

IpCommandsUrlstring · uriOptional

The URL that will receive a webhook when a Super SIM in the Fleet is used to send an IP Command from your device to a special IP address. Your server should respond with an HTTP status code in the 200 range; any response body will be ignored.

IpCommandsMethodstring · enumOptional

A string representing the HTTP method to use when making a request to ip_commands_url. Can be one of POST or GET. Defaults to POST.

Possible values:

SmsCommandsEnabledbooleanOptional

Defines whether SIMs in the Fleet are capable of sending and receiving machine-to-machine SMS via Commands. Defaults to true.

SmsCommandsUrlstring · uriOptional

The URL that will receive a webhook when a Super SIM in the Fleet is used to send an SMS from your device to the SMS Commands number. Your server should respond with an HTTP status code in the 200 range; any response body will be ignored.

SmsCommandsMethodstring · enumOptional

A string representing the HTTP method to use when making a request to sms_commands_url. Can be one of POST or GET. Defaults to POST.

Possible values:

Responses

201

Created

application/json

post

/v1/Fleets

cURLNodeJsPython

curl -X POST "https://supersim.api.korewireless.com/v1/Fleets" -H "Content-Type: application/x-www-form-urlencoded" -H "Authorization: Bearer <YOUR_AUTH_TOKEN>" --data-urlencode "UniqueName=<NEW_FLEET_NAME>" --data-urlencode "DataEnabled=true" --data-urlencode "DataLimit=500" --data-urlencode "SmsCommandsEnabled=true" --data-urlencode "SmsCommandsMethod=<GET_OR_POST>" --data-urlencode "SmsCommandsUrl=<YOUR_CALLBACK_URL>" --data-urlencode "IpCommandsMethod=<GET_OR_POST>" --data-urlencode "IpCommandsUrl=<YOUR_CALLBACK_URL>" --data-urlencode "NetworkAccessProfile=<NETWORK_ACCESS_PROFILE_SID_OR_UNIQUENAME>"

201

Created

{
  "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "unique_name": "unique_name",
  "data_enabled": true,
  "data_limit": 500,
  "data_metering": "payg",
  "date_created": "2019-07-30T20:00:00Z",
  "date_updated": "2019-07-30T20:00:00Z",
  "sms_commands_enabled": true,
  "sms_commands_method": "GET",
  "sms_commands_url": "https://google.com",
  "ip_commands_method": "GET",
  "ip_commands_url": "https://google.com",
  "network_access_profile_sid": "HAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "sid": "HFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "url": "https://supersim.api.korewireless.com/v1/Fleets/HFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
}

---

Fetch a Fleet resource

get

Fetch a Fleet instance from your account.

Authorizations

OAuth

OAuth2clientCredentialsRequired

Token URL:

Path parameters

SidstringRequired

The SID of the Fleet resource to fetch.

Responses

200

OK

application/json

get

/v1/Fleets/{Sid}

cURLNodeJsPython

curl -L "https://supersim.api.korewireless.com/v1/Fleets/<Sid>" --header "Authorization: Bearer <YOUR_AUTH_TOKEN>"

200

OK

{
  "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "unique_name": "unique_name",
  "data_enabled": true,
  "data_limit": 1000,
  "data_metering": "payg",
  "date_created": "2019-07-30T20:00:00Z",
  "date_updated": "2019-07-30T20:00:00Z",
  "sms_commands_enabled": true,
  "sms_commands_method": "POST",
  "sms_commands_url": null,
  "ip_commands_method": "POST",
  "ip_commands_url": null,
  "network_access_profile_sid": "HAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "sid": "HFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "url": "https://supersim.api.korewireless.com/v1/Fleets/HFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
}

---

Read multiple Fleet resources

get

Retrieve a list of Fleets from your account.

Authorizations

OAuth

OAuth2clientCredentialsRequired

Token URL:

Query parameters

NetworkAccessProfilestringOptional

The SID or unique name of the Network Access Profile that controls which cellular networks the Fleet's SIMs can connect to.

Example: {"value":"HAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"}

PageSizeinteger · min: 1 · max: 1000Optional

How many resources to return in each list page. The default is 50, and the maximum is 1000.

PageintegerOptional

The page index. This value is simply for client state.

PageTokenstringOptional

The page token. This is provided by the API.

Responses

200

OK

application/json

get

/v1/Fleets

cURLNodeJsPython

curl -L "https://supersim.api.korewireless.com/v1/Fleets?Page=1&PageSize=1" --header "Authorization: Bearer <YOUR_AUTH_TOKEN>"

200

OK

{
  "fleets": [],
  "meta": {
    "first_page_url": "https://supersim.api.korewireless.com/v1/Fleets?NetworkAccessProfile=HAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0",
    "key": "fleets",
    "next_page_url": null,
    "page": 0,
    "page_size": 50,
    "previous_page_url": null,
    "url": "https://supersim.api.korewireless.com/v1/Fleets?NetworkAccessProfile=HAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0"
  }
}

---

Update a Fleet resource

post

Updates the given properties of a Super SIM Fleet instance from your account.

Authorizations

OAuth

OAuth2clientCredentialsRequired

Token URL:

Path parameters

SidstringRequired

The SID of the Fleet resource to update.

Body

application/x-www-form-urlencoded

UniqueNamestringOptional

An application-defined string that uniquely identifies the resource. It can be used in place of the resource's sid in the URL to address the resource.

NetworkAccessProfilestringOptional

The SID or unique name of the Network Access Profile that will control which cellular networks the Fleet's SIMs can connect to.

IpCommandsUrlstring · uriOptional

The URL that will receive a webhook when a Super SIM in the Fleet is used to send an IP Command from your device to a special IP address. Your server should respond with an HTTP status code in the 200 range; any response body will be ignored.

IpCommandsMethodstring · enumOptional

A string representing the HTTP method to use when making a request to ip_commands_url. Can be one of POST or GET. Defaults to POST.

Possible values:

SmsCommandsUrlstring · uriOptional

The URL that will receive a webhook when a Super SIM in the Fleet is used to send an SMS from your device to the SMS Commands number. Your server should respond with an HTTP status code in the 200 range; any response body will be ignored.

SmsCommandsMethodstring · enumOptional

A string representing the HTTP method to use when making a request to sms_commands_url. Can be one of POST or GET. Defaults to POST.

Possible values:

DataLimitintegerOptional

The total data usage (download and upload combined) in Megabytes that each Super SIM assigned to the Fleet can consume during a billing period (normally one month). Value must be between 1MB (1) and 2TB (2,000,000). Defaults to 1GB (1,000).

Responses

200

OK

application/json

post

/v1/Fleets/{Sid}

NodeJsPythoncURL

import { URLSearchParams } from "url";

const data = new URLSearchParams({
    "UniqueName": "<NEW_UNIQUE_NAME>",
    "DataLimit": "<NEW_DATA_LIMIT>",
    "SmsCommandsMethod": "<GET_OR_POST>",
    "SmsCommandsUrl": "<NEW_CALLBACK_URL>",
    "IpCommandsMethod": "<GET_OR_POST>",
    "IpCommandsUrl": "<NEW_CALLBACK_URL>"
  });
  
const response = await fetch("https://supersim.api.korewireless.com/v1/Fleets/<Sid>", {    
    method: 'POST',
    headers: {
      "Content-Type": "application/x-www-form-urlencoded",
      "Authorization": "Bearer <YOUR_AUTH_TOKEN>"
    },
    body: data.toString()
});
const resp = await response.json();
console.log(resp);

200

OK

{
  "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "unique_name": "GPS Trackers Fleet 5GB",
  "data_enabled": true,
  "data_limit": 5000,
  "data_metering": "payg",
  "date_created": "2019-10-15T20:00:00Z",
  "date_updated": "2019-10-15T20:00:00Z",
  "sms_commands_enabled": true,
  "sms_commands_method": "POST",
  "sms_commands_url": null,
  "ip_commands_method": "POST",
  "ip_commands_url": null,
  "network_access_profile_sid": "HAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "sid": "HFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "url": "https://supersim.api.korewireless.com/v1/Fleets/HFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
}

---

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.