Lightrun Agents API

openapi: 3.1.0
info:
  description: Lightrun API documentation
  title: Lightrun Actions Agents API
  version: v1
servers:
- url: http://localhost:8090
  description: Generated server url
tags:
- description: Agents API.
  name: Agents
paths:
  /api/v1/agents:
    get:
      description: 'Get a list of agents.


        **Required API permission level:** `DEV`'
      operationId: listAgents
      parameters:
      - description: Agent pool ID. Mandatory when RBAC is enabled. Ignored when RBAC is disabled.
        in: query
        name: agentPoolId
        required: false
        schema:
          type: string
      - description: Filter agents by display name, host and process ID, or tag name. This filter supports the * wildcard to match multiple values with a common pattern.
        in: query
        name: name
        required: false
        schema:
          type: string
      - description: Specifies a zero-based index of the results page to retrieve. The default is 0 (the first page).
        in: query
        name: page
        required: false
        schema:
          type: integer
          default: 0
          minimum: 0
      - description: The number of items to include on each page of results. The default is 20.
        in: query
        name: size
        required: false
        schema:
          type: integer
          default: 20
          minimum: 1
      - description: The sorting criteria in the format property (asc|desc), with ascending as the default. Multiple sort parameters can be chained to define primary, secondary, and further sorting levels (e.g., sort=field1,asc&sort=field2,desc). Supports multiple criteria.
        in: query
        name: sort
        required: false
        schema:
          type: array
          items:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicApiPageAgentPublicDTO'
          description: Agents retrieved.
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicApiPageAgentPublicDTO'
          description: Invalid input.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicApiPageAgentPublicDTO'
          description: Unauthorized.
      security:
      - API Token: []
      summary: Get a list of agents
      tags:
      - Agents
components:
  schemas:
    AgentPublicDTO:
      type: object
      description: Agent
      properties:
        id:
          type: string
          format: uuid
          description: Agent ID.
        name:
          type: string
          description: Agent name.
        type:
          type: string
          description: Agent type.
          enum:
          - Java
          - Python
          - Node.js
          - .Net
          - Kotlin
          - Scala
        version:
          type: string
          description: Version.
        versionStatus:
          type: string
          description: Agent version status.
          enum:
          - Active
          - Expired
          - Expires soon
    PublicApiPageAgentPublicDTO:
      type: object
      properties:
        hasMore:
          type: boolean
        items:
          type: array
          items:
            $ref: '#/components/schemas/AgentPublicDTO'
        limit:
          type: integer
          format: int32
        offset:
          type: integer
          format: int64
        total:
          type: integer
          format: int64
  securitySchemes:
    API Token:
      scheme: bearer
      type: http