Fetch a Fleet instance from your account.

GET /v1/Fleets/{Sid}

Configure shared settings inherited by all Super SIMs assigned to the Fleet

Fetch a Fleet instance from your account.

Path parameters

  • Sid string Required

    The SID of the Fleet resource to fetch.

Responses

  • 200 application/json

    OK

    Hide headers attributes Show headers attributes
    • Access-Control-Allow-Origin string

      Specify the origin(s) allowed to access the resource

    • Access-Control-Allow-Methods string

      Specify the HTTP methods allowed when accessing the resource

    • Access-Control-Allow-Headers string

      Specify the headers allowed when accessing the resource

    • Access-Control-Allow-Credentials boolean

      Indicates whether the browser should include credentials

    • Access-Control-Expose-Headers string

      Headers exposed to the client

    Hide response attributes Show response attributes object
    • account_sid string | null

      The SID of the Account that created the Fleet resource.

      Minimum length is 34, maximum length is 34. Format should match the following pattern: ^AC[0-9a-fA-F]{32}$.

    • sid string | null

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

      Minimum length is 34, maximum length is 34. Format should match the following pattern: ^HF[0-9a-fA-F]{32}$.

    • unique_name string | null

      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 string(date-time) | null

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

    • date_updated string(date-time) | null

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

    • url string(uri) | null

      The absolute URL of the Fleet resource.

    • data_enabled boolean | null

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

    • data_limit integer

      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 250MB.

      Default value is 0.

    • data_metering string

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

      Value is payg.

    • sms_commands_enabled boolean | null

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

    • sms_commands_url string(uri) | null

      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 string(http-method) | null

      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.

      Values are GET or POST.

    • network_access_profile_sid string | null

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

      Minimum length is 34, maximum length is 34. Format should match the following pattern: ^HA[0-9a-fA-F]{32}$.

    • ip_commands_url string(uri) | null

      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 string(http-method) | null

      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.

      Values are GET or POST.

GET /v1/Fleets/{Sid}
curl \
 --request GET 'https://supersim.twilio.com/v1/Fleets/{Sid}' \
 --user "username:password"
Response examples (200)
{
  "sid": "HFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "url": "https://supersim.twilio.com/v1/Fleets/HFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "data_limit": 1000,
  "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "unique_name": "unique_name",
  "data_enabled": true,
  "date_created": "2019-07-30T20:00:00Z",
  "date_updated": "2019-07-30T20:00:00Z",
  "data_metering": "payg",
  "ip_commands_url": null,
  "sms_commands_url": null,
  "ip_commands_method": "POST",
  "sms_commands_method": "POST",
  "sms_commands_enabled": true,
  "network_access_profile_sid": "HAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
}