Ceph Configuration API

openapi: 3.1.0
info:
  title: Ceph Manager REST Auth Configuration API
  description: 'REST API exposed by the Ceph Manager (ceph-mgr) dashboard module for

    managing and monitoring a Ceph cluster, including pools, OSDs, hosts,

    monitors, RGW, RBD, CephFS, users, and cluster configuration. Authentication

    uses a JWT obtained from POST /api/auth, supplied via the Authorization

    Bearer header. API versioning is negotiated via the Accept header using

    application/vnd.ceph.api.v{major}.{minor}+json. Generated as a best-effort

    spec from public Ceph documentation; the canonical OpenAPI is served by

    every Ceph Manager instance at /docs/api.json.

    '
  version: '1.0'
  contact:
    name: Ceph
    url: https://docs.ceph.com/en/latest/mgr/ceph_api/
  license:
    name: LGPL-2.1
    url: https://github.com/ceph/ceph/blob/main/COPYING
servers:
- url: https://{manager_host}:{dashboard_port}/api
  description: Ceph Manager dashboard
  variables:
    manager_host:
      default: localhost
    dashboard_port:
      default: '8443'
security:
- bearerAuth: []
tags:
- name: Configuration
paths:
  /cluster_conf:
    get:
      tags:
      - Configuration
      summary: List cluster configuration
      description: Retrieve all cluster configuration settings.
      operationId: listClusterConf
      responses:
        '200':
          description: Configuration items.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ClusterConfig'
    post:
      tags:
      - Configuration
      summary: Create or update configuration option
      operationId: setClusterConf
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ClusterConfig'
      responses:
        '201':
          description: Configuration option set.
  /cluster_conf/filter:
    get:
      tags:
      - Configuration
      summary: Filter cluster configuration
      description: Query specific configuration by option names.
      operationId: filterClusterConf
      parameters:
      - in: query
        name: names
        required: true
        schema:
          type: array
          items:
            type: string
        style: form
        explode: true
      responses:
        '200':
          description: Matching configuration items.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ClusterConfig'
  /cluster_conf/{name}:
    delete:
      tags:
      - Configuration
      summary: Delete configuration option
      operationId: deleteClusterConf
      parameters:
      - in: path
        name: name
        required: true
        schema:
          type: string
      responses:
        '204':
          description: Configuration option removed.
components:
  schemas:
    ClusterConfig:
      type: object
      properties:
        name:
          type: string
        value:
          type: string
        section:
          type: string
        source:
          type: string
        type:
          type: string
        level:
          type: string
        desc:
          type: string
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: JWT obtained from POST /api/auth.