mailbox.org API

openapi: 3.1.0
info:
  title: mailbox.org API
  version: '2026-10-27'
  description: 'GENERATED FROM DOCUMENTATION by API Evangelist on 2026-10-27: 4 operation(s) read from 2 public documentation page(s) (each operation
    names its page in x-source). This is not the provider''s published contract; mailbox.org has published no machine-readable contract that the
    pipeline could find. Engine: local.'
  x-evidence-tiers:
    code-example: 4
    documentation: 0
    pages-with-code: 2
    pages-read: 2
  x-generated-from: documentation
  x-provenance: generated
  x-authored-by: API Evangelist
  x-generated: '2026-10-27'
  x-generator: generate-contract-from-docs.py
  x-engine: local
  x-sources:
  - https://api.mailbox.org/v1/doc/welcome/API-Key-Authentication.html
  - https://api.mailbox.org/v1/doc/welcome/mailbox-CLI.html
paths:
  /v1:
    post:
      operationId: post_v1
      tags:
      - Api
      summary: POST /v1
      x-source: https://api.mailbox.org/v1/doc/welcome/API-Key-Authentication.html
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostV1Request'
      responses:
        '201':
          description: Success (shape read from the example response on the page)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostV1Response'
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl -s https://api.mailbox.org/v1/  -H 'Content-Type: application/json'  -H \"X-Api-Key: $(cat ./customer.apikey)\"  -d '{\"\
          jsonrpc\":\"2.0\",\"method\":\"hello.innerworld\",\"params\":{},\"id\":\"1\"}' \n Do not send the HPLS-AUTH header in the same request:\
          \ if\nit is present, the Auth-ID is used and the API key is ignored. \n The mailbox CLI sends this header\nautomatically. \n Errors\
          \ \n If the API key is unknown, e"
  /v1/cli/install.sh:
    get:
      operationId: get_v1_cli_install_sh
      tags:
      - Cli
      summary: GET /v1/cli/install.sh
      x-source: https://api.mailbox.org/v1/doc/welcome/mailbox-CLI.html
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl -fsSL https://api.mailbox.org/v1/cli/install.sh | sh \n Windows (PowerShell) (installs to\n %LOCALAPPDATA%\\Programs\\\
          mailbox and adds it to your user\n PATH ; open a new shell afterwards): \n irm https://api.mailbox.org/v1/cli/install.ps1 | iex \n Alternatively,\
          \ download the binary for your platform directly from\n https://api.mailbox.org/v1/cli/latest/: \n Linux (x86_64): mailbox-linux-amd64\
          \ \n Linux"
  /v1/cli/latest/checksums.txt:
    get:
      operationId: get_v1_cli_latest_checksums_txt
      tags:
      - Cli
      summary: GET /v1/cli/latest/checksums.txt
      x-source: https://api.mailbox.org/v1/doc/welcome/mailbox-CLI.html
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl -fLO https://api.mailbox.org/v1/cli/latest/checksums.txt\nsha256sum --ignore-missing -c checksums.txt # must print \"mailbox-linux-amd64:\
          \ OK\"\nmv mailbox-linux-amd64 mailbox && chmod +x mailbox\n./mailbox --help \n On macOS, verify with shasum -a 256 --ignore-missing\
          \ -c checksums.txt .\nOn Windows (PowerShell), compare the output of\n (Get-FileHash .\\mailbox-windows-amd64.exe -Algorithm SHA256).Hash"
  /v1/cli/latest/mailbox-linux-amd64:
    get:
      operationId: get_v1_cli_latest_mailbox_linux_amd64
      tags:
      - Cli
      summary: GET /v1/cli/latest/mailbox-linux-amd64
      x-source: https://api.mailbox.org/v1/doc/welcome/mailbox-CLI.html
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: curl -fLO https://api.mailbox.org/v1/cli/latest/mailbox-linux-amd64
components:
  schemas:
    PostV1Request:
      type: object
      properties:
        jsonrpc:
          type: string
        method:
          type: string
        params:
          type: object
        id:
          type: string
    PostV1Response:
      type: object
      properties:
        jsonrpc:
          type: string
        error:
          type: object
          properties:
            code:
              type: integer
            message:
              type: string
        id:
          type: string
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: X-Api-Key
security:
- apiKey: []
tags:
- name: Api
- name: Cli