SolarWinds Query API

openapi: 3.1.0
info:
  title: SolarWinds Loggly Account Query API
  description: RESTful API for cloud-based log management including event submission, event retrieval, search, and account management. Supports sending events over HTTP/S and retrieving log data via paginating event retrieval endpoints.
  version: '2'
  contact:
    name: SolarWinds Support
    url: https://support.solarwinds.com
  termsOfService: https://www.solarwinds.com/legal/terms
servers:
- url: https://{subdomain}.loggly.com/apiv2
  description: Loggly API Server
  variables:
    subdomain:
      default: logs-01
      description: Your Loggly subdomain
security:
- bearerAuth: []
tags:
- name: Query
  description: Execute SWQL queries against the SolarWinds Information Service
paths:
  /Query:
    get:
      operationId: querySwis
      summary: Solarwinds Execute a Swql Query
      description: Executes a SolarWinds Query Language (SWQL) query against the SolarWinds Information Service and returns the results as JSON. SWQL is a read-only SQL-like language for querying monitored entities.
      tags:
      - Query
      parameters:
      - $ref: '#/components/parameters/SwqlQuery'
      - $ref: '#/components/parameters/SwqlParameters'
      responses:
        '200':
          description: Query executed successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/QueryResult'
              examples:
                Queryswis200Example:
                  summary: Default querySwis 200 response
                  x-microcks-default: true
                  value:
                    results:
                    - {}
        '400':
          description: Invalid SWQL query syntax
        '401':
          description: Authentication required
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    post:
      operationId: querySwisPost
      summary: Solarwinds Execute a Swql Query via Post
      description: Executes a SWQL query using a POST request body. Useful for longer queries that exceed URL length limits.
      tags:
      - Query
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/QueryRequest'
            examples:
              QueryswispostRequestExample:
                summary: Default querySwisPost request
                x-microcks-default: true
                value:
                  query: example_value
                  parameters: example_value
      responses:
        '200':
          description: Query executed successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/QueryResult'
              examples:
                Queryswispost200Example:
                  summary: Default querySwisPost 200 response
                  x-microcks-default: true
                  value:
                    results:
                    - {}
        '400':
          description: Invalid SWQL query syntax
        '401':
          description: Authentication required
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  parameters:
    SwqlQuery:
      name: query
      in: query
      required: true
      description: SWQL query string
      schema:
        type: string
      example: SELECT NodeID, Caption, IPAddress FROM Orion.Nodes
    SwqlParameters:
      name: parameters
      in: query
      required: false
      description: Parameterized query values
      schema:
        type: string
  schemas:
    QueryRequest:
      type: object
      required:
      - query
      properties:
        query:
          type: string
          description: SWQL query string to execute
          example: SELECT NodeID, Caption, IPAddress FROM Orion.Nodes WHERE Status = 1
        parameters:
          type: object
          description: Named parameters for parameterized queries
          additionalProperties: true
          example: example_value
    QueryResult:
      type: object
      properties:
        results:
          type: array
          description: Array of result rows
          items:
            type: object
            additionalProperties: true
          example: []
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: API token for authentication via Authorization Bearer header
    customerToken:
      type: apiKey
      in: path
      name: token
      description: Customer token for event submission endpoints
externalDocs:
  description: Loggly API Documentation
  url: https://documentation.solarwinds.com/en/success_center/loggly/content/admin/api-overview.htm