For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
CloudGitHub
  • API Reference
      • GETCollect telemetry data
      • GETRetrieve instance details
      • GETCollect Prometheus metrics data
      • GETCheck write protection
      • POSTSet write protection
      • GETKubernetes health check
      • GETKubernetes liveness probe
      • GETKubernetes readiness probe
LogoLogo
CloudGitHub
API ReferenceService

Set write protection

POST
/locks
POST
/locks
$curl -X POST http://localhost:6333/locks \
>     -H "api-key: <apiKey>" \
>     -H "Content-Type: application/json" \
>     -d '{
>  "write": true
>}'
200Successful
1{
2  "usage": {
3    "cpu": 1,
4    "io_read": 1,
5    "io_write": 1
6  },
7  "time": 0.002,
8  "status": "ok",
9  "result": {
10    "write": true,
11    "error_message": "string"
12  }
13}
Restricts all write operations and forbids collection creation. This endpoint also returns previous lock options.
Was this page helpful?
Previous

Kubernetes health check

Next
Built with

Authentication

api-keystring
API Key authentication via header

Request

Lock options and optional error message
writebooleanRequired
error_messagestring or nullOptional

Response

successful operation
usageobject or any
timedouble
Time spent to process this request
statusstring
resultobject