Apache Solr CollectionsAdminHandler API

openapi: 3.1.0
info:
  title: Apache Solr REST Collections CollectionsAdminHandler API
  version: v2
  summary: HTTP/REST API for Apache Solr v2 covering collections, cores, schema, configuration, update and query handlers.
  description: 'Apache Solr exposes a REST API under /api (v2) on each Solr node. This specification

    covers collection lifecycle, core administration, per-collection schema/config/update

    operations, and the legacy Collections admin handler still supported under

    /solr/admin/collections.


    Authentication is pluggable (Basic, JWT, Certificate). Where security is enabled,

    Basic authentication is the most common configuration.

    '
  contact:
    name: Apache Solr Reference Guide
    url: https://solr.apache.org/guide/
servers:
- url: http://localhost:8983
  description: Default Solr node (replace host/port for your deployment)
security:
- basicAuth: []
tags:
- name: CollectionsAdminHandler
  description: Legacy Collections admin handler endpoints
paths:
  /solr/admin/collections:
    get:
      tags:
      - CollectionsAdminHandler
      summary: Legacy Collections admin handler (action via query string)
      operationId: collectionsAdmin
      parameters:
      - name: action
        in: query
        required: true
        schema:
          type: string
          enum:
          - CREATE
          - LIST
          - DELETE
          - RELOAD
          - BACKUP
          - RESTORE
          - SPLITSHARD
          - ADDREPLICA
          - DELETEREPLICA
          - REQUESTSTATUS
          - DELETESTATUS
      - name: name
        in: query
        schema:
          type: string
      - name: async
        in: query
        schema:
          type: string
        description: Optional async request id for non-blocking execution
      responses:
        '200':
          description: Action response
components:
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
      description: HTTP Basic Authentication (Solr Basic Auth plugin). JWT and certificate auth plugins are also supported.