Справочник API
Снимки
Эндпоинты снимков индекса — создание, список, чтение со ссылкой на скачивание, удаление и восстановление.
Понятия и лимиты — на странице Снимки индекса. Все пути под
/api/v1/indexes/{slug}.
| Метод | Путь | Scopes | Ответ |
|---|---|---|---|
POST | /snapshots[?prune=true] | settings:write + documents:write | 202 { job_id, snapshot_id, status, pruned } |
GET | /snapshots | documents:read | 200 { index, snapshots[] } |
GET | /snapshots/{snapshotId} | documents:read | 200 { snapshot, download } |
DELETE | /snapshots/{snapshotId} | settings:write + documents:write | 200 { deleted: true, id } |
POST | /snapshots/{snapshotId}/restore | settings:write + documents:write | 202 { job_id, status } |
Объект снимка: id, index, created_at, document_count, bytes,
engine_version, embed_model, checksum, counts.
| Статус | Код | Когда |
|---|---|---|
| 404 | SNAPSHOT_NOT_FOUND | Неизвестный id или снимок другого индекса/тенанта |
| 409 | SNAPSHOT_LIMIT_REACHED | Достигнут snapshotsPerIndex; details.limit, details.existing |
| 409 | JOB_CONFLICT | Restore при активном reindex или restore |
Платформенные /admin/snapshot[s] — для оператора, требуют admin-токен и отвечают
503 SNAPSHOT_NOT_CONFIGURED без SEARCH_SNAPSHOT_DIR.