Recipes

Upgrade Firmware

Automation

GET /v1/devices

GET /v1/devices//targetFirmware

POST /v1/tasks

Upgrade the devices that have an approved firmware upgrade path to the version you're deploying, and track the task to completion.

You can adjust the script to your needs. Change the conditions, variables, and values to produce the output you want.

import json
import time

import requests

BASE = "https://api.securithings.com"
headers = {"Authorization": f"Bearer {access_token}"}

TARGET_FIRMWARE = "9.80.1"

devices = requests.get(
    f"{BASE}/v1/devices",
    params={"status": "online", "limit": 100},
    headers=headers,
).json()["devices"]

candidates = [
    device["id"]
    for device in devices
    if device["availableTask"]["upgradeFirmware"]
]

targets = []
for device_id in candidates:
    paths = requests.get(
        f"{BASE}/v1/devices/{device_id}/targetFirmware",
        headers=headers,
    ).json()["targetFirmware"]
    if TARGET_FIRMWARE in paths:
        targets.append(device_id)

response = requests.post(
    f"{BASE}/v1/tasks",
    json={
        "taskType": "upgradeFirmware",
        "defaultPayload": {"targetFirmware": TARGET_FIRMWARE},
        "devices": [
            {"deviceId": device_id} for device_id in targets
        ],
    },
    headers=headers,
)
task_id = response.json()["taskId"]

while True:
    task = requests.get(
        f"{BASE}/v1/tasks/{task_id}",
        headers=headers,
    ).json()
    pending = [
        device_task
        for device_task in task["deviceTasks"]
        if device_task["status"] != "completed"
    ]
    if not pending:
        break
    time.sleep(30)

result = {
    "taskId": task_id,
    "succeeded": [
        {
            "deviceId": device_task["deviceId"],
            "deviceName": device_task["deviceName"],
        }
        for device_task in task["deviceTasks"]
        if device_task["result"] == "succeeded"
    ],
    "failed": [
        {
            "deviceId": device_task["deviceId"],
            "deviceName": device_task["deviceName"],
            "result": device_task["result"],
        }
        for device_task in task["deviceTasks"]
        if device_task["result"] != "succeeded"
    ],
}

print(json.dumps(result, indent=2))

Output

{
"taskId": "19rs171mrlx9j3s",
"succeeded": [
  {
    "deviceId": "9ff559ee-38b6-11f1-81cb-465864a35d0a",
    "deviceName": "192.168.2.53 - Unit"
  }
],
"failed": [
  {
    "deviceId": "dc7d4ef1-6bf9-11f1-b083-d27bafcacdf8",
    "deviceName": "192.168.2.70 - Unit",
    "result": "rolledBack"
  }
]
}

Rotate SSL Certificates