Lightrun

Lightrun Agents API

Agents API.

GitHub OpenAPI

Operations 1

GET /api/v1/agents Get a list of agents #

Documentation

📖
Documentation
https://docs.lightrun.com/public-api/introduction/
📖
APIReference
https://docs.lightrun.com/public-api/api-reference/
📖
Authentication
https://raw.githubusercontent.com/api-evangelist/lightrun/refs/heads/main/authentication/lightrun-authentication.yml

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/lightrun/refs/heads/main/openapi/lightrun-agents-api-openapi.yml

Other Resources

🔗
OAuthScopes
https://raw.githubusercontent.com/api-evangelist/lightrun/refs/heads/main/scopes/lightrun-scopes.yml
🔗
ErrorCatalog
https://raw.githubusercontent.com/api-evangelist/lightrun/refs/heads/main/errors/lightrun-problem-types.yml
🔗
DataModel
https://raw.githubusercontent.com/api-evangelist/lightrun/refs/heads/main/data-model/lightrun-data-model.yml
🔗
Conventions
https://raw.githubusercontent.com/api-evangelist/lightrun/refs/heads/main/conventions/lightrun-conventions.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/lightrun-agents-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

lightrun-agents-api-openapi.yml Raw ↑ 
openapi: 3.2.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