PHphilterd
Always/Never Redact Lists

Get one redact list.

Changed on

Returns one list, always or never, and its revision. The ETag header carries the revision too, quoted. Send it back in If-Match when replacing the list with PUT /api/redact-lists/{list}. A list never written is empty, at revision 0. Admins may read another user's list by passing that user's username as owner. Requires the lists:read scope.

get/api/redact-lists/{list}

Request

  • Base URL
    / (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /api/redact-lists/{list}
  • Auth
    HTTP bearer

Path parameters

liststring required

Query parameters

ownerstring

Headers

Authorizationstring required

Response

The list and its revision.

revisioninteger

The list's revision, which every write of the list increments. Send it back in If-Match when replacing the list so the write is refused if someone changed the list since. A list never written is at 0. The ETag header carries the same value.

termsstring[]

The list's terms. A list with no saved terms is an empty array.

Changes

  • c4f85daa9208Revision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

  • 56b4fb403d21Revision changes
    • info

      endpoint added