SolarWinds Query API

openapi: 3.2.0
info:
  title: SolarWinds Orion Platform Query API
  description: RESTful API for managing and monitoring network devices, servers, and applications through the SolarWinds Orion Platform. Provides access to the SolarWinds Information Service (SWIS) using SWQL queries and CRUD operations on monitored entities via REST/JSON endpoints.
  version: '3'
  contact:
    name: SolarWinds Support
    url: https://support.solarwinds.com
  termsOfService: https://www.solarwinds.com/legal/terms
servers:
- url: https://{orion-server}:17774/SolarWinds/InformationService/v3/Json
  description: Orion Platform Server (port 17774 since 2023.1 release)
  variables:
    orion-server:
      default: localhost
      description: Hostname or IP of your Orion server
security:
- basicAuth: []
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:
    SwqlParameters:
      name: parameters
      in: query
      required: false
      description: Parameterized query values
      schema:
        type: string
    SwqlQuery:
      name: query
      in: query
      required: true
      description: SWQL query string
      schema:
        type: string
      example: SELECT NodeID, Caption, IPAddress FROM Orion.Nodes
  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:
    basicAuth:
      type: http
      scheme: basic
      description: HTTP Basic authentication using Orion Platform credentials
externalDocs:
  description: SolarWinds Orion Platform API Documentation
  url: https://documentation.solarwinds.com/en/success_center/orionplatform/content/core-swis-api.htm