Lucidworks Configurations API

openapi: 3.2.0
info:
  title: Fusion Admin Configurations 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: Configurations
  description: 'The Configurations API allows setting global properties for Fusion.


    Some settings are not set by any configuration file but are reported as settings from the operating system. Those settings cannot be changed with this API.


    > ⚠️ **Blocked by default:** This API is blocked on the API gateway by default because it exposes all Fusion admin service environment variables. It can be enabled in special cases — contact Lucidworks Support to discuss your use case. In Fusion 5.18 and later, use Fusion Vault instead, which provides a safer, structured approach to managing configuration values and secrets. The Configurations API is deprecated as of Fusion 5.18.'
paths:
  /configurations/status:
    get:
      tags:
      - Configurations
      summary: Get configurations service status
      description: 'Check the status of the Configurations service.


        > ⚠️ **Blocked by default:** This API is blocked on the API gateway by default because it exposes all Fusion admin service environment variables. It can be enabled in special cases — contact Lucidworks Support to discuss your use case. In Fusion 5.18 and later, use Fusion Vault instead, which provides a safer, structured approach to managing configuration values and secrets. The Configurations API is deprecated as of Fusion 5.18.'
      operationId: getStatus_4
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ServiceStatus'
  /configurations:
    get:
      tags:
      - Configurations
      summary: List matching configurations
      description: 'List all configurations in the system, or use prefixes or pattern matching to list the set of matching configurations.


        > ⚠️ **Blocked by default:** This API is blocked on the API gateway by default because it exposes all Fusion admin service environment variables. It can be enabled in special cases — contact Lucidworks Support to discuss your use case. In Fusion 5.18 and later, use Fusion Vault instead, which provides a safer, structured approach to managing configuration values and secrets. The Configurations API is deprecated as of Fusion 5.18.'
      operationId: find
      parameters:
      - name: pattern
        in: query
        description: Find all configuration items that _contain_ the specified string.
        schema:
          type: string
        example: connect
      - name: prefix
        in: query
        description: Find all configuration items that _start with_ the specified string.
        schema:
          type: string
        example: com.lucidworks
      - name: verbose
        in: query
        description: Display the Fusion component (or the part of the server’s operating system) that set the configuration item. Otherwise, the output includes only the name and value of the configuration item.
        schema:
          type: boolean
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                type: object
                additionalProperties:
                  type: array
                  items:
                    type: object
                    properties:
                      value:
                        type: string
                      location:
                        type: string
                    required:
                    - value
                    - location
              example:
                com.lucidworks.apollo-admin.config/zk-connect:
                - value: FUSION_HOST:9983
                  location: system properties
  /configurations/{key}:
    get:
      tags:
      - Configurations
      summary: Get a configuration item
      description: 'Display the specified configuration item.


        > ⚠️ **Blocked by default:** This API is blocked on the API gateway by default because it exposes all Fusion admin service environment variables. It can be enabled in special cases — contact Lucidworks Support to discuss your use case. In Fusion 5.18 and later, use Fusion Vault instead, which provides a safer, structured approach to managing configuration values and secrets. The Configurations API is deprecated as of Fusion 5.18.'
      operationId: getProperty
      parameters:
      - name: key
        in: path
        description: A configuration item key.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                type: string
    put:
      tags:
      - Configurations
      summary: Update a configuration item
      description: 'Modify a configuration item''s value.


        > ⚠️ **Blocked by default:** This API is blocked on the API gateway by default because it exposes all Fusion admin service environment variables. It can be enabled in special cases — contact Lucidworks Support to discuss your use case. In Fusion 5.18 and later, use Fusion Vault instead, which provides a safer, structured approach to managing configuration values and secrets. The Configurations API is deprecated as of Fusion 5.18.'
      operationId: setProperty
      parameters:
      - name: key
        in: path
        description: A configuration item key.
        required: true
        schema:
          type: string
        example: com.lucidworks.apollo.service.recommend.allowed.types
      - name: secret
        in: query
        description: Store this item as encrypted.
        schema:
          type: boolean
      requestBody:
        description: The configuration item value.
        content:
          application/json:
            schema:
              type: string
        required: false
      responses:
        '200':
          description: successful operation
          content: {}
      x-codegen-request-body-name: body
    post:
      tags:
      - Configurations
      summary: Create a configuration item
      description: 'Define a new configuration item.


        > ⚠️ **Blocked by default:** This API is blocked on the API gateway by default because it exposes all Fusion admin service environment variables. It can be enabled in special cases — contact Lucidworks Support to discuss your use case. In Fusion 5.18 and later, use Fusion Vault instead, which provides a safer, structured approach to managing configuration values and secrets. The Configurations API is deprecated as of Fusion 5.18.'
      operationId: createProperty
      parameters:
      - name: key
        in: path
        description: The new configuration item key.
        required: true
        schema:
          type: string
      - name: secret
        in: query
        description: Store this item as encrypted.
        schema:
          type: boolean
      requestBody:
        description: The new configuration item value.
        content:
          application/json:
            schema:
              type: string
          text/plain:
            schema:
              type: string
        required: false
      responses:
        '200':
          description: successful operation
          content: {}
      x-codegen-request-body-name: body
components:
  schemas:
    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)