KV

Upsert key

Changed on

Creates or updates a key in the store; max 1000 keys per store

put/api/kv/{ns}/{id}/{key}

Request

  • Base URL: https://brewpage.app
  • URL: https://brewpage.app/api/kv/{ns}/{id}/{key}
  • Auth: API key in header X-Owner-Token

Path parameters

nsstring required
idstring required
keystring required

Headers

X-Owner-Tokenstring required

Owner token returned at creation. Required for update and delete

X-Delivery-Modestring

Request body

valuestring required

New value for the key (max 1 MB)

Response

Key upserted

idstring required
namespacestring required
keystring required
sizeBytesinteger required
linkstring required

Primary URL returned for browser viewing and sharing of this key

ownerLinkstring required

API URL for programmatic access

visibilityNoticestring

Human-readable explanation of link access and conditional public-discovery eligibility. Unlisted links are not secret; password protection applies when configured. No guarantee of listing, ranking or search-engine indexing.

managementLinkstring nullable required
routingCohortstring required
deliveryModestring nullable required
requestedDeliveryModestring nullable required
effectiveDeliveryModestring nullable required
deliveryModeMatchedboolean nullable required
accessstring required
modeLockedboolean required
hostingVersioninteger nullable required

Changes

  • 10dfacb13d63Revision changes
    • breaking

      the request property became required

    • breaking

      removed the media type */* for the response with the status

    • breaking

      removed the media type */* for the response with the status

    • breaking

      removed the media type */* for the response with the status

    • breaking

      removed the media type */* for the response with the status

    • info

      the endpoint scheme security OwnerToken was added to the API

    • info

      added the media type application/json for the response with the status

    • info

      added the media type application/json for the response with the status

    • info

      added the media type application/json for the response with the status

    • info

      added the media type application/json for the response with the status

  • 753c148646ceRevision changes
    • breaking

      the response property became nullable for the status

    • breaking

      the response property became nullable for the status

    • breaking

      the response property became nullable for the status

    • breaking

      the response property became nullable for the status