HTML

Update HTML page

Changed on

Replaces page content; requires the owner token returned at creation. Also accepts raw text/* (HTML, Markdown, YAML, XML, CSV, code) bodies — see /llms-full.txt.

put/api/html/{ns}/{id}

Request

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

Path parameters

nsstring required
idstring required

Query parameters

formatstring

Optional new content format on republish. Accepts 'html', 'markdown'/'md', or any code format (yaml, json, xml, csv, tsv, log, toml, ini, sql, sh, bat, env, javascript, typescript, tsx, jsx, css, properties, docker, txt). When omitted, the row's stored format is preserved. Body field 'format' on HtmlUpdateRequest takes precedence over the query param when both are present.

Headers

X-Owner-Tokenstring required

Owner token returned at creation. Required for update and delete

User-Agentstring

Request body

contentstring required

New HTML content to replace existing page

formatstring nullable

Optional new content format on republish. Accepts 'html', 'markdown'/'md', or any code format (yaml, json, xml, csv, tsv, log, toml, ini, sql, sh, bat, env, javascript, typescript, tsx, jsx, css, properties, docker, txt). When omitted, the row's stored format is preserved. Takes precedence over the 'format' query param when both are present.

Response

Page updated

idstring required
namespacestring required
linkstring required

Primary URL returned for browser viewing and sharing

ownerLinkstring required

API URL for programmatic access

expiresAtstring date-time required
sizeBytesinteger required
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.

deliveryModeReasonstring

Set as 'advisory:<codes>' when the updated page stays on a BrewPage link but uses browser features that may not work fully there. An update never changes the delivery mode. Codes are comma-separated in a fixed order: storage, cookies, history, downloads, top-navigation, media-capture, pointer-lock, embeds, fullscreen. Absent when nothing applies.

deliveryNoticestring

Human-readable explanation of deliveryModeReason. Absent whenever deliveryModeReason is absent.

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

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

    • info

      api operation id update_2 removed and replaced with update_1

    • info

      the endpoint scheme security OwnerToken was added to the API

    • info

      added the media type application/javascript to the request body

    • info

      added the media type application/toml to the request body

    • info

      added the media type application/x-yaml to the request body

    • info

      added the media type application/xml to the request body

    • info

      added the media type application/yaml to the request body

    • info

      added the media type text/css to the request body

    • info

      added the media type text/csv to the request body

    • info

      added the media type text/html to the request body

    • info

      added the media type text/javascript to the request body

    • info

      added the media type text/markdown to the request body

    • info

      added the media type text/plain to the request body

    • info

      added the media type text/x-toml to the request body

    • info

      added the media type text/xml to the request body

    • info

      added the media type text/yaml to the request body

    • 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

    • 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

    • 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

    • breaking

      the response property became nullable for the status

    • breaking

      added subschema #2 to the response property oneOf list for the response status

    • breaking

      added subschema #2 to the response property oneOf list for the response status

    • breaking

      added subschema #2 to the response property oneOf list for the response status

    • breaking

      the response's property type changed from object to no type for status

    • breaking

      the response's property type changed from object to no type for status

    • breaking

      the response's property type changed from object to no type for status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • info

      the request property became nullable