Sign in
taps

Changed on

Lists all KegTaps in the system.

Reads follow site privacy; tap management (including the keg and hardware-connection operations below) requires an admin.

put/api/taps/{id}

Request

  • The document declares no server URL.
  • Auth: one of:
    • HTTP basic
    • API key in cookie sessionid

Path parameters

idinteger required

A unique integer value identifying this keg tap.

Request body

namestring required

The display name for this tap, for example, "Main Tap".

notesstring nullable

Private notes about this tap.

sort_orderinteger

Position relative to other taps when sorting (0=first).

Response

idinteger required
namestring required

The display name for this tap, for example, "Main Tap".

notesstring nullable

Private notes about this tap.

current_keg_idinteger required
temperature_sensor_idinteger required
sort_orderinteger

Position relative to other taps when sorting (0=first).

Changes

  • 8d1d025a79e9Revision changes
    • breaking

      the request property's minLength was increased from 0 to 1 (media type: application/json)

    • breaking

      the request property's minLength was increased from 0 to 1 (media type: application/x-www-form-urlencoded)

    • breaking

      the request property's minLength was increased from 0 to 1 (media type: multipart/form-data)

    • info

      removed the required write-only property current_keg/allOf[Keg]/beverage/allOf[Beverage]/producer_id from the response with the status