PHphilterd
Always/Never Redact Lists

Replace one redact list.

Changed on

Replaces one list, always or never, in full with the terms in the body, leaving the other list as it is, and moves it to its next revision. Send the revision you read in If-Match, quoted as the ETag gives it, so the write is refused with 409 and reason redact_list_changed if someone changed the list since; without If-Match the list is replaced whatever its revision. Terms are trimmed and blank entries are dropped. The list may contain up to 1000 terms, and each term may be up to 100 characters. Admins may replace another user's list by passing that user's username as owner. Requires the lists:write scope.

put/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
If-Matchstring

Request body

termsstring[]

The list's complete contents. An empty array or an omitted field clears the list.

Response

The list was replaced. The body and the ETag header give its new 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