Scheduled Tasks (`scheduledtasks`)

The scheduledtasks endpoint provides information about the application’s scheduled tasks.spring-doc.cn

Retrieving the Scheduled Tasks

To retrieve the scheduled tasks, make a GET request to /actuator/scheduledtasks, as shown in the following curl-based example:spring-doc.cn

$ curl 'http://localhost:8080/actuator/scheduledtasks' -i -X GET

The resulting response is similar to the following:spring-doc.cn

HTTP/1.1 200 OK
Content-Type: application/vnd.spring-boot.actuator.v3+json
Content-Length: 793

{
  "cron" : [ {
    "runnable" : {
      "target" : "com.example.Processor.processOrders"
    },
    "expression" : "0 0 0/3 1/1 * ?",
    "nextExecution" : {
      "time" : "2024-11-21T17:59:59.999281772Z"
    }
  } ],
  "fixedDelay" : [ {
    "runnable" : {
      "target" : "com.example.Processor.purge"
    },
    "initialDelay" : 0,
    "interval" : 5000
  } ],
  "fixedRate" : [ {
    "runnable" : {
      "target" : "com.example.Processor.retrieveIssues"
    },
    "initialDelay" : 10000,
    "interval" : 3000,
    "nextExecution" : {
      "time" : "2024-11-21T16:03:15.892144955Z"
    }
  } ],
  "custom" : [ {
    "runnable" : {
      "target" : "com.example.Processor$CustomTriggeredRunnable@626bcfc8"
    },
    "trigger" : "com.example.Processor$CustomTrigger@6d9a46d7"
  } ]
}

Response Structure

The response contains details of the application’s scheduled tasks. The following table describes the structure of the response:spring-doc.cn

Path Type Description

Path	Type	Description
`cron`spring-doc.cn	`Array`spring-doc.cn	Cron tasks, if any.spring-doc.cn
`cron.[].runnable.target`spring-doc.cn	`String`spring-doc.cn	Target that will be executed.spring-doc.cn
`cron.[].nextExecution.time`spring-doc.cn	`String`spring-doc.cn	Time of the next scheduled execution.spring-doc.cn
`cron.[].expression`spring-doc.cn	`String`spring-doc.cn	Cron expression.spring-doc.cn
`fixedDelay`spring-doc.cn	`Array`spring-doc.cn	Fixed delay tasks, if any.spring-doc.cn
`fixedDelay.[].runnable.target`spring-doc.cn	`String`spring-doc.cn	Target that will be executed.spring-doc.cn
`fixedDelay.[].initialDelay`spring-doc.cn	`Number`spring-doc.cn	Delay, in milliseconds, before first execution.spring-doc.cn
`fixedDelay.[].nextExecution.time`spring-doc.cn	`String`spring-doc.cn	Time of the next scheduled execution, if known.spring-doc.cn
`fixedDelay.[].interval`spring-doc.cn	`Number`spring-doc.cn	Interval, in milliseconds, between the end of the last execution and the start of the next.spring-doc.cn
`fixedRate`spring-doc.cn	`Array`spring-doc.cn	Fixed rate tasks, if any.spring-doc.cn
`fixedRate.[].runnable.target`spring-doc.cn	`String`spring-doc.cn	Target that will be executed.spring-doc.cn
`fixedRate.[].interval`spring-doc.cn	`Number`spring-doc.cn	Interval, in milliseconds, between the start of each execution.spring-doc.cn
`fixedRate.[].initialDelay`spring-doc.cn	`Number`spring-doc.cn	Delay, in milliseconds, before first execution.spring-doc.cn
`fixedRate.[].nextExecution.time`spring-doc.cn	`String`spring-doc.cn	Time of the next scheduled execution, if known.spring-doc.cn
`custom`spring-doc.cn	`Array`spring-doc.cn	Tasks with custom triggers, if any.spring-doc.cn
`custom.[].runnable.target`spring-doc.cn	`String`spring-doc.cn	Target that will be executed.spring-doc.cn
`custom.[].trigger`spring-doc.cn	`String`spring-doc.cn	Trigger for the task.spring-doc.cn
`*.[].lastExecution`spring-doc.cn	`Object`spring-doc.cn	Last execution of this task, if any.spring-doc.cn
`*.[].lastExecution.status`spring-doc.cn	`String`spring-doc.cn	Status of the last execution (STARTED, SUCCESS, ERROR).spring-doc.cn
`*.[].lastExecution.time`spring-doc.cn	`String`spring-doc.cn	Time of the last execution.spring-doc.cn
`*.[].lastExecution.exception.type`spring-doc.cn	`String`spring-doc.cn	Exception type thrown by the task, if any.spring-doc.cn
`*.[].lastExecution.exception.message`spring-doc.cn	`String`spring-doc.cn	Message of the exception thrown by the task, if any.spring-doc.cn

cronspring-doc.cn

Arrayspring-doc.cn

Cron tasks, if any.spring-doc.cn

cron.[].runnable.targetspring-doc.cn

Stringspring-doc.cn

Target that will be executed.spring-doc.cn

cron.[].nextExecution.timespring-doc.cn

Stringspring-doc.cn

Time of the next scheduled execution.spring-doc.cn

cron.[].expressionspring-doc.cn

Stringspring-doc.cn

Cron expression.spring-doc.cn