OTA updates

List OTA updates

Changed on

Retrieve a paginated list of over-the-air (OTA) update operations for your SIM cards.

get/ota_updates

Request

  • Base URL: https://api.telnyx.com/v2
  • URL: https://api.telnyx.com/v2/ota_updates
  • Auth: HTTP bearer

Query parameters

status'in-progress' | 'completed' | 'failed'

Filter by a specific status of the resource's lifecycle.

sim_card_idstring

The SIM card identification UUID.

type'sim_card_network_preferences'

Filter by type.

Consolidated filter parameter for OTA updates (deepObject style). Originally: filter[status], filter[sim_card_id], filter[type]

{
  "status": "in-progress",
  "type": "sim_card_network_preferences"
}
numberinteger

The page number to load.

sizeinteger

The size of the page.

Consolidated pagination parameter (deepObject style). Originally: page[number], page[size]

Response

Successful response

Example response

{
  "data": [
    {
      "id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
      "record_type": "ota_update",
      "sim_card_id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
      "type": "sim_card_network_preferences",
      "status": "in-progress",
      "created_at": "2018-02-02T22:25:27.521Z",
      "updated_at": "2018-02-02T22:25:27.521Z"
    }
  ],
  "meta": {
    "total_pages": 3,
    "total_results": 55,
    "page_number": 2,
    "page_size": 25
  }
}

Changes

  • 19db5ee4ec59Revision changes
    • breaking

      the // response's property type changed from integer to string, and format from int32 to no format for status

    • info

      added the optional property // to the response with the status

  • a6a61a29ecddRevision changes
    • breaking

      the // response's property type changed from string to integer, and format from no format to int32 for status