Redaction & Deletion API

Schemas

RedactRequest

isRedactedboolean · required
true redacts, false un-redacts

cidstring
One declaration id (cidV1, lowercase base32). Mutually exclusive with cids.
cidsstring[] · minItems: 1 · maxItems: 500
Up to 500 declaration ids for an asynchronous batch (202).
reasonstring · maxLength: 500

RedactResult

cidstring
okboolean
changedboolean
false when the declaration already was in the requested state
isRedactedboolean
everRedactedboolean
true once the CID has been redacted at least once; it stays in the index afterwards
versioninteger
pageinteger
Page of the redaction index holding the entry
declarerIdstring
effectsobject
What each downstream store reported

BatchAccepted

jobIdstring · uuid
statusstring · enum
Enum values:
queued
typestring · enum
Enum values:
redact
unredact
totalinteger
duplicatesDroppedinteger
statusPathstring

JobResult

cidstring
okboolean
changedboolean
statusstring
Resulting state, or the failure reason (not_found, forbidden, deleted, invalid_cid, error)
errorstring

RedactionJob

jobIdstring · uuid
typestring · enum
Enum values:
redact
unredact
statusstring · enum
Enum values:
queued
running
done
failed
totalinteger
processedinteger
succeededinteger
unchangedinteger
failedinteger
resultsobject[]
declarerIdstring
createdAtinteger
Unix time in milliseconds
startedAtinteger
finishedAtinteger

DeleteRequest

cidstring · required
Declaration id (cidV1). An ISCC is rejected.

reasonstring · maxLength: 500
recursiveboolean
Administrators only: delete every declaration on the CID's supersedes chain.
Default: false

DeleteResult

cidstring
okboolean
changedboolean
false when the CID was already deleted
markerobject
Public deletion marker. Contains no original metadata and no personal information.
declarerIdstring
effectsobject
What each store reported: snapshot, marker, index, stats, iroh, rows, s3Versions

ChainDeleteResult

rootstring
The requested CID
recursiveboolean · enum
Enum values:
chainobject[]
Chain members, oldest first
resultsobject[]
One result per chain member, same order
deletedinteger
Members deleted by this call
alreadyDeletedinteger
Members that already carried a marker
failedinteger
Members that could not be deleted; their result carries code and error
actorobject
versionstring

DeletionMarker

cidstring · required
statusstring · enum · required
Enum values:
deleted
deletedAtstring · date-time · required

isccstring
authorizedByobject
supersedesstring
CID of the declaration this one superseded, when part of a chain
supersededBystring
CID of the declaration that superseded this one, when part of a chain

RedactionStatus

cidstring
statusstring · enum
Enum values:
active
redacted
deleted
unknown
existsboolean
true when the declaration is in active storage
indexobject
markerobject
Public deletion marker. Contains no original metadata and no personal information.
verifyobject
Only with ?verify=1

RedactedIndexEntry

cidstring
redactedboolean
deletedboolean
versioninteger
declarerIdstring
redactedAtinteger
updatedAtinteger
deletedAtinteger

RedactedIndexPage

pageinteger
pageSizeinteger
totalPagesinteger
totalEntriesinteger
redactedEntriesinteger
Entries currently redacted
deletedEntriesinteger
entriesobject[]
pagesobject[]
All pages; present only while fewer than 1000 entries exist
allobject[]
Flat list of every entry; present only while fewer than 1000 entries exist

Additional properties are allowed

RedactionStats

daysinteger
totalsobject
byDeclarerobject[]
perDayobject[]
recentEventsobject[]
jobsobject[]
markersobject[]

Additional properties are allowed

ErrorResponse

errorstring
messagestring
codestring
Machine-readable reason, e.g. invalid_cid, forbidden, not_found, deleted

ChainMember

cidstring
statestring · enum
State before this call
Enum values:
active
deleted
declarerIdstring