Set encryption
Turns tenant-scoped encryption on or off.
- Authentication
- Bearer token
- Retries
- Idempotency-Key
- Body
- application/json
- Version
- 2026-09-03
Both directions are safe and neither is instant.
On takes effect immediately for new writes once a key exists, and the crypto.seal_backlog sweep converts what came before. Nothing becomes unreadable in the meantime: a plaintext value opens as itself.
Off stops new writes being sealed and leaves existing ciphertext sealed, which keeps reading correctly because the key is still there. It does not decrypt anything, and saying otherwise would be the dangerous lie - a customer who switches off, exports, and deletes their workspace would otherwise expect plaintext they never got.
Headers#
Request body#
Responses#
Errors#
Failures use one envelope on every endpoint, described in Retries, versioning and limits. The codes you are most likely to meet here:
validation_error· 422 — The payload was well-formed JSON but failed schema validation.unauthenticated· 401 — The request carried no API key, or one the API could not verify.forbidden· 403 — The key is valid, but it is not allowed to do this — either the scope is missing or the resource belongs to another workspace.idempotency_key_reused· 422 — This `Idempotency-Key` was used before, for a request with a different body.rate_limited· 429 — Too many requests in the current window. The limit is per workspace, and some endpoints add a per-agent limit on top.
More Workspace endpoints#
Something unclear or missing? Tell us and we’ll fix it.