Set write protection

POST

/locks

Restricts all write operations and forbids collection creation. This endpoint also returns previous lock options.

api-keystring

API Key authentication via header

Lock options and optional error message

writebooleanRequired

error_messagestring or nullOptional

successful operation

timedouble or null

Time spent to process this request

statusstring or null

resultobject or null

1	import requests
2
3	url = "http://localhost:6333/locks"
4
5	payload = { "write": True }
6	headers = {
7	"api-key": "<apiKey>",
8	"Content-Type": "application/json"
9	}
10
11	response = requests.post(url, json=payload, headers=headers)
12
13	print(response.json())