Scheduler API

Overview

Scheduler API is an API for managing Fess scheduled jobs. You can start/stop crawl jobs, and create/update/delete schedule configurations.

Base URL

/api/admin/scheduler

Endpoint List

Method Path Description
GET/PUT /settings List scheduled jobs
GET /setting/{id} Get scheduled job
POST /setting Create scheduled job
PUT /setting Update scheduled job
DELETE /setting/{id} Delete scheduled job
PUT /{id}/start Start job
PUT /{id}/stop Stop job

List Scheduled Jobs

Request

GET /api/admin/scheduler/settings
PUT /api/admin/scheduler/settings

Parameters

Response

{
  "response": {
    "status": 0,
    "settings": [
      {
        "id": "job_id_1",
        "name": "Default Crawler",
        "target": "all",
        "cronExpression": "0 0 0 * * ?",
        "scriptType": "groovy",
        "scriptData": "...",
        "jobLogging": true,
        "crawler": true,
        "available": true,
        "sortOrder": 0,
        "running": false
      }
    ],
    "total": 5
  }
}

Get Scheduled Job

Request

GET /api/admin/scheduler/setting/{id}

Response

{
  "response": {
    "status": 0,
    "setting": {
      "id": "job_id_1",
      "name": "Default Crawler",
      "target": "all",
      "cronExpression": "0 0 0 * * ?",
      "scriptType": "groovy",
      "scriptData": "return container.getComponent(\"crawlJob\").execute();",
      "jobLogging": true,
      "crawler": true,
      "available": true,
      "sortOrder": 0,
      "running": false
    }
  }
}

Create Scheduled Job

Request

POST /api/admin/scheduler/setting
Content-Type: application/json

Request Body

{
  "name": "Daily Crawler",
  "target": "all",
  "cronExpression": "0 0 2 * * ?",
  "scriptType": "groovy",
  "scriptData": "return container.getComponent(\"crawlJob\").execute();",
  "jobLogging": true,
  "crawler": true,
  "available": true,
  "sortOrder": 1
}

Field Description

Response

{
  "response": {
    "status": 0,
    "id": "new_job_id",
    "created": true
  }
}

Cron Expression Examples

Cron Expression Description
0 0 2 * * ? Execute daily at 2 AM
0 0 0/6 * * ? Execute every 6 hours
0 0 2 * * MON Execute every Monday at 2 AM
0 0 2 1 * ? Execute on the 1st of every month at 2 AM

Update Scheduled Job

Request

PUT /api/admin/scheduler/setting
Content-Type: application/json

Request Body

{
  "id": "existing_job_id",
  "name": "Updated Crawler",
  "target": "all",
  "cronExpression": "0 0 3 * * ?",
  "scriptType": "groovy",
  "scriptData": "...",
  "jobLogging": true,
  "crawler": true,
  "available": true,
  "sortOrder": 1,
  "versionNo": 1
}

Response

{
  "response": {
    "status": 0,
    "id": "existing_job_id",
    "created": false
  }
}

Delete Scheduled Job

Request

DELETE /api/admin/scheduler/setting/{id}

Response

{
  "response": {
    "status": 0,
    "id": "deleted_job_id",
    "created": false
  }
}

Start Job

Execute a scheduled job immediately.

Request

PUT /api/admin/scheduler/{id}/start

Response

{
  "response": {
    "status": 0
  }
}

Notes

  • Returns an error if the job is already running

  • Returns an error if the job is disabled (available: false)

Stop Job

Stop a running job.

Request

PUT /api/admin/scheduler/{id}/stop

Response

{
  "response": {
    "status": 0
  }
}

Usage Examples

Create and Run a Crawl Job

# Create job
curl -X POST "http://localhost:8080/api/admin/scheduler/setting" \
     -H "Authorization: Bearer YOUR_TOKEN" \
     -H "Content-Type: application/json" \
     -d '{
       "name": "Hourly Crawler",
       "target": "all",
       "cronExpression": "0 0 * * * ?",
       "scriptType": "groovy",
       "scriptData": "return container.getComponent(\"crawlJob\").execute();",
       "jobLogging": true,
       "crawler": true,
       "available": true
     }'

# Run job immediately
curl -X PUT "http://localhost:8080/api/admin/scheduler/{job_id}/start" \
     -H "Authorization: Bearer YOUR_TOKEN"

Check Job Status

# Check status of all jobs
curl "http://localhost:8080/api/admin/scheduler/settings" \
     -H "Authorization: Bearer YOUR_TOKEN"

# The running field indicates execution status

Reference