OPopenthread
node

Creates or updates the active operational dataset

Changed on

Creates or updates the active operational dataset on the current node. Only allowed if the Thread node is inactive. If the Thread node is active, a pending dataset should be used to update the current active operational dataset.

put/node/dataset/active

Request

  • Base URL
    http://localhost:8081
  • URL
    http://localhost:8081/node/dataset/active
  • Auth
    none required

Headers

If-None-Match'*'

With the value *, the dataset is only written when none is in place yet; if one exists the request fails with 412 and nothing is written. Any other value is rejected with 400: the dataset resources carry no entity tags to match against. Without the header an existing dataset is replaced. The active dataset is only writable while Thread is stopped, and that check runs first: on a running node the response is 409 whether or not this header is present.

Request body

networkKeystring

Network key, 16 bytes long, formatted as a hexadecimal string

networkNamestring

Network name, 16 bytes long

extPanIdstring

Extended PAN ID, 8 bytes long, formatted as a hexadecimal string

meshLocalPrefixstring

Mesh local IPv6 prefix

panIdinteger

IEEE 802.15.4 PAN ID of the Thread network

channelinteger

IEEE 802.15.4 channel of the Thread network

pskcstring

The pre-shared commissioner key

channelMaskinteger

Channel mask

Example request

{
  "activeTimestamp": {
    "seconds": 10
  },
  "networkKey": "08277229F21FB7342D705D3CEFDC042A",
  "networkName": "OpenThread-e445",
  "extPanId": "996D3BEE320097A3",
  "meshLocalPrefix": "fd33:d3b9:89e3:72e4::/64",
  "panId": 58437,
  "channel": 21,
  "pskc": "FD943ECA225A28979B991EFAC1218A72",
  "securityPolicy": {
    "rotationTime": 672,
    "obtainNetworkKey": true,
    "nativeCommissioning": true,
    "routers": true,
    "externalCommissioning": true
  },
  "channelMask": 134215680
}

Response

Successfully updated the active operational dataset.

Changes

  • c3799941c155Revision changes
    • breaking

      removed the media type plain/text from the request body

    • info

      added the media type text/plain to the request body

  • bbe4a10dd414Revision changes
    • info

      added the new optional header request parameter If-None-Match

    • info

      added the non-success response with the status