BrewPage Reports API

openapi: 3.2.0
info:
  title: BrewPage Reports API
  description: Free instant hosting for HTML, Markdown, JSON, key-value stores, files and sites. REST omission defaults to the public namespace; MCP omission creates an unlisted namespace. Unlisted URLs are accessible to anyone with the link; use a password for access restrictions. Retain returned links and ownership tokens. Public discovery requires eligibility; protected and non-public publications are excluded.
  termsOfService: https://brewpage.app/terms
  contact:
    name: BrewPage
    url: https://brewpage.app
  license:
    name: Apache-2.0
    url: https://www.apache.org/licenses/LICENSE-2.0
  version: 1.112.0
servers:
- url: https://brewpage.app
  description: Generated server url
tags:
- name: Reports
  description: Abuse reports for hosted content
paths:
  /api/reports:
    post:
      tags:
      - Reports
      summary: Submit abuse report
      description: Records a public report about a resource hosted on brewpage.app for moderator review
      operationId: submitReport
      parameters:
      - name: User-Agent
        in: header
        required: false
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ReportRequest'
        required: true
      responses:
        '201':
          description: Report accepted
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReportResponse'
        '400':
          description: Invalid request parameters
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
components:
  schemas:
    ErrorResponse:
      type: object
      properties:
        status:
          type: integer
          format: int32
        error:
          type: string
        message:
          type: string
        timestamp:
          type: string
          format: date-time
        supportedTypes:
          type: array
          items:
            type: string
        retryAfterSeconds:
          type: integer
          format: int64
        limit:
          type: integer
          format: int32
        result:
          oneOf:
          - $ref: '#/components/schemas/AbuseResult'
        code:
          type: string
      required:
      - error
      - message
      - status
      - timestamp
    AbuseResult:
      type: object
      properties:
        code:
          type: string
          enum:
          - success
          - duplicate
          - warned
          - failed
        action:
          type: string
          enum:
          - created
          - created_missing_assets
          - updated
          - merged
          - created_warned
          - unavailable
          - rate_limited
          - rejected
        reason:
          type: string
        extras:
          type: object
          additionalProperties: {}
      required:
      - action
      - code
    ReportResponse:
      type: object
      properties:
        reportId:
          type: string
          description: Unique 10-character alphanumeric report ID
        receivedAt:
          type: string
          format: date-time
          description: Server timestamp when the report was accepted
    ReportRequest:
      type: object
      properties:
        reportedUrl:
          type: string
          description: Full URL of the reported resource on brewpage.app or brewdata.app
        category:
          type: string
          description: Abuse category
          enum:
          - cannot_delete
          - spam
          - phishing
          - malware
          - copyright
          - harassment
          - illegal
          - other
        description:
          type: string
          description: Reporter description (10..5000 chars)
        reporterEmail:
          type:
          - string
          - 'null'
          description: Optional reporter email for follow-up
        resourceNamespace:
          type:
          - string
          - 'null'
          description: Optional namespace of the reported resource (e.g. 'public'). When supplied with resourceId takes priority over URL parsing.
        resourceId:
          type:
          - string
          - 'null'
          description: Optional 10-character short ID of the reported resource. When supplied with resourceNamespace takes priority over URL parsing.
  securitySchemes:
    OwnerToken:
      type: apiKey
      name: X-Owner-Token
      in: header
    Password:
      type: apiKey
      name: X-Password
      in: header
externalDocs:
  description: BrewPage API documentation (Scalar)
  url: https://kochetkov-ma.github.io/brewpage-openapi/
x-provenance:
  method: harvested
  publisher: BrewPage
  source: https://brewpage.app/v3/api-docs
  note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
    stamped by stamp-openapi-provenance.py (roadmap#793)