Scrub a resource field's history

POST

/api/admin/resources/field-scrub

Maintainer:Not configured

OperationId:admin_scrub_resource_field

Redacts every prior value of a resource's title, origin URI, one property family (named by its handle from the family listing) or every property family, from the ledger and the projection, while the resource survives. By default today's value is kept; with clear, the act first clears it (a placeholder title or origin URI, the placeholder type for doc_type, or an unset of the family) and then redacts every value the field held. properties cannot be cleared. The server mints the request reference. The answer is either a completion or a recorded refusal (status). The request and the handle are checked first, whatever the resource's state, so a recorded refusal names only a real family of the resource. No key text or value appears in the request, the answer or the record. Requires a system admin. Any other caller gets 404, decided before any lookup, so a refusal reveals nothing about the resource.

Request

Authorization

JWT Bearer

Add the parameter

Authorization

to Headers

Example:

Authorization: ********************

Header Params

Body Params application/jsonRequired

Examples

Responses

🟢200OK

application/json

The act completed, or was refused and the refusal recorded (status says which)

Bodyapplication/json

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠404Record Not Found

🟠422Parameter Error

Request Example

Shell

JavaScript

Java

Swift

curl --location '/api/admin/resources/field-scrub' \
--header 'X-Temper-Surface;' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
    "clear": true,
    "family": "94e1bf30-62f3-41fa-af2a-8b8e19ac691e",
    "field": "title",
    "resource": "d008879e-b5d9-47da-af4e-3c8f40b7c9ee"
}'

Response Example

200 - Example 1

{
    "cleared": true,
    "event_id": "a7a26ff2-e851-45b6-9634-d595f45458b7",
    "field": {
        "family": null,
        "kind": "title"
    },
    "redacted_fields": [
        {
            "event": "1a4a8620-0119-4336-af71-a3b3e24f5ebc",
            "paths": [
                "string"
            ]
        }
    ],
    "request_reference": "befa7ed4-201c-4983-ac08-b6179835da7c",
    "status": "completed"
}

Modified at 2026-10-11 10:38:12

Survey a resource erasure

List a resource's scrubbable fields