Lucidworks Solr admin API

openapi: 3.2.0
info:
  title: Fusion Admin Solr admin API
  description: These APIs provide general administrative functions for your Fusion instance. Use these APIs to manage Fusion objects, App Studio objects, connections to Solr clusters, license files, job schedules, and more. You can also use them to create a history of service events.
  termsOfService: https://lucidworks.com/legal/developer-license-agreement/
  contact:
    name: Lucidworks
    url: www.lucidworks.com
    email: support@lucidworks.com
  license:
    name: License of API
    url: https://lucidworks.com/legal/developer-license-agreement/
  version: '5.9'
servers:
- url: https://{FUSION HOST}/api
  description: Fusion
  variables:
    FUSION HOST:
      default: FUSION_HOST
      description: Your environment host.
- url: https://{FUSION HOST}/api/apps/{APP_NAME}
  description: Fusion app
  variables:
    FUSION HOST:
      default: FUSION_HOST
      description: Your environment host.
    APP_NAME:
      default: APP_NAME
      description: The name of your Fusion application.
tags:
- name: Solr admin
  description: 'The Solr Admin API lets you send commands to Solr through Fusion''s proxy service. This allows you to protect your Solr instances from outside connections, and apply roles and user permissions from Fusion when running Solr commands. Requests sent to this API are subject to access restrictions above the collection level.


    Note that because one `searchCluster` may host several collections, it is not recommended to use this with a collection-level command (such as a query, or document update).'
paths:
  /solrAdmin/{solrApiPath}/{path}:
    get:
      tags:
      - Solr admin
      summary: Send a Solr command
      description: 'Issue a Solr command to the search cluster.


        Note that because one searchCluster may host several collections, it is not recommended to use this with a collection-level command (such as a query, or document update).'
      operationId: proxyGetRequestToSolr
      parameters:
      - name: solrApiPath
        in: path
        description: The Solr API Path.
        required: true
        schema:
          type: string
      - name: path
        in: path
        description: The path to the Solr command to run.
        required: true
        schema:
          pattern: .*
          type: string
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                type: object
                description: Solr metadata output
                additionalProperties: true
              examples:
                solrMBeans:
                  summary: This is the response to GET all CORE MBeans for the default search cluster.
                  value:
                    responseHeader:
                      status: 0
                      QTime: 1
                    solr-mbeans:
                    - CORE
                    - searcher:
                        class: org.apache.solr.search.SolrIndexSearcher
                        version: '1.0'
                        description: index searcher
                        src: null
                      core:
                        class: collection1
                        version: '1.0'
                        description: SolrCore
                        src: null
                      Searcher@435cf502[collection1] main:
                        class: org.apache.solr.search.SolrIndexSearcher
                        version: '1.0'
                        description: index searcher
                        src: null
    put:
      tags:
      - Solr admin
      summary: Send a Solr command
      description: 'Issue a Solr command to the search cluster.


        Note that because one searchCluster may host several collections, it is not recommended to use this with a collection-level command (such as a query, or document update).'
      operationId: proxyPutRequestToSolr
      parameters:
      - name: solrApiPath
        in: path
        description: The Solr API Path.
        required: true
        schema:
          type: string
      - name: path
        in: path
        description: The path to the Solr command to run.
        required: true
        schema:
          pattern: .*
          type: string
      requestBody:
        description: Solr request object.
        content:
          '*/*':
            schema:
              $ref: '#/components/schemas/InputStream'
        required: false
      responses:
        '200':
          description: successful operation
          content: {}
      x-codegen-request-body-name: body
    post:
      tags:
      - Solr admin
      summary: Send a Solr command
      description: 'Issue a Solr command to the search cluster.


        Note that because one searchCluster may host several collections, it is not recommended to use this with a collection-level command (such as a query, or document update).'
      operationId: proxyPostRequestToSolr
      parameters:
      - name: solrApiPath
        in: path
        description: The Solr API Path.
        required: true
        schema:
          type: string
      - name: path
        in: path
        description: The path to the Solr command to run.
        required: true
        schema:
          pattern: .*
          type: string
      requestBody:
        description: Solr request body.
        content:
          '*/*':
            schema:
              $ref: '#/components/schemas/InputStream'
        required: false
      responses:
        '200':
          description: successful operation
          content: {}
      x-codegen-request-body-name: body
    delete:
      tags:
      - Solr admin
      summary: Send a Solr command
      description: 'Issue a Solr command to the search cluster.


        Note that because one searchCluster may host several collections, it is not recommended to use this with a collection-level command (such as a query, or document update).'
      operationId: proxyDeleteRequestToSolr
      parameters:
      - name: solrApiPath
        in: path
        description: The Solr API Path.
        required: true
        schema:
          type: string
      - name: path
        in: path
        description: The path to the Solr command to run.
        required: true
        schema:
          pattern: .*
          type: string
      responses:
        '200':
          description: successful operation
          content: {}
    options:
      tags:
      - Solr admin
      summary: List Solr command options
      description: Get the options for a Solr command.
      operationId: proxyOptionsRequestToSolr
      parameters:
      - name: solrApiPath
        in: path
        description: The Solr API Path.
        required: true
        schema:
          type: string
      - name: path
        in: path
        description: The path to the Solr command to run.
        required: true
        schema:
          pattern: .*
          type: string
      responses:
        '200':
          description: successful operation
          content: {}
    head:
      tags:
      - Solr admin
      summary: Send an HTTP HEAD request
      description: Issue an HTTP HEAD request to the Solr cluster.
      operationId: proxyHeadRequestToSolr
      parameters:
      - name: solrApiPath
        in: path
        description: The Solr API Path.
        required: true
        schema:
          type: string
      - name: path
        in: path
        description: The path for the HTTP request.
        required: true
        schema:
          pattern: .*
          type: string
      responses:
        '200':
          description: successful operation
          content: {}
  /solrAdmin/status:
    get:
      tags:
      - Solr admin
      summary: Get Solr admin service status
      description: Check the status of the Solr Admin service.
      operationId: getStatus_22
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ServiceStatus'
components:
  schemas:
    InputStream:
      type: object
    ServiceStatus:
      type: object
      properties:
        status:
          type: string
          enum:
          - starting
          - ok
          - warning
          - error
          - shutdown
        node:
          type: string
          readOnly: true
        messages:
          type: array
          readOnly: true
          items:
            $ref: '#/components/schemas/StatusMessage'
    StatusMessage:
      type: object
      properties:
        date:
          type: string
          format: date-time
          readOnly: true
        message:
          type: string
          readOnly: true
  securitySchemes:
    Basic_auth:
      type: http
      scheme: basic
    API_key:
      name: x-api-key
      type: apiKey
      in: header
x-original-swagger-version: '2.0'
x-provenance:
  method: harvested
  publisher: Lucidworks
  source: https://doc.lucidworks.com/api-reference/5.9/fusion-api-swagger.json
  note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
    stamped by stamp-openapi-provenance.py (roadmap#793)