Menu

Expand
Rate this page:

Fleet Resource

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.twilio.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.

Delete a Fleet

New Feature Customers can now delete unused and unwanted Fleets and their associated data. This can be done in Console: visit Internet of Things > 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.

Fleet properties

Resource Properties in REST API format
account_sid
sid<AC> Not PII

The SID of the Account that created the Fleet resource.

sid
sid<HF> Not PII

The unique string that we created to identify the Fleet resource.

unique_name
string Not PII

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.

date_created
date_time<iso8601> Not PII

The date and time in GMT when the resource was created specified in ISO 8601 format.

date_updated
date_time<iso8601> Not PII

The date and time in GMT when the resource was last updated specified in ISO 8601 format.

url
url Not PII

The absolute URL of the Fleet resource.

data_enabled
boolean Not PII

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

data_limit
integer Not PII

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).

data_metering
enum:data_metering Not PII

The model by which a SIMs usage is metered and billed. Defaults to payg.

sms_commands_enabled
boolean Not PII

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

sms_commands_url
url Not PII

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.

sms_commands_method
http_method Not PII

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.

network_access_profile_sid
sid<HA> Not PII

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

ip_commands_url
url Not PII

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.

ip_commands_method
http_method Not PII

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.

Data limits

Each Super SIM’s usage is measured independently. Data limits are specified in the Fleet resource on a per SIM basis. For example, if a Fleet resource specifies a data limit of 5MB, every SIM assigned to that Fleet resource will be allowed to consume no more than 5MB of data.

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.

Create a Fleet resource

post
https://supersim.twilio.com/v1/Fleets
Parameters
Parameters in REST API format
network_access_profile
Required
post sid_like<HA> Not PII

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

unique_name
Optional
post string Not PII

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.

data_enabled
Optional
post boolean Not PII

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

data_limit
Optional
post integer Not PII

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).

ip_commands_url
Optional
post url Not PII

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.

ip_commands_method
Optional
post http_method Not PII

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.

sms_commands_enabled
Optional
post boolean Not PII

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

sms_commands_url
Optional
post url Not PII

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.

sms_commands_method
Optional
post http_method Not PII

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.

Example 1
        
        
        

        Fetch a Fleet resource

        get
        https://supersim.twilio.com/v1/Fleets/{Sid}
        Parameters
        Parameters in REST API format
        sid
        Path
        get sid_like<HF> Not PII

        The SID of the Fleet resource to fetch.

        Example 1
              
              
              

              Read multiple Fleet resources

              get
              https://supersim.twilio.com/v1/Fleets
              Parameters
              Parameters in REST API format
              network_access_profile
              Optional
              get sid_like<HA> Not PII

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

              Example 1
                    
                    
                    

                    Update a Fleet resource

                    post
                    https://supersim.twilio.com/v1/Fleets/{Sid}
                    Parameters
                    Parameters in REST API format
                    sid
                    Path
                    post sid_like<HF> Not PII

                    The SID of the Fleet resource to update.

                    unique_name
                    Optional
                    post string Not PII

                    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.

                    network_access_profile
                    Optional
                    post sid_like<HA> Not PII

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

                    ip_commands_url
                    Optional
                    post url Not PII

                    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.

                    ip_commands_method
                    Optional
                    post http_method Not PII

                    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.

                    sms_commands_url
                    Optional
                    post url Not PII

                    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.

                    sms_commands_method
                    Optional
                    post http_method Not PII

                    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.

                    data_limit
                    Optional
                    post integer Not PII

                    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).

                    Example 1
                          
                          
                          
                          Rate this page:

                          Need some help?

                          We all do sometimes; code is hard. Get help now from our support team, or lean on the wisdom of the crowd by visiting Twilio's Stack Overflow Collective or browsing the Twilio tag on Stack Overflow.

                                
                                
                                

                                Thank you for your feedback!

                                Please select the reason(s) for your feedback. The additional information you provide helps us improve our documentation:

                                Sending your feedback...
                                🎉 Thank you for your feedback!
                                Something went wrong. Please try again.

                                Thanks for your feedback!

                                Refer us and get $10 in 3 simple steps!

                                Step 1

                                Get link

                                Get a free personal referral link here

                                Step 2

                                Give $10

                                Your user signs up and upgrade using link

                                Step 3

                                Get $10

                                1,250 free SMSes
                                OR 1,000 free voice mins
                                OR 12,000 chats
                                OR more