Retrieve a list of Settings Updates.

GET /v1/SettingsUpdates

Retrieve a list of Settings Updates.

Query parameters

  • Sim string

    Filter the Settings Updates by a Super SIM's SID or UniqueName.

  • Status string

    Filter the Settings Updates by status. Can be scheduled, in-progress, successful, or failed.

    Values are scheduled, in-progress, successful, or failed.

  • PageSize integer(int64)

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

    Minimum value is 1, maximum value is 1000.

  • Page integer

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

    Minimum value is 0.

  • PageToken string

    The page token. This is provided by the API.

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
    • settings_updates array[object]
      Hide settings_updates attributes Show settings_updates attributes object
      • sid string | null

        The unique identifier of this Settings Update.

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

      • iccid string | null

        The ICCID associated with the SIM.

      • sim_sid string | null

        The SID of the Super SIM to which this Settings Update was applied.

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

      • status string

        The Status of this Settings Update. One of scheduled, in-progress, successful or failed.

        Values are scheduled, in-progress, successful, or failed.

      • packages array | null

        Array containing the different Settings Packages that will be applied to the SIM after the update completes. Each object within the array indicates the name and the version of the Settings Package that will be on the SIM if the update is successful.

      • date_completed string(date-time) | null

        The time, given in ISO 8601 format, when the update successfully completed and the new settings were applied to the SIM.

      • date_created string(date-time) | null

        The date that this Settings Update was created, given in ISO 8601 format.

      • date_updated string(date-time) | null

        The date that this Settings Update was updated, given in ISO 8601 format.

    • meta object
      Hide meta attributes Show meta attributes object
      • first_page_url string(uri)
      • key string
      • next_page_url string(uri) | null
      • page integer
      • page_size integer
      • previous_page_url string(uri) | null
      • url string(uri)
GET /v1/SettingsUpdates
curl \
 --request GET 'https://supersim.twilio.com/v1/SettingsUpdates' \
 --user "username:password"
{
  "meta": {
    "key": "settings_updates",
    "url": "https://supersim.twilio.com/v1/SettingsUpdates?PageSize=50&Page=0",
    "page": 0,
    "page_size": 50,
    "next_page_url": null,
    "first_page_url": "https://supersim.twilio.com/v1/SettingsUpdates?PageSize=50&Page=0",
    "previous_page_url": null
  },
  "settings_updates": []
}
{
  "meta": {
    "key": "settings_updates",
    "url": "https://supersim.twilio.com/v1/SettingsUpdates?Sim=HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0",
    "page": 0,
    "page_size": 50,
    "next_page_url": null,
    "first_page_url": "https://supersim.twilio.com/v1/SettingsUpdates?Sim=HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0",
    "previous_page_url": null
  },
  "settings_updates": [
    {
      "sid": "OBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
      "iccid": "89883070000123456789",
      "status": "successful",
      "sim_sid": "HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
      "packages": [
        {
          "name": "base-settings",
          "version": "1.0.0",
          "more_info": "https://twilio.com/docs/iot/supersim/settings-packages/base-settings"
        }
      ],
      "date_created": "2015-07-30T20:00:00Z",
      "date_updated": "2015-07-30T20:00:00Z",
      "date_completed": "2015-07-30T20:00:00Z"
    }
  ]
}
{
  "meta": {
    "key": "settings_updates",
    "url": "https://supersim.twilio.com/v1/SettingsUpdates?Status=scheduled&PageSize=50&Page=0",
    "page": 0,
    "page_size": 50,
    "next_page_url": null,
    "first_page_url": "https://supersim.twilio.com/v1/SettingsUpdates?Status=scheduled&PageSize=50&Page=0",
    "previous_page_url": null
  },
  "settings_updates": [
    {
      "sid": "OBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
      "iccid": "89883070000123456789",
      "status": "scheduled",
      "sim_sid": "HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
      "packages": [
        {
          "name": "base-settings",
          "version": "1.0.0",
          "more_info": "https://twilio.com/docs/iot/supersim/settings-packages/base-settings"
        }
      ],
      "date_created": "2015-07-30T20:00:00Z",
      "date_updated": "2015-07-30T20:00:00Z",
      "date_completed": null
    }
  ]
}
{
  "meta": {
    "key": "settings_updates",
    "url": "https://supersim.twilio.com/v1/SettingsUpdates?Status=scheduled&Sim=HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0",
    "page": 0,
    "page_size": 50,
    "next_page_url": null,
    "first_page_url": "https://supersim.twilio.com/v1/SettingsUpdates?Status=scheduled&Sim=HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0",
    "previous_page_url": null
  },
  "settings_updates": [
    {
      "sid": "OBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
      "iccid": "89883070000123456789",
      "status": "scheduled",
      "sim_sid": "HSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
      "packages": [
        {
          "name": "base-settings",
          "version": "1.0.0",
          "more_info": "https://twilio.com/docs/iot/supersim/settings-packages/base-settings"
        }
      ],
      "date_created": "2015-07-30T20:00:00Z",
      "date_updated": "2015-07-30T20:00:00Z",
      "date_completed": null
    }
  ]
}