openapi: 3.0.3
info:
  title: HTTP Toolkit client server API
  description: 'The backend REST API exposed by the HTTP Toolkit server, used to start and manage the local HTTP/HTTPS proxy, launch intercepted applications, manage interception rules, handle certificate operations, and send requests through the proxy. The server listens on localhost (default port 45456) and uses token-based authentication via the Authorization header.

    '
  version: 1.0.0
  contact:
    name: HTTP Toolkit
    url: https://httptoolkit.com
  license:
    name: Apache 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0
servers:
- url: http://localhost:45456
  description: Local HTTP Toolkit server (default port)
security:
- bearerAuth: []
tags:
- name: server
  description: Server lifecycle and version management
paths:
  /version:
    get:
      summary: Get server version
      description: Returns the current version of the HTTP Toolkit server.
      operationId: getVersion
      tags:
      - server
      responses:
        '200':
          description: Server version information
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VersionResponse'
              example:
                version: 1.3.2
  /update:
    post:
      summary: Trigger server update
      description: Initiates a server self-update process.
      operationId: updateServer
      tags:
      - server
      responses:
        '200':
          description: Update triggered successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuccessResponse'
              example:
                success: true
  /shutdown:
    post:
      summary: Shutdown the server
      description: Shuts down the HTTP Toolkit server process.
      operationId: shutdownServer
      tags:
      - server
      responses:
        '200':
          description: Shutdown initiated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuccessResponse'
              example:
                success: true
components:
  schemas:
    SuccessResponse:
      type: object
      required:
      - success
      properties:
        success:
          type: boolean
          description: Whether the operation succeeded
          example: true
    VersionResponse:
      type: object
      required:
      - version
      properties:
        version:
          type: string
          description: Semantic version string of the HTTP Toolkit server
          example: 1.3.2
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: Token-based authentication using a server-generated bearer token