Get an erasure

GET

/v1/memory/erasures/{erasureId}

curl --request GET \
  --url https://example.com/v1/memory/erasures/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'Authorization: Bearer <token>'

• Same-origin — path relative to the deployment root.

One erasure: its status (pending, running, completed, failed), phase, what each store cleared (counts), and lastError (a code, or not-yet:<reason> while it waits for a run to finish). Requires admin on the tenant.

Authorizations

• bearerAuth

Parameters

Path Parameters

erasureId

required

string format: uuid

The erasure (a UUID).

Responses

200

The erasure.

Media typeapplication/json

object

id

required

string format: uuid

selectorKind

required

string

Allowed values: fact participant external conversation

selector

One of:

object

One fact.

object

factId

required

string

>= 1 characters <= 256 characters

object

A person: an app’s end user (participant), or an external subject facts name. Erasing a Kindgi user isn’t offered.

object

subject

required

object

kind

required

string

Allowed values: participant external

id

required

string

>= 1 characters <= 256 characters

object

One conversation.

object

conversationId

required

string

>= 1 characters <= 256 characters

status

required

waiting-on-run: a turn of the person’s sits in a flow that serves other people; the erasure waits for it (waitingOn) until its deadline, then cancels it.

string

Allowed values: pending running waiting-on-run completed failed

phase

required

Where a running erasure is: seed, expand, settle (the person’s unfinished runs end, or it waits for them, before anything is cleared), erase, then done.

string

Allowed values: seed expand settle erase done

requestedBy

required

user:<id> or service:<id>.

string

matchable

required

A replay after a backup restore can find this person again: a keyed hash was kept.

boolean

counts

required

What each store cleared or deleted, by store.

object

key

additional properties

integer

attempts

required

Failed attempts so far.

integer

lastError

The last failure’s code, or not-yet:<reason> while it waits. Never content.

string

waitingOn

The run it waits (or waited) for, and until when; kept as the record of the wait.

object

runId

required

string format: uuid

until

string format: date-time

forced

A tenant admin said not to wait.

boolean

settleRoundsCapped

Runs of the person’s kept appearing, round after round: the erasure went on to erase after its last round rather than wait any longer. Absent: it didn’t.

boolean

createdAt

required

string format: date-time

startedAt

string format: date-time

completedAt

string format: date-time

replayedAt

string format: date-time

Example

{
  "selectorKind": "fact",
  "selector": {
    "subject": {
      "kind": "participant"
    }
  },
  "status": "pending",
  "phase": "seed",
  "forced": true,
  "settleRoundsCapped": true
}

401

Missing / malformed / expired / revoked bearer token.

Media typeapplication/json

object

error

required

object

code

required

Stable machine-readable discriminant. Values match domain error codes (see docs/API-ROUTE-CONVENTIONS.md §4.3).

string

message

required

string

details

Optional, kind-specific.

object

key

additional properties

any

requestId

required

Server-assigned request id; also echoed via X-Request-Id header.

string

Example^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "details": {},
    "requestId": "example"
  }
}

403

Not a tenant admin.

Media typeapplication/json

object

error

required

object

code

required

Stable machine-readable discriminant. Values match domain error codes (see docs/API-ROUTE-CONVENTIONS.md §4.3).

string

message

required

string

details

Optional, kind-specific.

object

key

additional properties

any

requestId

required

Server-assigned request id; also echoed via X-Request-Id header.

string

Example^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "details": {},
    "requestId": "example"
  }
}

404

No such erasure in this tenant.

Media typeapplication/json

object

error

required

object

code

required

Stable machine-readable discriminant. Values match domain error codes (see docs/API-ROUTE-CONVENTIONS.md §4.3).

string

message

required

string

details

Optional, kind-specific.

object

key

additional properties

any

requestId

required

Server-assigned request id; also echoed via X-Request-Id header.

string

Example^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "details": {},
    "requestId": "example"
  }
}