---
title: "Update IoT profile by ID"
method: PUT
path: "/iot-profiles/{id}"
tags: ["Configuration - Policy"]
---

# Update IoT profile by ID

`PUT /iot-profiles/{id}`

Update the existing IoT profile by the profile ID.

## Path parameters

- `id` integer, required

## Request body

- XiqIotProfileRequest
  - `name` string, required — The IoT profile name
  - `app_id` 'THREAD_GATEWAY', required — The supported IoT applications.
  - `thread_gateway` XiqIotProfileThreadGateway — Thread Gateway application settings.
    - `short_pan_id` string, required — The Personal Area Network (PAN) ID. (4 hex digits). FFFF is reserved.
    - `ext_pan_id` string, required — The Extended Personal Area Network (PAN) ID. (16 hex digits)
    - `master_key` string, required — The network key is used to secure access to the Thread network. It is used to encrypt and authenticate all messages on the network. (32 hex digits)
    - `network_name` string, required — A human-readable name for the network, up to 16 bytes in length.
    - `channel` integer, required — 802.15.4 channel number, 11-26
    - `comm_credentials` string — The Commissioner Credential is used along with the Extended PAN ID and Network Name to create the PSKc (Pre-Shared Key for the Commissioner).
    - `comm_timeout` integer — After this timeout the Commissioner will shutdown. The default is 120 sec. but the max is approximately 23 days.
    - `enable_nat64` boolean — Enable NAT64 functions including the translator and the prefix publishing.
    - `enable_dns_search_domain` boolean — Enable adding DNS search domain to unqualified host lookups forwarded by upstream DNS (in the thread border router).
    - `white_list` XiqIotpTgWhiteListEntry[]
      - `long_eui` string, required — The factory-assigned IEEE EUI-64. (16 hex digits) or * to match any joiner. FFFFFFFFFFFFFFFF is reserved.
      - `pskd` string, required — The PSKd (Pre-Shared-Key for the Device) is the Joining Device Credential encoded using base32-thread. A Joining Device Credential is encoded as uppercase, alphanumeric characters (base32-thread: 0-9,A-Y excluding I,O,Q, and Z for readability) with a minimum length of 6 such characters and a maximum length of 32 such characters.
    - `default_user_profile_id` integer — The default user-profile ID.
  - `app_supported` 'SINGLE' | 'MULTI', required — The supported IoT profile type.
  - `ble_beacon` XiqIotpMaBleBeacon — BLE Beacon
    - `applications` XiqIotpMaBleBeaconApplication[] — Collection of BLE Beacon applications
      - `measured_rss` integer — BLE Beacon application measured Received Signal Strength value, in dBm.
      - `advertise_interval` integer — BLE Beacon application advertisement interval value in ms.
      - `tx_power` integer — // The BLE Beacon transmit power, in dBm.
      - `major` integer — BLE Beacon application major value, for BLE Beacon applications of type IBEACON.
      - `minor` integer — BLE Beacon application minor value, for BLE Beacon applications of type IBEACON.
      - `uuid` string — BLE Beacon application UUID, for BLE Beacon applications of type IBEACON.
      - `url` string — BLE Beacon Eddystone URL, for BLE Beacon applications of type EDDYSTONE_URL.
      - `app_type` 'IBEACON' | 'EDDYSTONE_URL', required — The BLE Beacon application type.
  - `ble_scan` XiqIotpMaBleScan — BLE Scan
    - `destination` XiqIotpMaBleScanDestination — The BLE Scan destination settings.
      - `interval` integer — The XIQ report interval, in seconds.
      - `http_server` XiqHttpServer — The BLE Scan destination HTTP server URL.
        - `url` string — The HTTP server URL.
        - `interval` integer — The HTTP server interval, in seconds.
        - `enable_deduplication` boolean — Enable to remove BLE scan duplicates entries within the specified time interval.
    - `applications` XiqIotpMaBleScanApplication[] — Collection of BLE Scan applications
      - `min_rss` integer — BLE Scan application minimum Received Signal Strength value, in dBm.
      - `uuid` string — BLE Scan iBeacon application UUID, for BLE Scan applications of type IBEACON.
      - `vendors` XiqIotpMaBleScanVendor[] — Collection of BLE Scan vendor filters for Generic Scan applications, for BLE Scan applications of type GENERIC.
        - `vendor_type` 'ANY' | 'CHORUS' | 'CUSTOM' — BLE Scan Vendor type.
        - `vendor_name` string — Custom Vendor name, for CUSTOM Vendor type.
        - `company_id` integer — Custom Vendor company ID, for CUSTOM Vendor type.
      - `app_type` 'IBEACON' | 'EDDYSTONE_URL' | 'GENERIC', required — The BLE Scan application type.

## Response `200`

OK

