Skip to main content

Create a new configuration job

POST 
/v2/configuration-jobs

Create a new configuration job

Overview​

This endpoint allows you to create a new configuration job in your system. Once created, the job is automatically processed.

Usage​

Use this endpoint when you need to create and execute configuration jobs in one step, ensuring immediate processing according to the job's defined parameters and type.

Example Requests​

Example 1: Configure up to 10 WiFi profiles for TU700​

{
    "name": "Configure Wi-Fi for TU700 - MySSID",
    "description": "Configure all TU700s on the account to connect to MySSID",
    "desiredStateOnEnter": {
        "desired": {
            "wifi": {
                "profiles": [
                    {
                        "ssid": "MySSID1",
                        "securityType": "WPA2_PSK",
                        "password": "mypassword"
                    },
                    {
                        "ssid": "MySSID",
                        "securityType": "AUTOMATIC"
                    }
                ]
            }
        }
    },
    "deviceIds": [
        "d3f9a1b2-4c5d-6e7f-8a9b-0b1c2d3e4f5g"
    ]
}

Example 2: Clear Wi-Fi Profiles on TU700​

{
  "name": "Clear Wi-Fi for TU700",
  "description": "Clear all TU700s Wi-Fi profiles",
  "desiredStateOnEnter": {
    "desired": {
      "wifi": {
        "profiles": null
      }
    }
  },
  "deviceIds": [
    "1a2b3c4d-5e6f-7g8h-9i0j-1k2l3m4n5o6p",
    "q7r8s9t0-u1v2-w3x4-y5z6-7a8b9c0d1e2f",
    "3g4h5i6j-7k8l-9m0n-1o2p-3q4r5s6t7u8v"
  ]
}

Example 3: Delete Single Wi-Fi Profile on TU700​

{
    "name": "Delete single Wi-Fi for TU700",
    "description": "Delete single Wi-Fi on TU700s on the account",
    "desiredStateOnEnter": {
        "desired": {
            "wifi": {
                "profiles": [
                    {
                        "ssid": "MySSID",
                        "_delete": true
                    }
                ]
            }
        }
    },
    "deviceIds": [
      "5f6g7h8i-9j0k-1l2m-3n4o-5p6q7r8s9t0u",
      "v1w2x3y4-z5a6-b7c8-d9e0-f1g2h3i4j5k6",
      "l7m8n9o0-p1q2-r3s4-t5u6-v7w8x9y0z1a2"
    ]
}

Example 4: Change Operating Mode​

{
    "name": "Change operating mode to stock and set variant to ...",
    "desiredStateOnEnter": {
        "desired": {
            "operatingMode": {
                "mode": "stock",
                "variant": {
                    "id": "123"
                }
            }
        }
    },
    "deviceIds": [
        "b1c2d3e4-f5g6-h7i8-j9k0-l1m2n3o4p5q6",
        "r7s8t9u0-v1w2-x3y4-z5a6-b7c8d9e0f1g2"
    ]
}

Example 5: Add CAN Profile​

{
    "name": "Add CAN Profile",
    "desiredStateOnEnter": {
        "desired": {
            "canbus": {
                "profile": {
                    "id": 123
                }
            }
        }
    },
    "deviceIds": [
        "c1d2e3f4-g5h6-i7j8-k9l0-m1n2o3p4q5r6",
        "s7t8u9v0-w1x2-y3z4-a5b6-c7d8e9f0g1h2"
    ]
}

These examples demonstrate how to configure, clear, and delete Wi-Fi profiles, change operating modes, and add CAN profiles on TU700 devices.

Request​

Responses​

The newly created configuration job