Boards

Lock board (set/change mode)

Apply an access lock to the board. On an unlocked board: server generates an 8-char [a-z0-9] key, stores its SHA-256 hash, and returns the plaintext key ONCE. On an already-locked board: caller must supply the existing key via X-Board-Key; only the mode is updated.

There is no recovery. Losing the key loses the board.

post/api/boards/{boardId}/lock

Request

  • Base URL: https://cnvs.app
  • URL: https://cnvs.app/api/boards/{boardId}/lock
  • Auth: none declared

Request body

mode'write' | 'all' required

write = anyone can read, only key-holders can mutate. all = key required for both read and write.

Response

Lock applied. key is present only on first lock (server-generated).

mode'write' | 'all' required
keystring

Plaintext access key — returned once. Server only stores SHA-256.

Changes

No recorded changes to this operation across all 1 revision of this API.