openapi: 3.2.0
info:
  title: SolarWinds Orion Platform Bulk Operations 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: Bulk Operations
  description: Perform bulk create, update, and delete operations
paths:
  /BulkDelete:
    post:
      operationId: bulkDelete
      summary: Solarwinds Delete Multiple Entities
      description: Deletes multiple SWIS entities in a single operation. Provide an array of SWIS URIs to delete.
      tags:
      - Bulk Operations
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BulkDeleteRequest'
            examples:
              BulkdeleteRequestExample:
                summary: Default bulkDelete request
                x-microcks-default: true
                value:
                  uris:
                  - example_value
      responses:
        '200':
          description: Entities deleted successfully
        '401':
          description: Authentication required
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /BulkUpdate:
    post:
      operationId: bulkUpdate
      summary: Solarwinds Update Multiple Entities
      description: Updates properties on multiple SWIS entities in a single operation.
      tags:
      - Bulk Operations
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BulkUpdateRequest'
            examples:
              BulkupdateRequestExample:
                summary: Default bulkUpdate request
                x-microcks-default: true
                value:
                  uris:
                  - example_value
                  properties: example_value
      responses:
        '200':
          description: Entities updated successfully
        '401':
          description: Authentication required
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  schemas:
    BulkUpdateRequest:
      type: object
      required:
      - uris
      - properties
      properties:
        uris:
          type: array
          description: Array of SWIS URIs to update
          items:
            type: string
          example: []
        properties:
          type: object
          description: Properties to set on all specified entities
          additionalProperties: true
          example: example_value
    BulkDeleteRequest:
      type: object
      required:
      - uris
      properties:
        uris:
          type: array
          description: Array of SWIS URIs to delete
          items:
            type: string
          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