POST /api/v1/{context_id}/scopes/forget

Changed on Aug 24, 2026

Erase everything tagged under a scope subtree (GDPR forget). Requires the memory:forget grant over the subtree.

Request

The document declares no server URL.
Auth
HTTP bearer
TypeScript
https://skmtc.dev/surrealdb/apis/spectron/docs/api/v1/:context_id/scopes/forget/post.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

context_idstring required

Spectron context id

Request body

pathstring nullable

Scope path whose subtree should be forgotten, e.g. user/stu/.

Response

forgotteninteger required

Number of fact rows erased across the scoped tables.

Changes

Aug 24, 20269f1598713067 Revision changes
- info
  added the non-success response with the status

Operation history