Sites

Upload site

Changed on

Upload a multi-file HTML site as a ZIP archive or as individual files with paths. Returns a link to the published site

post/api/sites

Request

  • Base URL: https://brewpage.app
  • URL: https://brewpage.app/api/sites
  • Auth: one of:
    • none
    • API key in header X-Owner-Token

Query parameters

nsstring

Namespace (default public). Custom namespaces are unlisted, accessible to anyone with the URL. Public discovery additionally requires eligibility and no password.

tagsstring

Comma-separated tags

ttlstring

TTL in integer days (1-30); accepts 15, 15d, 15 day or 15 days, case-insensitive. Omitted or blank uses 15 days.

entrystring

Entry file path override (default: auto-detect index.html)

Headers

X-Passwordstring

Access password

X-Owner-Tokenstring

Reuse existing owner token to group entities under one owner

User-Agentstring
X-Delivery-Modestring

Response

Site uploaded

idstring required

Unique 10-character alphanumeric site ID

namespacestring required
entryFilestring required

Entry HTML file resolved from the upload (e.g. index.html)

linkstring required

Primary URL returned for browser viewing and sharing

ownerLinkstring required

API URL for programmatic access (info, delete)

fileCountinteger required
totalSizeBytesinteger required
expiresAtstring date-time required
tagsstring[] required
ownerTokenstring required

Secret token required for info and delete operations. Store it safely -- cannot be recovered

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

      request body became required

    • breaking

      removed the media type application/json from the request body

    • breaking

      added the pattern ^\s*(?:\d+\s*(?:[dD]|[dD][aA][yY][sS]?)?)?\s*$ to the query request parameter ttl

    • 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

    • warning

      deleted the query request parameter files

    • warning

      deleted the query request parameter paths

    • info

      api operation id upload removed and replaced with uploadSite

    • info

      the endpoint scheme security OwnerToken was added to the API

    • info

      added the media type multipart/form-data 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

    • 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

    • 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

      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

    • 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

    • 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