/
/Swagger ESP Thread Border Router REST API
DocsSign in
Sign in
  • APIs
  • Generators
  • Stacks
  • Projects
  • Docs
  • History
  • Schema
Checked 1h ago · Updated 2w ago
diagnostics1
node21
  • getGet current active node parameters
  • deleteErase all persistent information, essentially factory reset the Border Router.
  • getGet the border agent ID
  • getRouting Locator IPv6 address of this Thread node.
  • getRouting Locator Router and Child ID (RLOC16).
  • getIEEE 802.15.4 Extended Address (EUI-64).
  • getGet current Thread state.
  • putSet current Thread state.
  • getThread network name this node is part of.
  • getGets the network's leader data.
  • getExtended PAN ID.
  • getGet number of router devices
  • getGet current active operational dataset
  • putCreates or updates the active operational dataset
  • getGet current pending operational dataset
  • putCreates or updates the pending operational dataset
  • getGet whether the Border Agent ephemeral key (ePSKc) feature is enabled.
  • putEnable or disable the Border Agent ephemeral key (ePSKc) feature.
  • getGet the status of the Border Agent ephemeral key (ePSKc) session.
  • postGenerate and activate an ephemeral key (ePSKc).
  • deleteDeactivate the currently active ephemeral key (ePSKc), if any.
    node

    Enable or disable the Border Agent ephemeral key (ePSKc) feature.

    The feature must be enabled before an ephemeral key can be activated with a POST request to /node/ba-epskc/key.

    put/node/ba-epskc/state

    Request body

    string required

    Can be "enable" or "disable".

    Example request

    "enable"

    Response

    Successful operation.

    Changes

    Changed in 1 of the 3 revisions of this API.○1

    • Aug 17, 20268e96e3b3f8d3○1See the full diff
      • ○

        endpoint added

        endpoint-added

    Full history