An anonymous line has no customer portal login, so the household cannot set its own Wi-Fi in the portal. These two calls cover that. They work for anonymous lines only.
  • Send a link. kurnl mails the line’s contact_email a link. The household opens it, picks a network name and a password, and the router applies them.
  • Set it yourself. You send the network name and password, for example from your own set-up page.
kurnl also sends the first link on its own. See CKO-03 anonymous.

​
Authentication

X-API-Key header with the provisioning:write scope. A key without it gets 403. Rate limit: 60 requests / minute per key on each call.

​
Address the line

The {subscription_id} in the path is the kurnl subscription_id from the completion call. To use your own identifier instead, add ?by=external_subscription_id and put your external_subscription_id in the path. A line that is not yours, or does not exist, answers 404; so does a path id that is not a kurnl subscription_id. Looked up by your own identifier, only your own anonymous lines match: a named line, or a line of another provider with the same identifier, answers 404. Any by value other than external_subscription_id answers 422 with invalid_lookup.
No body. kurnl mails the line’s contact_email. Response — 200 OK:
  • The link works once and for 7 days.
  • A new link cancels the earlier link of that line if it has not been used yet.
  • At most 5 links per line in 24 hours.
  • The link is only in the mail. It is never returned to you.

​
Set the network yourself

Response — 200 OK:
kurnl never returns the password, and does not store it where you can read it back. Keep your own copy. apply_status tells you where the router stands. It is pending until the router has taken the new settings, then applied, or failed if it did not.

​
Errors

Errors carry detail.code and detail.message. On a 4xx error nothing was sent or changed. A 503 usually means the same, but a failure late in the call can answer 503 after kurnl has already sent the network to the router, or the link to the household. Repeating the set call with the same name and password is safe.
kurnl sends no webhook when a Wi-Fi network changes. Read the result from the response.