REST API

Scheduler Endpoint

Updated: October 14, 2024

Get All Schedules

GET /management/scheduler

Response

If successful, returns a JSON representation of all schedules.

Status Codes

  • 200 _OK_ - Success.

Sample

curl -u Administrator:Administrator \
http://localhost:8080/nuxeo/api/v1/management/scheduler
{
    "entity-type": "schedules",
    "entries": [
        {
            "entity-type": "schedule",
            "id": "aceScheduler",
            "jobFactoryClass": "org.nuxeo.ecm.core.scheduler.DefaultEventJobFactory",
            "eventId": "updateACEStatus",
            "eventCategory": null,
            "cronExpression": "0 0/5 * * * ?",
            "username": null,
            "isEnabled": true,
            "timeZone": null
        },

    ...other schedules...

  ]
}

Stop the scheduler

PUT /management/scheduler/stop

Response

Always 204, this stops the scheduler service cluster-wide. The stop survives a server restart.

Status Codes

  • 204 _NO_CONTENT_

Sample

curl -XPUT -u Administrator:Administrator \
http://localhost:8080/nuxeo/api/v1/management/scheduler/stop

Start the scheduler

PUT /management/scheduler/start

Response

Always 204, this starts the scheduler service cluster-wide.

Status Codes

  • 204 _NO_CONTENT_

Sample

curl -XPUT -u Administrator:Administrator \
http://localhost:8080/nuxeo/api/v1/management/scheduler/start