Windmill

Windmill service_logs API

The service_logs API from Windmill — 2 operation(s) for service_logs.

GitHub OpenAPI

Documentation

📖
Documentation
https://www.windmill.dev/docs/intro
📖
GettingStarted
https://www.windmill.dev/docs/getting_started/how_to_use_windmill
📖
Authentication
https://www.windmill.dev/docs/core_concepts/authentification

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/windmill/refs/heads/main/openapi/windmill-service-logs-api-openapi.yml

Other Resources

🔗
APIReferenceDocumentation
https://app.windmill.dev/openapi.html
🔗
HTTPRoutes
https://www.windmill.dev/docs/core_concepts/http_routing
🔗
CLI
https://www.windmill.dev/docs/advanced/cli
🔗
SelfHosting
https://www.windmill.dev/docs/advanced/self_host
🔗
TypeScriptSDK
https://www.windmill.dev/docs/advanced/clients/ts_client
🔗
PythonSDK
https://www.windmill.dev/docs/advanced/clients/python_client
🔗
SpectralRules
https://raw.githubusercontent.com/api-evangelist/windmill/refs/heads/main/rules/windmill-api-rules.yml

OpenAPI Specification

windmill-service-logs-api-openapi.yml Raw ↑ 
openapi: 3.0.3
info:
  version: 1.694.0
  title: Windmill admin service_logs API
  contact:
    name: Windmill Team
    email: contact@windmill.dev
    url: https://windmill.dev
  license:
    name: Apache 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0.html
  x-logo:
    url: https://windmill.dev/img/windmill.svg
servers:
- url: /api
security:
- bearerAuth: []
- cookieAuth: []
tags:
- name: service_logs
paths:
  /service_logs/list_files:
    get:
      summary: List Log Files Ordered by Timestamp
      operationId: listLogFiles
      tags:
      - service_logs
      parameters:
      - $ref: '#/components/parameters/Before'
      - $ref: '#/components/parameters/After'
      - name: with_error
        in: query
        required: false
        schema:
          type: boolean
      responses:
        '200':
          description: time
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  properties:
                    hostname:
                      type: string
                    mode:
                      type: string
                    worker_group:
                      type: string
                    log_ts:
                      type: string
                      format: date-time
                    file_path:
                      type: string
                    ok_lines:
                      type: integer
                    err_lines:
                      type: integer
                    json_fmt:
                      type: boolean
                  required:
                  - hostname
                  - mode
                  - log_ts
                  - file_path
                  - json_fmt
  /service_logs/get_log_file/{path}:
    get:
      summary: Get Log File by Path
      operationId: getLogFile
      tags:
      - service_logs
      parameters:
      - $ref: '#/components/parameters/Path'
      responses:
        '200':
          description: log stream
          content:
            text/plain:
              schema:
                type: string
components:
  parameters:
    Path:
      name: path
      in: path
      required: true
      schema:
        type: string
    After:
      name: after
      description: filter on created after (exclusive) timestamp
      in: query
      schema:
        type: string
        format: date-time
    Before:
      name: before
      description: filter on started before (inclusive) timestamp
      in: query
      schema:
        type: string
        format: date-time
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
    cookieAuth:
      type: apiKey
      in: cookie
      name: token
externalDocs:
  description: documentation portal
  url: https://windmill.dev