- XiqIotProfile — The payload of IoT Profile
  - `id` integer, required — The unique identifier
  - `create_time` string, date-time, required — The create time in UTC (ISO 8601 format)
  - `update_time` string, date-time, required — The last update time in UTC (ISO 8601 format)
  - `name` string, required — The IoT profile name
  - `app_id` 'THREAD_GATEWAY' — The supported IoT applications.
  - `thread_gateway` XiqIotProfileThreadGateway — Thread Gateway application settings.
    - `short_pan_id` string, required — The Personal Area Network (PAN) ID. (4 hex digits). FFFF is reserved.
    - `ext_pan_id` string, required — The Extended Personal Area Network (PAN) ID. (16 hex digits)
    - `master_key` string, required — The network key is used to secure access to the Thread network. It is used to encrypt and authenticate all messages on the network. (32 hex digits)
    - `network_name` string, required — A human-readable name for the network, up to 16 bytes in length.
    - `channel` integer, required — 802.15.4 channel number, 11-26
    - `comm_credentials` string — The Commissioner Credential is used along with the Extended PAN ID and Network Name to create the PSKc (Pre-Shared Key for the Commissioner).
    - `comm_timeout` integer — After this timeout the Commissioner will shutdown. The default is 120 sec. but the max is approximately 23 days.
    - `enable_nat64` boolean — Enable NAT64 functions including the translator and the prefix publishing.
    - `enable_dns_search_domain` boolean — Enable adding DNS search domain to unqualified host lookups forwarded by upstream DNS (in the thread border router).
    - `white_list` XiqIotpTgWhiteListEntry[]
      - `long_eui` string, required — The factory-assigned IEEE EUI-64. (16 hex digits) or * to match any joiner. FFFFFFFFFFFFFFFF is reserved.
      - `pskd` string, required — The PSKd (Pre-Shared-Key for the Device) is the Joining Device Credential encoded using base32-thread. A Joining Device Credential is encoded as uppercase, alphanumeric characters (base32-thread: 0-9,A-Y excluding I,O,Q, and Z for readability) with a minimum length of 6 such characters and a maximum length of 32 such characters.
    - `default_user_profile_id` integer — The default user-profile ID.
  - `app_supported` 'SINGLE' | 'MULTI' — The supported IoT profile type.
  - `ble_beacon` XiqIotpMaBleBeacon — BLE Beacon
    - `applications` XiqIotpMaBleBeaconApplication[] — Collection of BLE Beacon applications
      - `measured_rss` integer — BLE Beacon application measured Received Signal Strength value, in dBm.
      - `advertise_interval` integer — BLE Beacon application advertisement interval value in ms.
      - `tx_power` integer — // The BLE Beacon transmit power, in dBm.
      - `major` integer — BLE Beacon application major value, for BLE Beacon applications of type IBEACON.
      - `minor` integer — BLE Beacon application minor value, for BLE Beacon applications of type IBEACON.
      - `uuid` string — BLE Beacon application UUID, for BLE Beacon applications of type IBEACON.
      - `url` string — BLE Beacon Eddystone URL, for BLE Beacon applications of type EDDYSTONE_URL.
      - `app_type` 'IBEACON' | 'EDDYSTONE_URL', required — The BLE Beacon application type.
  - `ble_scan` XiqIotpMaBleScan — BLE Scan
    - `destination` XiqIotpMaBleScanDestination — The BLE Scan destination settings.
      - `interval` integer — The XIQ report interval, in seconds.
      - `http_server` XiqHttpServer — The BLE Scan destination HTTP server URL.
        - `url` string — The HTTP server URL.
        - `interval` integer — The HTTP server interval, in seconds.
        - `enable_deduplication` boolean — Enable to remove BLE scan duplicates entries within the specified time interval.
    - `applications` XiqIotpMaBleScanApplication[] — Collection of BLE Scan applications
      - `min_rss` integer — BLE Scan application minimum Received Signal Strength value, in dBm.
      - `uuid` string — BLE Scan iBeacon application UUID, for BLE Scan applications of type IBEACON.
      - `vendors` XiqIotpMaBleScanVendor[] — Collection of BLE Scan vendor filters for Generic Scan applications, for BLE Scan applications of type GENERIC.
        - `vendor_type` 'ANY' | 'CHORUS' | 'CUSTOM' — BLE Scan Vendor type.
        - `vendor_name` string — Custom Vendor name, for CUSTOM Vendor type.
        - `company_id` integer — Custom Vendor company ID, for CUSTOM Vendor type.
      - `app_type` 'IBEACON' | 'EDDYSTONE_URL' | 'GENERIC', required — The BLE Scan application type.

---

[API](https://skmtc.net/extremecloudiq/apis/extremecloud-iq-api.md) · [All operations](https://skmtc.net/extremecloudiq/apis/extremecloud-iq-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/extremecloudiq/extremecloud-iq-api/versions/5ff7ab84e8e8/schema)