Sign in
latestOpenAPI 3.0.3BSD 3-Clauseraw.githubusercontent.com2026-08-214532102.7 KB

7996e8479177

node

Generate and activate an ephemeral key (ePSKc).

Generates a new 9-digit Thread Administration Passcode (TAP) and starts listening for an external commissioner candidate to connect using it. The ephemeral key feature must first be enabled with a PUT request to /node/ba-epskc/state.

post/node/ba-epskc/key

Request body

lifetimeinteger

The key lifetime in milliseconds. Defaults to OT_BORDER_AGENT_DEFAULT_EPHEMERAL_KEY_TIMEOUT (2 minutes) when omitted or zero. Maximum value is OT_BORDER_AGENT_MAX_EPHEMERAL_KEY_TIMEOUT (10 minutes); values above the maximum are rejected with 400.

portinteger

The UDP port to use. Defaults to the device's own default when omitted.

Example request

{
  "lifetime": 120000,
  "port": 49152
}

Response

Successful operation

tapstring

The generated 9-digit Thread Administration Passcode (TAP).

portinteger

The UDP port the border agent is listening on for the ePSKc session.

Example response

{
  "tap": "123456789",
  "port": 49152
}