Update Cellular Module Firmware Configuration (v2.0)

PUT 
/v2.0/api/tenants/:tenant_id/elements/:element_id/cellular_modules/:cellular_module_id/firmware

Update the cellular module firmware configuration.

Request

Path Parameters

tenant_id stringrequired

ID of the tenant.

element_id stringrequired

ID of the element.

cellular_module_id stringrequired

ID of the cellular module.

application/json

Body

cellular_module_image_ids string[]

The cellular module image ID.

download_interval integer

The firmware download interval. Valid download interval must be provided along with a valid download time.

id string

The ID of the cellular module firmware.

interface_ids string[]

The interface IDs of the firmware. Max interfaces allowed is 4.

scheduled_download string

The scheduled download of the firmware.

scheduled_upgrade string

The scheduled upgrade of the firmware.

upgrade_interval integer

The upgrade interval of the firmware. Valid upgrade interval must be provided along with a valid upgrade time.

Responses

200

Successful Operation

application/json

Schema

Schema

cellular_module_image_ids string[]

The cellular module image ID.

download_interval integer

The firmware download interval. Valid download interval must be provided along with a valid download time

id string

The ID of the cellular module firmware.

interface_ids string[]

The interface IDs of the firmware. Max interfaces allowed is 4.

scheduled_download string

The scheduled download of the firmware.

scheduled_upgrade string

The scheduled upgrade of the firmware.

upgrade_interval integer

The upgrade interval of the firmware. Valid upgrade interval must be provided along with a valid upgrade time.

Example (from schema)

{
  "cellular_module_image_ids": [
    "string"
  ],
  "download_interval": 0,
  "id": "string",
  "interface_ids": [
    "string"
  ],
  "scheduled_download": "string",
  "scheduled_upgrade": "string",
  "upgrade_interval": 0
}

400

Bad Request

application/json

Schema

Schema

_error ErrorResponse[]
Array [
code string
The error code.
message string
The error message.
]

Example (from schema)

{
  "_error": [
    {
      "code": "string",
      "message": "string"
    }
  ]
}

Example

{
  "value": {
    "_error": [
      {
        "code": "INVALID_JSON_INPUT"
      },
      {
        "code": "INVALID_JSON_EXTRA_ATTRIBUTE"
      },
      {
        "code": "INVALID_JSON_COMMON_ATTR_MISMATCH"
      },
      {
        "code": "FW_CONFIG_NOTFOUND"
      },
      {
        "code": "FW_CONFIG_INVALID_MISSING_IMAGE_IDS"
      },
      {
        "code": "FW_CONFIG_INVALID_IMAGE_IDS_COUNT"
      },
      {
        "code": "FW_CONFIG_INVALID_INTERFACES"
      },
      {
        "code": "FW_CONFIG_INVALID_DOWNLOAD_INTERVAL"
      },
      {
        "code": "FW_CONFIG_INVALID_UPGRADE_INTERVAL"
      },
      {
        "code": "FW_CONFIG_INVALID_DOWNLOAD_ONLY_NOTSUPPORTED"
      },
      {
        "code": "FW_CONFIG_INVALID_DOWNLOAD_TIME"
      },
      {
        "code": "FW_CONFIG_INVALID_UPGRADE_TIME"
      },
      {
        "code": "FW_CONFIG_INCOMPATIBLE_SCHEDULES"
      },
      {
        "code": "FW_CONFIG_IMAGES_FOR_SAME_CARRIER_NOT_ALLOWED"
      }
    ]
  }
}

Loading...