SolarWinds CRUD API

openapi: 3.2.0
info:
  title: SolarWinds Orion Platform CRUD 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: CRUD
  description: Create, read, update, and delete operations on SWIS entities
paths:
  /Create/{entityType}:
    post:
      operationId: createEntity
      summary: Solarwinds Create a New Swis Entity
      description: Creates a new entity of the specified type in the SolarWinds Information Service. The request body contains the property values for the new entity.
      tags:
      - CRUD
      parameters:
      - $ref: '#/components/parameters/EntityType'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              additionalProperties: true
            examples:
              CreateentityRequestExample:
                summary: Default createEntity request
                x-microcks-default: true
                value: {}
      responses:
        '200':
          description: Entity created successfully
          content:
            application/json:
              schema:
                type: string
                description: URI of the newly created entity
              examples:
                Createentity200Example:
                  summary: Default createEntity 200 response
                  x-microcks-default: true
                  value: example_value
        '400':
          description: Invalid entity data
        '401':
          description: Authentication required
        '404':
          description: Entity type not found
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /{entityUri}:
    get:
      operationId: readEntity
      summary: Solarwinds Read a Swis Entity
      description: Retrieves the properties of a specific entity identified by its SWIS URI. Returns all properties of the entity as JSON.
      tags:
      - CRUD
      parameters:
      - name: entityUri
        in: path
        required: true
        description: SWIS URI of the entity to read
        schema:
          type: string
        example: example_value
      responses:
        '200':
          description: Entity retrieved successfully
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
              examples:
                Readentity200Example:
                  summary: Default readEntity 200 response
                  x-microcks-default: true
                  value: {}
        '401':
          description: Authentication required
        '404':
          description: Entity not found
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    post:
      operationId: updateEntity
      summary: Solarwinds Update a Swis Entity
      description: Updates the properties of an existing entity identified by its SWIS URI. Only the properties included in the request body are updated.
      tags:
      - CRUD
      parameters:
      - name: entityUri
        in: path
        required: true
        description: SWIS URI of the entity to update
        schema:
          type: string
        example: example_value
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              additionalProperties: true
            examples:
              UpdateentityRequestExample:
                summary: Default updateEntity request
                x-microcks-default: true
                value: {}
      responses:
        '200':
          description: Entity updated successfully
        '400':
          description: Invalid update data
        '401':
          description: Authentication required
        '404':
          description: Entity not found
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    delete:
      operationId: deleteEntity
      summary: Solarwinds Delete a Swis Entity
      description: Deletes an entity identified by its SWIS URI from the SolarWinds Information Service.
      tags:
      - CRUD
      parameters:
      - name: entityUri
        in: path
        required: true
        description: SWIS URI of the entity to delete
        schema:
          type: string
        example: example_value
      responses:
        '200':
          description: Entity deleted successfully
        '401':
          description: Authentication required
        '404':
          description: Entity not found
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  parameters:
    EntityType:
      name: entityType
      in: path
      required: true
      description: Fully qualified SWIS entity type name
      schema:
        type: string
      example: Orion.Nodes
  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