Lumin API

openapi: 3.1.0
info:
  title: Lumin API
  version: '2026-11-10'
  description: 'GENERATED FROM DOCUMENTATION by API Evangelist on 2026-11-10: 10 operation(s) read from 6 public documentation page(s) (each operation
    names its page in x-source). This is not the provider''s published contract; Lumin has published no machine-readable contract that the pipeline
    could find. Engine: local.'
  x-evidence-tiers:
    code-example: 1
    documentation: 9
    pages-with-code: 2
    pages-read: 6
  x-generated-from: documentation
  x-provenance: generated
  x-authored-by: API Evangelist
  x-generated: '2026-11-10'
  x-generator: generate-contract-from-docs.py
  x-engine: local
  x-sources:
  - https://docs.getlumin.dev/quickstart
  - https://docs.getlumin.dev/agent/security
  - https://docs.getlumin.dev/stacks/spring-boot
  - https://docs.getlumin.dev/stacks/fastapi
  - https://docs.getlumin.dev/stacks/axum
  - https://docs.getlumin.dev/concepts/metrics
servers:
- url: https://api.getlumin.dev
paths:
  /actuator/prometheus:
    get:
      operationId: get_actuator_prometheus
      tags:
      - Actuator
      summary: GET /actuator/prometheus
      x-source: https://docs.getlumin.dev/stacks/spring-boot
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl http://localhost:8080/actuator/prometheus should now return a few hundred lines including http_server_requests_seconds_count{…}\
          \ and http_server_requests_seconds_bucket{…} . The agent maps these to Lumin’s http.requests and http.latency_ms automatically when\
          \ the framework label is spring . \n How the mapping works Section titled “How the mapping works” \n Micrometer exposes no http_server_reques"
  /metrics:
    get:
      operationId: get_metrics
      tags:
      - Metrics
      summary: Emit Prometheus metrics
      x-source: https://docs.getlumin.dev/stacks/fastapi
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /v1.NN/containers/json:
    get:
      operationId: get_v1_NN_containers_json
      tags:
      - V1
      summary: The list of running containers
      x-source: https://docs.getlumin.dev/agent/security
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /v1.NN/containers/{id}/json:
    get:
      operationId: get_v1_NN_containers_id_json
      tags:
      - V1
      summary: The restart count and the start time (inspect)
      x-source: https://docs.getlumin.dev/agent/security
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /v1.NN/containers/{id}/logs:
    get:
      operationId: get_v1_NN_containers_id_logs
      tags:
      - V1
      summary: The log lines of a lumin.logs=true container
      x-source: https://docs.getlumin.dev/agent/security
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /v1.NN/containers/{id}/stats:
    get:
      operationId: get_v1_NN_containers_id_stats
      tags:
      - V1
      summary: CPU, memory, and network figures
      x-source: https://docs.getlumin.dev/agent/security
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /v1/agent/snapshot:
    post:
      operationId: post_v1_agent_snapshot
      tags:
      - Agent
      summary: Inject arbitrary host/container snapshots
      x-source: https://docs.getlumin.dev/agent/security
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /v1/events:
    post:
      operationId: post_v1_events
      tags:
      - Events
      summary: Inject arbitrary browser‑shaped events
      x-source: https://docs.getlumin.dev/agent/security
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /v1/logs:
    post:
      operationId: post_v1_logs
      tags:
      - Logs
      summary: It can POST /v1/logs , /v1/metrics , /v1/events , and /v1/agent/snapshot for this project only.
      x-source: https://docs.getlumin.dev/quickstart
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /v1/metrics:
    post:
      operationId: post_v1_metrics
      tags:
      - Metrics
      summary: Inject arbitrary metric points into that project
      x-source: https://docs.getlumin.dev/agent/security
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
tags:
- name: Actuator
- name: Agent
- name: Events
- name: Logs
- name: Metrics
- name: V1