OpenAPI Specification
openapi: 3.1.0
info:
title: Apache Solr REST Collections Schema 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: Schema
description: Per-collection schema operations
paths:
/api/c/{collection}/schema:
parameters:
- $ref: '#/components/parameters/Collection'
get:
tags:
- Schema
summary: Get schema
operationId: getSchema
responses:
'200':
description: Schema document
post:
tags:
- Schema
summary: Modify schema (add/replace/delete fields and types)
operationId: updateSchema
responses:
'200':
description: Schema updated
components:
parameters:
Collection:
name: collection
in: path
required: true
schema:
type: string
securitySchemes:
basicAuth:
type: http
scheme: basic
description: HTTP Basic Authentication (Solr Basic Auth plugin). JWT and certificate auth plugins are also supported.