JSON

Create JSON document

Changed on

Stores any valid JSON and returns a shareable link. Reuse existing owner token to group entities under one owner

post/api/json

Request

  • Base URL: https://brewpage.app
  • URL: https://brewpage.app/api/json
  • 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.

Headers

X-Passwordstring

Access password; protected documents are unlisted. NEW browser links use trusted unlock; programmatic reads accept X-Password

X-Owner-Tokenstring

Reuse existing owner token to group entities under one owner. If omitted, a new token is generated

X-Delivery-Modestring

Delivery mode: path or subdomain; non-public namespaces require subdomain

Request body

unknown required

Response

Document created

idstring required

Unique 10-character alphanumeric document ID

namespacestring required
linkstring required

Primary URL returned for browser viewing and sharing

ownerLinkstring required

API URL for programmatic access (update/delete)

sizeBytesinteger required
expiresAtstring date-time required
createdAtstring date-time required
tagsstring[] required
ownerTokenstring required

Secret token required for update 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

      the request's body type changed from string to no type

    • 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

    • info

      api operation id create_1 removed and replaced with create

    • 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

  • 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