Lucidworks Zoo Keeper API

The ZooKeeper Import/Export API provides methods to upload or download information from Fusion's ZooKeeper service. This service provides an alternative to the ZooKeeper clients `zkCli.sh` and `zk-shell` which are part of the Apache Zookeeper distribution included as part of the Fusion distribution.

Operations 2

GET /zk/export/{path} Get ZooKeeper data #
GET /zk/export/status Get ZooKeeper export service status #

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-zookeeper-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.

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

OpenAPI Specification

lucidworks-zookeeper-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Fusion Admin Zoo Keeper 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: ZooKeeper
  description: The ZooKeeper Import/Export API provides methods to upload or download information from Fusion's ZooKeeper service. This service provides an alternative to the ZooKeeper clients `zkCli.sh` and `zk-shell` which are part of the Apache Zookeeper distribution included as part of the Fusion distribution.
paths:
  /zk/export/{path}:
    get:
      tags:
      - ZooKeeper
      summary: Get ZooKeeper data
      description: Download a ZooKeeper configuration. The REST API only supports export requests. The Fusion distribution includes a utility script `zkImportExport.sh` which can be used to import ZooKeeper configuration as well as to export it from arbitrary Fusion instances.
      operationId: getNodeInfo
      parameters:
      - name: path
        in: path
        description: Path from ZooKeeper root node, such as 'lucid/query-pipelines'.
        required: true
        schema:
          pattern: .*
          type: string
      - name: recursive
        in: query
        description: Return children nodes.
        schema:
          type: boolean
          default: true
      - name: excludePaths
        in: query
        description: List of paths to exclude.
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: includePaths
        in: query
        description: List of paths to include.
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: encodeValues
        in: query
        description: Values encoding. Default is 'base64'.
        schema:
          type: string
          default: base64
      - name: ephemeral
        in: query
        description: Include ephemeral nodes. Default is false.
        schema:
          type: boolean
          default: false
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ZNodeDump'
              example:
                path: /lucid/query-pipelines
                children:
                - path: /lucid/query-pipelines/default
  /zk/export/status:
    get:
      tags:
      - ZooKeeper
      summary: Get ZooKeeper export service status
      description: Check the status of the ZooKeeper Export service.
      operationId: getStatus_31
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ServiceStatus'
components:
  schemas:
    ZNodeDump:
      type: object
      properties:
        request:
          $ref: '#/components/schemas/ZNodeDumpRequest'
        response:
          $ref: '#/components/schemas/ZNode'
    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
    Params:
      type: object
      properties:
        zkHost:
          type: string
          readOnly: true
        path:
          type: string
          readOnly: true
        encodeValues:
          type: string
          readOnly: true
        includePaths:
          type: array
          readOnly: true
          items:
            type: string
        excludePaths:
          type: array
          readOnly: true
          items:
            type: string
        recursive:
          type: boolean
          readOnly: true
        ephemeral:
          type: boolean
          readOnly: true
    ZNodeDumpRequest:
      type: object
      properties:
        timestamp:
          type: string
          format: date-time
          readOnly: true
        params:
          $ref: '#/components/schemas/Params'
    ZNode:
      type: object
      properties:
        path:
          type: string
          readOnly: true
        children:
          type: array
          readOnly: true
          items:
            $ref: '#/components/schemas/ZNode'
        data:
          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)