API: Privacy
Project-scoped subject erasure jobs. Available on every cloud plan and in on-prem mode; never controlled by a plan or license feature entitlement.
На этой странице
Раздел собран из спецификации OpenAPI продукта: 3 метод(ов). Поверхность — query-api (основной API, база /api/v1). Все методы требуют аутентификации.
Методы раздела
/projects/{id}/gdpr/forget List PII-safe subject deletion history (admin+)
Returns newest jobs first. Entries never expose the erased user_id, request fingerprint, aliases, traits, event payload or mutation SQL.
Параметры
| Имя | Где | Тип | Описание |
|---|---|---|---|
id обязателен | Путь | integer (int32) | Project id. |
limit необязателен | Query | integer | По умолчанию 50. |
Ответы
| Код | Что означает | Тело |
|---|---|---|
| 200 | PII-safe job history | object |
| 401 | Missing or invalid credentials (code=unauthorized) | Error |
| 403 | Authenticated but not permitted (code=forbidden) | Error |
| 404 | Resource not found (code=not_found) | Error |
| 422 | Request failed validation (code=validation_failed) | Error |
/projects/{id}/gdpr/forget Queue deletion of a subject's project-local data (admin+)
Resolves the supplied user_id through the identity/alias graph inside this project, then asynchronously deletes matching events, identify properties and alias mappings. An active request with the same safe fingerprint is idempotent and returns the existing job. After a terminal state a new request is allowed so newly ingested data can be removed. This operation is deliberately not plan-gated.
Параметры
| Имя | Где | Тип | Описание |
|---|---|---|---|
id обязателен | Путь | integer (int32) | Project id. |
X-Confirm-Forget обязателен | Заголовок | enum(true) | Explicit dangerous-action confirmation; must equal `true`. |
Тело запроса application/json , обязательно
| Поле | Тип | Описание |
|---|---|---|
user_id обязательно | string | Exact project-local subject identifier, 1..256 UTF-8 bytes. It is encrypted while the job is active and is never returned by status/history APIs. Leading and trailing whitespace is significant. |
Ответы
| Код | Что означает | Тело |
|---|---|---|
| 202 | Job queued, or the matching active job returned | GDPRForgetJob |
| 401 | Missing or invalid credentials (code=unauthorized) | Error |
| 403 | Authenticated but not permitted (code=forbidden) | Error |
| 404 | Resource not found (code=not_found) | Error |
| 422 | Request failed validation (code=validation_failed) | Error |
/projects/{id}/gdpr/forget/{jobID} Get a PII-safe subject deletion job status (admin+)
Project scope is checked independently of the job id. A foreign project/job combination returns 404 and never reveals job existence.
Параметры
| Имя | Где | Тип | Описание |
|---|---|---|---|
id обязателен | Путь | integer (int32) | Project id. |
jobID обязателен | Путь | integer (int64) |
Ответы
| Код | Что означает | Тело |
|---|---|---|
| 200 | Current job status and honest ClickHouse mutation state | GDPRForgetJob |
| 401 | Missing or invalid credentials (code=unauthorized) | Error |
| 403 | Authenticated but not permitted (code=forbidden) | Error |
| 404 | Resource not found (code=not_found) | Error |
Источник раздела — docs/api/openapi.yaml репозитория продукта,
версия API 1.0.0, OpenAPI 3.0.3,
снимок 095579325c2d.
Расхождение снимка со спецификацией роняет сборку документации.