Toggle editor lock

Designing

Staging

POST

/internal/documents/{roomId}/lock

Documents

Locks or unlocks the code editor for a room. When locked, all connected clients
receive a read-only flag via Yjs awareness, preventing further edits. Used during
code review phases or when the interviewer wants to freeze the editor.

Locking is idempotent: locking an already-locked editor returns success without error.

Request

Authorization

API Key

Add parameter in header

X-Internal-Secret

Example:

X-Internal-Secret: ********************

Path Params

Body Params application/jsonRequired

Examples

Responses

🟢200OK

application/json

Lock state updated

Body

🟠404Not Found

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST '/internal/documents//lock' \
--header 'X-Internal-Secret: <api-key>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "locked": true
}'

Response Example

200 - Example 1

{
    "locked": true
}

Modified at 2026-03-12 06:08:16

Kick a user from the document

Health check