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

  • OK

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

      The SID of the Account that created the resource

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

    • data_enabled boolean | null

      Defines whether SIMs in the Fleet are capable of using data connectivity

    • data_limit integer | null

      The total data usage (download and upload combined) in Megabytes that each Sim resource assigned to the Fleet resource can consume

    • data_metering string | null

      The model by which a SIM is metered and billed

      Value is payg.

    • date_created string(date-time) | null

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

    • date_updated string(date-time) | null

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

    • ip_commands_method string(http-method) | null

      A string representing the HTTP method to use when making a request to ip_commands_url

      Values are HEAD, GET, POST, PATCH, PUT, or DELETE.

    • 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

    • The SID of the Network Access Profile of the Fleet

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

    • sid string | null

      The unique string that identifies the resource

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

    • sms_commands_enabled boolean | null

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

    • sms_commands_method string(http-method) | null

      A string representing the HTTP method to use when making a request to sms_commands_url

      Values are HEAD, GET, POST, PATCH, PUT, or DELETE.

    • 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

    • unique_name string | null

      An application-defined string that uniquely identifies the resource

    • url string(uri) | null

      The absolute URL of the Fleet resource

GET /v1/Fleets/{Sid}
curl \
 -X GET https://supersim.twilio.com/v1/Fleets/{Sid} \
 --user "username:password"
Response examples (200)
{
  "account_sid": "string",
  "data_enabled": true,
  "data_limit": 42,
  "data_metering": "payg",
  "date_created": "2023-05-04T09:42:00+00:00",
  "date_updated": "2023-05-04T09:42:00+00:00",
  "ip_commands_method": "HEAD",
  "ip_commands_url": "https://example.com",
  "network_access_profile_sid": "string",
  "sid": "string",
  "sms_commands_enabled": true,
  "sms_commands_method": "HEAD",
  "sms_commands_url": "https://example.com",
  "unique_name": "string",
  "url": "https://example.com"
}
Response examples (200)
{
  "account_sid": "string",
  "data_enabled": true,
  "data_limit": 42,
  "data_metering": "payg",
  "date_created": "2024-05-04T09:42:00+00:00",
  "date_updated": "2024-05-04T09:42:00+00:00",
  "ip_commands_method": "HEAD",
  "ip_commands_url": "https://example.com",
  "network_access_profile_sid": "string",
  "sid": "string",
  "sms_commands_enabled": true,
  "sms_commands_method": "HEAD",
  "sms_commands_url": "https://example.com",
  "unique_name": "string",
  "url": "https://example.com"
}