Komodo API

openapi: 3.1.0
info:
  title: Komodo API
  version: '2026-10-28'
  description: 'GENERATED FROM DOCUMENTATION by API Evangelist on 2026-10-28: 8 operation(s) read from 4 public documentation page(s) (each operation
    names its page in x-source). This is not the provider''s published contract; Komodo has published no machine-readable contract that the pipeline
    could find. Engine: local.'
  x-evidence-tiers:
    code-example: 3
    documentation: 5
    pages-with-code: 4
    pages-read: 4
  x-generated-from: documentation
  x-provenance: generated
  x-authored-by: API Evangelist
  x-generated: '2026-10-28'
  x-generator: generate-contract-from-docs.py
  x-engine: local
  x-sources:
  - https://komo.do/docs/ecosystem/cli
  - https://komo.do/docs/build
  - https://komo.do/docs/setup/connect-servers
  - https://docs.rs/komodo_client/latest/komodo_client/api/index.html
paths:
  /auth:
    post:
      operationId: post_auth
      tags:
      - Auth
      summary: Komodo Core API
      x-source: https://docs.rs/komodo_client/latest/komodo_client/api/index.html
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /execute:
    post:
      operationId: post_execute
      tags:
      - Execute
      summary: Komodo Core API
      x-source: https://docs.rs/komodo_client/latest/komodo_client/api/index.html
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /moghtech/komodo/main/scripts/install-cli.py:
    get:
      operationId: get_moghtech_komodo_main_scripts_install_cli_py
      tags:
      - Moghtech
      summary: GET /moghtech/komodo/main/scripts/install-cli.py
      x-source: https://komo.do/docs/ecosystem/cli
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl -sSL https://raw.githubusercontent.com/moghtech/komodo/main/scripts/install-cli.py | python3 \n Or as non-root, to ${HOME}/.local/bin/km\
          \ : "
  /moghtech/komodo/main/scripts/setup-periphery.py:
    get:
      operationId: get_moghtech_komodo_main_scripts_setup_periphery_py
      tags:
      - Moghtech
      summary: GET /moghtech/komodo/main/scripts/setup-periphery.py
      x-source: https://komo.do/docs/build
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl -sSL \\ https://raw.githubusercontent.com/moghtech/komodo/main/scripts/setup-periphery.py | \\ HOME=/root python3 - --version=v2.X.X\
          \ \"\"\" \n To create the AMI: \n Launch an EC2 instance and install Docker: \n apt update && apt upgrade -y curl -fsSL https://get.docker.com\
          \ | sh systemctl enable docker.service containerd.service \n Create an AMI from the instance in the AWS console. \n Create a security"
  /read:
    post:
      operationId: post_read
      tags:
      - Read
      summary: Komodo Core API
      x-source: https://docs.rs/komodo_client/latest/komodo_client/api/index.html
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /user:
    post:
      operationId: post_user
      tags:
      - User
      summary: Komodo Core API
      x-source: https://docs.rs/komodo_client/latest/komodo_client/api/index.html
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /write:
    post:
      operationId: post_write
      tags:
      - Write
      summary: Komodo Core API
      x-source: https://docs.rs/komodo_client/latest/komodo_client/api/index.html
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /write/UpdateBuild:
    post:
      operationId: post_write_UpdateBuild
      tags:
      - Write
      summary: POST /write/UpdateBuild
      x-source: https://docs.rs/komodo_client/latest/komodo_client/api/index.html
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostWriteUpdatebuildRequest'
      responses:
        '201':
          description: Success (shape read from the example response on the page)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostWriteUpdatebuildResponse'
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl --header \"Content-Type: application/json\"  --header \"X-Api-Key: your_api_key\"  --header \"X-Api-Secret: your_api_secret\"\
          \  --data '{ \"id\": \"my-build\", \"config\": { \"version\": \"2.0.0\" } }'  https://komodo.example.com/write/UpdateBuild § Modules\
          \ \n auth : Requests relating to logging in / obtaining authentication tokens. \n read : Read only requests which retrieve data from\
          \ Komodo. \n execute : Run a"
components:
  schemas:
    PostWriteUpdatebuildRequest:
      type: object
      properties:
        id:
          type: string
        config:
          type: object
          properties:
            version:
              type: string
    PostWriteUpdatebuildResponse:
      type: object
      properties:
        error:
          type: string
        trace:
          type: array
          items:
            type: string
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: X-Api-Key
security:
- apiKey: []
tags:
- name: Auth
- name: Execute
- name: Moghtech
- name: Read
- name: User
- name: Write