---
title: "POST /content-lock/unlock-keyring"
method: POST
path: "/content-lock/unlock-keyring"
tags: ["encryption"]
---

# POST /content-lock/unlock-keyring

`POST /content-lock/unlock-keyring`

## Request

- The document declares no server URL.
- Auth: one of:
  - API key in query parameter `auth`
  - API key in header `Authorization`

Resumes the session from the OS keychain and grants content access. Only for an explicit user
action in the app, never called on its own.

## Response `200`

Content unlocked when the keychain held a usable key

- ContentLockStatusEnvelope: Canonical success envelope: `{ "data": T, "ts": <unix millis i64> }`. `ts` is `chrono::Utc::now().timestamp_millis()`, set in the webserver handler via [`ApiEnvelope::now`] (the contract carries only the type + the clock helper, not a hard dependency on when the handler reads the clock). `rename_all = "camelCase"` is a no-op for the single-word fields here but is declared for forward-compat. IMPORTANT (utoipa v4): every concrete `ApiEnvelope<X>` that needs a named OpenAPI component is declared in the `#[aliases(...)]` block below. Add a new alias line whenever a new payload type needs enveloping. NEVER register the bare `ApiEnvelope` in `components(schemas(...))` — utoipa errors on a bare generic, and an un-aliased generic inlines an anonymous schema.
  - `data` ContentLockStatusResponse, required: Whether history-derived content may be shown to GUI-class clients (`gui`, `helper`). `unlocked` is computed at read time from the in-memory grant AND the encryption facts (initialised, session ready, background ready), so losing the session revokes visibility without any extra coupling. `generation` changes with every grant change, so a client can tell a stale answer from a current one.
    - `generation` integer, required
    - `unlocked` boolean, required
  - `ts` integer, required: Server time when the response was built (unix epoch milliseconds).

## Other responses

- `500`: Internal server error

## Changes

- **2026-10-15** `4c664cabd0c5`: 1 info
  - added the optional property `requestId` to the response with the `500` status
- **2026-10-01** `aa64ebd8cf74`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/uniclipboard/apis/uniclipboard-daemon-api/changes/content-lock/unlock-keyring/post.md)

---

[API](https://skmtc.dev/uniclipboard/apis/uniclipboard-daemon-api.md) - [All operations](https://skmtc.dev/uniclipboard/apis/uniclipboard-daemon-api/llms.txt) - [OpenAPI document](https://skmtc.dev/uniclipboard/apis/uniclipboard-daemon-api/revisions/48a01cf04e4c?raw)