Lightrun

Lightrun Public API

The Lightrun Public API is an HTTP REST API available from Lightrun Server 1.29, exposing 67 operations across 20 tag groups: actions (dynamic logs, snapshots, counters and metrics), agents and agent pools, tags and custom sources, debug cases and runbooks, Dynamic SBOM with loaded and watched packages, users and groups, just-in-time access, license, SMTP and identity-management configuration, and system API key management. Authentication is a bearer API token and every operation declares a required permission level of DEV, COMPANY, SECURITY or CROSS_COMPANY.

GitHub OpenAPI

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-openapi-original.json

Other Resources

🔗
Overlay
https://raw.githubusercontent.com/api-evangelist/lightrun/refs/heads/main/overlays/lightrun-public-api-overlay.yaml
🔗
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
🔗
APIsJSON
https://raw.githubusercontent.com/api-evangelist/lightrun/refs/heads/main/apis.yml

OpenAPI Specification

lightrun-openapi-original.json Raw ↑ 
{
  "openapi": "3.1.0",
  "info": {
    "description": "Lightrun API documentation",
    "title": "Lightrun API",
    "version": "v1"
  },
  "servers": [
    {
      "url": "http://localhost:8090",
      "description": "Generated server url"
    }
  ],
  "tags": [
    {
      "description": "Users API.",
      "name": "Users"
    },
    {
      "description": "User Groups API.",
      "name": "User Groups"
    },
    {
      "description": "Just-In-Time Access API.",
      "name": "Just-In-Time Access"
    },
    {
      "description": "Agent Pools API.",
      "name": "Agent Pools"
    },
    {
      "description": "Dynamic SBOM API.",
      "name": "Dynamic SBOM"
    },
    {
      "description": "Loaded packages API.",
      "name": "Loaded packages"
    },
    {
      "description": "Watched packages API.",
      "name": "Watched packages"
    },
    {
      "description": "Lightrun feature flags status API.",
      "name": "Lightrun feature flags status"
    },
    {
      "description": "Actions API.",
      "name": "Actions"
    },
    {
      "description": "Custom sources API.",
      "name": "Custom sources"
    },
    {
      "description": "Tags API.",
      "name": "Tags"
    },
    {
      "description": "Agents API.",
      "name": "Agents"
    },
    {
      "description": "SMTP connectivity configuration API",
      "name": "SMTP connectivity configuration"
    },
    {
      "description": "Company License API.",
      "name": "License"
    },
    {
      "description": "Debug Runbooks Configuration API.",
      "name": "Debug Runbooks Configuration"
    },
    {
      "description": "Debug Cases API.",
      "name": "Debug Cases"
    },
    {
      "description": "Debug Runbooks API.",
      "name": "Debug Runbooks"
    },
    {
      "description": "System access API key management API.",
      "name": "System access API key"
    },
    {
      "description": "Identity Management (IdM) configuration API",
      "name": "Identity Management (IdM) configuration"
    }
  ],
  "paths": {
    "/api/v1/access/company/{company}/system-api-key": {
      "get": {
        "description": "Get a listing of all system API keys for the specified company\n\n**Required API permission level:** `COMPANY`",
        "operationId": "getSystemApiKeyList",
        "parameters": [
          {
            "description": "The ID of the company for which to fetch the system API keys.",
            "in": "path",
            "name": "company",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SystemApiKeyListReadDTO"
                }
              }
            },
            "description": "List of system API keys"
          }
        },
        "security": [
          {
            "API Token": []
          }
        ],
        "summary": "Get all system API keys",
        "tags": [
          "System access API key"
        ]
      },
      "post": {
        "description": "Create a new system API key for the specified company\n\n**Required API permission level:** `COMPANY`",
        "operationId": "createSystemApiKey",
        "parameters": [
          {
            "description": "The ID of the company for which to add the system API keys.",
            "in": "path",
            "name": "company",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "description": "The expiration date of the system API key in days",
            "in": "query",
            "name": "expirationDays",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "description": "The label of the system API key",
            "in": "query",
            "name": "label",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "description": "List of scopes (COMPANY,ENVIRONMENT,APP_SEC). Defaults to all scopes if not provided.",
            "in": "query",
            "name": "scopes",
            "required": false,
            "schema": {
              "type": "array",
              "items": {
                "type": "string",
                "enum": [
                  "COMPANY",
                  "DEV",
                  "SECURITY",
                  "CROSS_COMPANY"
                ]
              },
              "uniqueItems": true
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SystemApiKeyValueDTO"
                }
              }
            },
            "description": "The newly created system API key"
          }
        },
        "security": [
          {
            "API Token": []
          }
        ],
        "summary": "Create a new system API key",
        "tags": [
          "System access API key"
        ]
      }
    },
    "/api/v1/access/company/{company}/system-api-key/{id}": {
      "put": {
        "description": "Update the label of a system API key for the specified company\n\n**Required API permission level:** `COMPANY`",
        "operationId": "updateSystemApiKeyLabel",
        "parameters": [
          {
            "description": "The ID of the company for which to update the system API keys.",
            "in": "path",
            "name": "company",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "description": "The ID of the system API key to update",
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/SystemApiKeyUpdateDTO"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SystemApiKeyStatusDTO"
                }
              }
            },
            "description": "The system API key label was updated successfully"
          }
        },
        "security": [
          {
            "API Token": []
          }
        ],
        "summary": "Update the label of a system API key",
        "tags": [
          "System access API key"
        ]
      },
      "delete": {
        "description": "Delete a system API key for the specified company\n\n**Required API permission level:** `COMPANY`",
        "operationId": "deleteSystemApiKey",
        "parameters": [
          {
            "description": "The ID of the company for which to delete the system API keys.",
            "in": "path",
            "name": "company",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "description": "The ID of the system API key to delete",
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SystemApiKeyStatusDTO"
                }
              }
            },
            "description": "The system API key was deleted successfully"
          }
        },
        "security": [
          {
            "API Token": []
          }
        ],
        "summary": "Delete a system API key",
        "tags": [
          "System access API key"
        ]
      }
    },
    "/api/v1/actions": {
      "get": {
        "description": "Get a list of actions.\n\n**Required API permission level:** `DEV`",
        "operationId": "listActions",
        "parameters": [
          {
            "description": "Filter actions by their type. Type can be any one of the enumerated values.",
            "in": "query",
            "name": "actionType",
            "required": false,
            "schema": {
              "type": "string",
              "enum": [
                "LOG",
                "SNAPSHOT",
                "COUNTER_METRIC",
                "TICTOC_METRIC",
                "CUSTOM_METRIC"
              ]
            }
          },
          {
            "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 actions created after the specified date. Date format is \u003cYYYY-MM-DD\u003e.",
            "in": "query",
            "name": "createdAtAfter",
            "required": false,
            "schema": {
              "type": "string",
              "format": "date"
            }
          },
          {
            "description": "Filter actions created before the specified date. Date format is \u003cYYYY-MM-DD\u003e. (UTC)",
            "in": "query",
            "name": "createdAtBefore",
            "required": false,
            "schema": {
              "type": "string",
              "format": "date"
            }
          },
          {
            "description": "Filter actions created by the specified user or API key. Users are identified by their email address.",
            "in": "query",
            "name": "createdBy",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "description": "Filter actions by their state. State can be either ‘true’ (enabled) or ‘false’ (disabled).",
            "in": "query",
            "name": "enabled",
            "required": false,
            "schema": {
              "type": "boolean"
            }
          },
          {
            "description": "Filter actions by their expiration state. Expiration state can be either ‘true’ (expired) or ‘false’ (disabled).",
            "in": "query",
            "name": "expired",
            "required": false,
            "schema": {
              "type": "boolean"
            }
          },
          {
            "description": "Filter actions by the file on which they were set. Files are indicated by their full path, as provided in the action’s creation. This filter supports * as a wildcard to match multiple file names with a common pattern.",
            "in": "query",
            "name": "filename",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "description": "Filter actions which have any errors. The flag can be either ‘true’ (with errors) or ‘false’ (without errors).",
            "in": "query",
            "name": "hasErrors",
            "required": false,
            "schema": {
              "type": "boolean"
            }
          },
          {
            "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": "Filter actions based on whether results have (true) or haven’t (false) been captured for them.",
            "in": "query",
            "name": "resultsExist",
            "required": false,
            "schema": {
              "type": "boolean"
            }
          },
          {
            "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\u003dfield1,asc\u0026sort\u003dfield2,desc). Sortable fields: location, line, createdAt.",
            "in": "query",
            "name": "sort",
            "required": false,
            "schema": {
              "type": "array",
              "items": {
                "type": "string"
              }
            }
          },
          {
            "description": "Filter actions by status. Status can be any one of the enumerated values.",
            "in": "query",
            "name": "status",
            "required": false,
            "schema": {
              "type": "string",
              "enum": [
                "SUBMITTED",
                "REQUESTED",
                "ACCEPTED"
              ]
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PublicApiPageActionSummaryPublicDTO"
                }
              }
            },
            "description": "OK"
          }
        },
        "security": [
          {
            "API Token": []
          }
        ],
        "summary": "Get a list of actions",
        "tags": [
          "Actions"
        ]
      }
    },
    "/api/v1/actions/logs": {
      "post": {
        "description": "Create a log action.\n\n**Required API permission level:** `DEV`",
        "operationId": "createLogAction",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/LogActionCreatePublicDTO"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ActionSummaryPublicDTO"
                }
              }
            },
            "description": "OK"
          }
        },
        "security": [
          {
            "API Token": []
          }
        ],
        "summary": "Create a log action",
        "tags": [
          "Actions"
        ]
      }
    },
    "/api/v1/actions/logs/{actionId}/messages": {
      "get": {
        "description": "Get list of agent log messages by action id.\n\n**Required API permission level:** `DEV`",
        "operationId": "getLogResults",
        "parameters": [
          {
            "description": "Log action ID.",
            "in": "path",
            "name": "actionId",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "description": "Filter logs by agent ID.",
            "in": "query",
            "name": "agentId",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "description": "Filter logs by agent name.",
            "in": "query",
            "name": "agentName",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "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 logs by free text found in log data or agent ID.",
            "in": "query",
            "name": "freeText",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "description": "Filter logs created from the specified timestamp in milliseconds since epoch.",
            "in": "query",
            "name": "from",
            "required": false,
            "schema": {
              "type": "integer",
              "format": "int64"
            }
          },
          {
            "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\u003dfield1,asc\u0026sort\u003dfield2,desc).",
            "in": "query",
            "name": "sort",
            "required": false,
            "schema": {
              "type": "array",
              "items": {
                "type": "string"
              }
            }
          },
          {
            "description": "Filter logs by agent tag.",
            "in": "query",
            "name": "tagName",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "description": "Filter logs created up to the specified timestamp in milliseconds since epoch.",
            "in": "query",
            "name": "to",
            "required": false,
            "schema": {
              "type": "integer",
              "format": "int64"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PublicApiPageLogDataPublicDTO"
                }
              }
            },
            "description": "Log messages retrieved."
          },
          "400": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PublicApiPageLogDataPublicDTO"
                }
              }
            },
            "description": "Invalid input."
          },
          "401": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PublicApiPageLogDataPublicDTO"
                }
              }
            },
            "description": "Unauthorized."
          }
        },
        "security": [
          {
            "API Token": []
          }
        ],
        "summary": "Get log messages",
        "tags": [
          "Actions"
        ]
      }
    },
    "/api/v1/actions/logs/{id}": {
      "get": {
        "description": "Get a log action by ID.\n\n**Required API permission level:** `DEV`",
        "operationId": "getLogAction",
        "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": "Log action ID.",
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LogActionPublicDTO"
                }
              }
            },
            "description": "OK"
          }
        },
        "security": [
          {
            "API Token": []
          }
        ],
        "summary": "Get a log action by ID",
        "tags": [
          "Actions"
        ]
      }
    },
    "/api/v1/actions/snapshots": {
      "post": {
        "description": "Create a snapshot action.\n\n**Required API permission level:** `DEV`",
        "operationId": "createSnapshotAction",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/SnapshotActionCreatePublicDTO"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ActionSummaryPublicDTO"
                }
              }
            },
            "description": "OK"
          }
        },
        "security": [
          {
            "API Token": []
          }
        ],
        "summary": "Create a snapshot action",
        "tags": [
          "Actions"
        ]
      }
    },
    "/api/v1/actions/snapshots/hit/{hitId}": {
      "get": {
        "description": "Get snapshot hit data by id\n\n**Required API permission level:** `DEV`",
        "operationId": "getSnapshotHitData",
        "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": "Hit ID.",
            "in": "path",
            "name": "hitId",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SnapshotHitDataPublicDTO"
                }
              }
            },
            "description": "Snapshot hit retrieved."
          },
          "400": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SnapshotHitDataPublicDTO"
                }
              }
            },
            "description": "Invalid input."
          },
          "401": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SnapshotHitDataPublicDTO"
                }
              }
            },
            "description": "Unauthorized."
          }
        },
        "security": [
          {
            "API Token": []
          }
        ],
        "summary": "Get snapshot hit data",
        "tags": [
          "Actions"
        ]
      }
    },
    "/api/v1/actions/snapshots/hits/{actionId}": {
      "get": {
        "description": "Get list of snapshot hits by action ID\n\n**Required API permission level:** `DEV`",
        "operationId": "getSnapshotActionHits",
        "parameters": [
          {
            "description": "Snapshot action ID.",
            "in": "path",
            "name": "actionId",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "description": "Filter snapshot hits by agent name.",
            "in": "query",
            "name": "agentName",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "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 snapshot hits created from the specified timestamp in milliseconds since epoch.",
            "in": "query",
            "name": "from",
            "required": false,
            "schema": {
              "type": "integer",
              "format": "int64"
            }
          },
          {
            "description": "Filter snapshot hits by agent tag.",
            "in": "query",
            "name": "tagName",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "description": "Filter snapshot hits created up to the specified timestamp in milliseconds since epoch.",
            "in": "query",
            "name": "to",
            "required": false,
            "schema": {
              "type": "integer",
              "format": "int64"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/SnapshotHitPublicDTO"
                  }
                }
              }
            },
            "description": "Snapshot hits retrieved."
          },
          "400": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/SnapshotHitPublicDTO"
                  }
                }
              }
            },
            "description": "Invalid input."
          },
          "401": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/SnapshotHitPublicDTO"
                  }
                }
              }
            },
            "description": "Unauthorized."
          }
        },
        "security": [
          {
            "API Token": []
          }
        ],
        "summary": "Get list of snapshot hits",
        "tags": [
          "Actions"
        ]
      }
    },
    "/api/v1/actions/snapshots/{id}": {
      "get": {
        "description": "Get a snapshot action by ID.\n\n**Required API permission level:** `DEV`",
        "operationId": "getSnapshotAction",
        "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": "Snapshot action ID.",
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SnapshotActionPublicDTO"
                }
              }
            },
            "description": "OK"
          }
        },
        "security": [
          {
            "API Token": []
          }
        ],
        "summary": "Get a snapshot action by ID",
        "tags": [
          "Actions"
        ]
      }
    },
    "/api/v1/actions/{id}": {
      "delete": {
        "description": "Delete an action.\n\n**Required API permission level:** `DEV`",
        "operationId": "deleteAction",
        "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": "Action-ID of the action to be deleted.",
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "204": {
            "description": "Action deleted."
          },
          "400": {
            "description": "Invalid input."
          },
          "401": {
            "description": "Unauthorized."
          },
          "404": {
            "description": "Action not found."
          }
        },
        "security": [
          {
            "API Token": []
          }
        ],
        "summary": "Delete an action",
        "tags": [
          "Actions"
        ]
      }
    },
    "/api/v1/agent-pools": {
      "get": {
        "description": "Get a list of all agent pools.\n\n**Required API permission level:** `DEV`",
        "operationId": "listAgentPools",
        "parameters": [
          {
            "description": "Filter agent pools by their name.",
            "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\u003dfield1,asc\u0026sort\u003dfield2,desc). Sortable fields: name, description, createdBy, createdDate, agentsEnabled.",
            "in": "query",
            "name": "sort",
            "required": false,
            "schema": {
              "type": "array",
              "items": {
                "type": "string"
              }
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PublicApiPageAgentPoolPublicApiDTO"
                }
              }
            },
            "description": "Retrieved all agent pools."
          }
        },
        "security": [
          {
            "API Token": []
          }
        ],
        "summary": "Get a list of agent pools",
        "tags": [
          "Agent Pools"
        ]
      },
      "post": {
        "description": "Create an agent pool.\n\n**Required API permission level:** `DEV`",
        "operationId": "createAgentPool",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/CreateOrUpdateAgentPoolPublicDto"
              }
            }
          },
          "required": true
        },
        "responses": {
          "201": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/AgentPoolPublicApiDTO"
                }
              }
            },
            "description": "Created."
          },
          "400": {
            "content":

# --- truncated at 32 KB (213 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/lightrun/refs/heads/main/openapi/lightrun-openapi-original.json