PHphilterd
Redaction Ledger

List redaction-ledger chains.

Changed on

Returns the head (genesis entry) of each redacted document's ledger chain, most recent first. Pass q to filter by document id or filename. Admins may list another user's chains by passing that user's username as owner, or every user's with all_users=true, which adds each chain's owner, cannot be combined with q, and requires ADMIN_CROSS_USER_ACCESS_ENABLED. Requires the ledger:read scope.

get/api/ledger

Request

  • Base URL
    / (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /api/ledger
  • Auth
    HTTP bearer

Query parameters

qstring
ownerstring
all_usersboolean
sortstring
orderstring
offsetinteger
limitinteger

Headers

Authorizationstring required

Response

Ledger chain heads; with all_users, each also names its owner.

totalinteger

Changes

  • 92f2a1031445Revision changes
    • info

      removed subschema #2 from the response body oneOf list for the response status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

  • d46712187c2fRevision changes
    • breaking

      the //// response's property format changed from int32 to int64 for status