Lucidworks License API

openapi: 3.2.0
info:
  title: Fusion Admin License 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: License
  description: The License API provides license management features.
paths:
  /license/status:
    get:
      tags:
      - License
      summary: Get license service status
      description: Check the status of the License service.
      operationId: getStatus_11
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ServiceStatus'
  /license:
    get:
      tags:
      - License
      summary: Get the Fusion license
      description: Export the current Fusion license.
      operationId: exportLicense
      responses:
        '200':
          description: successful operation
          content:
            application/octet-stream; qs=0.9:
              schema:
                type: array
                items:
                  pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$
                  type: string
                  format: byte
    put:
      tags:
      - License
      summary: Update the Fusion license
      description: Replace current Fusion License with a new license file.
      operationId: replaceLicense_1
      requestBody:
        description: New License.
        content:
          application/octet-stream:
            schema:
              type: array
              items:
                type: string
                format: byte
        required: false
      responses:
        '200':
          description: successful operation
          content: {}
      x-codegen-request-body-name: body
  /license/check:
    get:
      tags:
      - License
      summary: Validate the Fusion license
      description: Check whether the current license is valid.
      operationId: checkLicense
      responses:
        '200':
          description: successful operation
          content:
            '*/*':
              schema:
                type: boolean
                description: '`true` if the license is valid.'
  /license/capability/{capability}:
    get:
      tags:
      - License
      summary: Get license capabilities
      description: Gets the licensed capability details.
      operationId: getCapability
      parameters:
      - name: capability
        in: path
        description: The name of a Fusion capability.  Use `/apps-manager/license` to get the list of possible values.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                type: object
                additionalProperties:
                  type: string
  /license/expiration:
    get:
      tags:
      - License
      summary: Get the license expiration
      description: Gets the expiration date for the current Fusion license.
      operationId: getExpirationDate
      responses:
        '200':
          description: successful operation
          content:
            '*/*':
              schema:
                type: string
                format: date-time
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)