Lucidworks

Lucidworks Apps API

The Apps API manages your Fusion apps. To export or import an app, see the Objects API. You can also import an app using the Fusion UI.

GitHub OpenAPI

Operations 6

GET /apps/status Get apps service status #
GET /apps List all apps #
POST /apps Create an app #
GET /apps/{id} Get an app #
DELETE /apps/{id} Delete an app #
GET /apps/_schema Get the apps schema #

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/lucidworks/refs/heads/main/openapi/lucidworks-apps-api-openapi.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/lucidworks:lucidworks-apps-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

lucidworks-apps-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Fusion Admin Apps 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: Apps
  description: The Apps API manages your Fusion apps. To export or import an app, see the Objects API. You can also import an app using the Fusion UI.
paths:
  /apps/status:
    get:
      tags:
      - Apps
      summary: Get apps service status
      description: Check the status of the apps service.
      operationId: getStatus
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ServiceStatus'
  /apps:
    get:
      tags:
      - Apps
      summary: List all apps
      description: Get the list of all existing Fusion apps and their configuration details.
      operationId: getAllEntities
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Entity'
              example:
              - id: movies
                name: Movies
                description: Search the movielens database.
                dataUri: /App-Tile-01-460x160.png
                properties:
                  headerImageName: headerImage1
                  tileColor: apps-darkblue
                  previousCollectionId: movies
              - id: tech-pubs
                name: TechPubs
                description: Search the documentation.
                dataUri: /App-Tile-02-460x160.png
                properties:
                  headerImageName: headerImage2
                  tileColor: apps-darkblue
                  previousCollectionId: tech-pubs
    post:
      tags:
      - Apps
      summary: Create an app
      description: Create a new Fusion app.
      operationId: createApp
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - id
              - name
              - description
              properties:
                id:
                  type: string
                  description: The unique ID for the app.
                  example: MyNewApp
                name:
                  type: string
                  description: The display name for the app.
                  example: My new app
                description:
                  type: string
                  description: A short description of the app.
                  example: A really great new app
            example:
              id: MyNewApp
              name: My new app
              description: A really great new app
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: string
                  name:
                    type: string
                  description:
                    type: string
              example:
                id: MyNewApp
                name: My new app
                description: A really great new app
  /apps/{id}:
    get:
      tags:
      - Apps
      summary: Get an app
      description: Fetch an app by its ID. The response is the app's complete configuration in JSON.
      operationId: getEntity
      parameters:
      - name: id
        in: path
        description: The app ID.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Entity'
    delete:
      tags:
      - Apps
      summary: Delete an app
      description: Delete a Fusion app.
      operationId: deleteEntityWithBody
      parameters:
      - name: id
        in: path
        description: The app ID.
        required: true
        schema:
          type: string
      - name: If-Match
        in: header
        description: An optional tag to match.
        schema:
          type: string
          default: '-1'
      requestBody:
        description: Additional request parameters, if any (such as `relatedObjectIds`), can be supplied in the request body instead of as request parameters. Use this if the URL is getting too long.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BodyRequestParams'
        required: false
      responses:
        '200':
          description: successful operation
          content: {}
      x-codegen-request-body-name: body
  /apps/_schema:
    get:
      tags:
      - Apps
      summary: Get the apps schema
      description: Get the JSON configuration schema for apps.
      operationId: getEntitySchema
      responses:
        '200':
          description: successful operation
          content:
            application/schema+json; qs=1.0:
              schema:
                $ref: '#/components/schemas/ObjectType'
            application/json; qs=0.9:
              schema:
                $ref: '#/components/schemas/ObjectType'
components:
  schemas:
    PropertyGroup:
      type: object
      properties:
        label:
          type: string
          readOnly: true
        properties:
          type: array
          readOnly: true
          items:
            type: string
    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
    ObjectType:
      type: object
      properties:
        type:
          type: string
          readOnly: true
          enum:
          - String
          - Number
          - Integer
          - Boolean
          - Object
          - Array
          - 'Null'
          - Ref
        title:
          type: string
          readOnly: true
        description:
          type: string
          readOnly: true
        required:
          uniqueItems: true
          type: array
          readOnly: true
          items:
            type: string
        properties:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/AnyType'
          readOnly: true
        additionalProperties:
          type: object
          properties: {}
          readOnly: true
        minProperties:
          type: integer
          format: int32
          readOnly: true
        maxProperties:
          type: integer
          format: int32
          readOnly: true
        definitions:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/AnyType'
          readOnly: true
        category:
          type: string
          readOnly: true
        categoryPriority:
          type: integer
          format: int32
          readOnly: true
        enum:
          uniqueItems: true
          type: array
          readOnly: true
          items:
            type: object
            properties: {}
        hints:
          uniqueItems: true
          type: array
          readOnly: true
          items:
            type: string
        unsafe:
          type: boolean
          readOnly: true
        default:
          type: object
          properties: {}
          readOnly: true
        oneOf:
          type: array
          readOnly: true
          items:
            $ref: '#/components/schemas/AnyTypeObjectObject'
        propertyGroups:
          type: array
          readOnly: true
          items:
            $ref: '#/components/schemas/PropertyGroup'
    AnyTypeObjectObject:
      type: object
      properties:
        type:
          type: string
          readOnly: true
          enum:
          - String
          - Number
          - Integer
          - Boolean
          - Object
          - Array
          - 'Null'
          - Ref
        title:
          type: string
          readOnly: true
        description:
          type: string
          readOnly: true
        enum:
          uniqueItems: true
          type: array
          readOnly: true
          items:
            type: object
            properties: {}
        default:
          type: object
          properties: {}
          readOnly: true
        category:
          type: string
          readOnly: true
        categoryPriority:
          type: integer
          format: int32
          readOnly: true
        hints:
          uniqueItems: true
          type: array
          readOnly: true
          items:
            type: string
        unsafe:
          type: boolean
          readOnly: true
        oneOf:
          type: array
          readOnly: true
          items:
            $ref: '#/components/schemas/AnyTypeObjectObject'
    BodyRequestParam:
      type: object
      properties:
        name:
          type: string
          readOnly: true
        values:
          type: array
          readOnly: true
          items:
            type: string
    Entity:
      type: object
      properties:
        id:
          type: string
    BodyRequestParams:
      type: object
      properties:
        params:
          type: array
          readOnly: true
          items:
            $ref: '#/components/schemas/BodyRequestParam'
    AnyType:
      type: object
      properties:
        type:
          type: string
          readOnly: true
          enum:
          - String
          - Number
          - Integer
          - Boolean
          - Object
          - Array
          - 'Null'
          - Ref
        title:
          type: string
          readOnly: true
        description:
          type: string
          readOnly: true
        enum:
          uniqueItems: true
          type: array
          readOnly: true
          items:
            type: object
            properties: {}
        default:
          type: object
          properties: {}
          readOnly: true
        category:
          type: string
          readOnly: true
        categoryPriority:
          type: integer
          format: int32
          readOnly: true
        hints:
          uniqueItems: true
          type: array
          readOnly: true
          items:
            type: string
        unsafe:
          type: boolean
          readOnly: true
        oneOf:
          type: array
          readOnly: true
          items:
            $ref: '#/components/schemas/AnyTypeObjectObject'
  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)