Lucidworks Tasks API
These endpoints let you manage tasks, a flexible job type that can be used to clean up old logs or run any REST call.
These endpoints let you manage tasks, a flexible job type that can be used to clean up old logs or run any REST call.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
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.curl "https://apis.io/api/v1/apis/lucidworks:lucidworks-tasks-api"
curl "https://apis.io/api/v1/apis?limit=25"
Discovery needs no key. Ratings and market analysis are Pro.
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: 3.2.0
info:
title: Fusion Admin Tasks 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: Tasks
description: These endpoints let you manage tasks, a flexible job type that can be used to clean up old logs or run any REST call.
paths:
/tasks/{id}:
get:
tags:
- Tasks
summary: Get a task
description: Get the specified task.
operationId: getEntity_5
parameters:
- name: id
in: path
description: The task ID.
required: true
schema:
type: string
responses:
'200':
description: successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/Task'
put:
tags:
- Tasks
summary: Update a task
description: Update a task's configuration.
operationId: updateEntity
parameters:
- name: id
in: path
description: The task ID.
required: true
schema:
type: string
- name: If-Match
in: header
description: An optional tag to match.
schema:
type: string
default: '-1'
requestBody:
description: JSON-formatted configuration values.
content:
application/json:
schema:
$ref: '#/components/schemas/Task'
required: false
responses:
'200':
description: successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/Task'
x-codegen-request-body-name: body
delete:
tags:
- Tasks
summary: Delete a task
description: Delete a task.
operationId: deleteEntityWithBody_4
parameters:
- name: id
in: path
description: The task ID.
required: true
schema:
type: string
- name: If-Match
in: header
description: An optional tag to match.
schema:
type: string
default: '-1'
requestBody:
description: For supplying additional request parameters (such as relatedObjectIds) via 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
/tasks/status:
get:
tags:
- Tasks
summary: Get tasks service status
description: Check the status of the Tasks service.
operationId: getStatus_29
responses:
'200':
description: successful operation
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/ServiceStatus'
/tasks:
get:
tags:
- Tasks
summary: List all tasks
description: Fetch the list of existing tasks.
operationId: getAllEntities_4
responses:
'200':
description: successful operation
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Task'
post:
tags:
- Tasks
summary: Create a task
description: Create a new task.
operationId: createEntity
requestBody:
description: JSON-formatted configuration values.
content:
application/json:
schema:
$ref: '#/components/schemas/Task'
example:
type: rest-call
id: test-task-created
callParams:
uri: solr://system_jobs_history/update
method: post
queryParams:
wt: json
headers: {}
entity: <root><delete><query>timestamp_dt:[* TO NOW-30DAYS] AND type_s:history</query></delete><commit /></root>
required: false
responses:
'200':
description: successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/Task'
x-codegen-request-body-name: body
/tasks/_schema:
get:
tags:
- Tasks
summary: Get the tasks schema
description: Get JSON configuration schema for tasks.
operationId: getEntitySchema_4
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'
/tasks/_backcompat/{id}:
delete:
tags:
- Tasks
summary: Delete a task (backward compatibility)
description: Delete a task using the backward compatibility endpoint. Use this endpoint for legacy task deletion operations.
operationId: deleteEntity
parameters:
- name: id
in: path
description: The entity ID
required: true
schema:
type: string
- name: If-Match
in: header
description: An entity tag to match
required: false
schema:
type: string
default: '-1'
responses:
'200':
description: Successfully deleted entity
deprecated: true
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
Task:
type: object
properties:
id:
type: string
readOnly: true
type:
type: string
readOnly: true
discriminator:
propertyName: type
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)