Task

Task API

Schedule and API task management and execution.

Auth

All management endpoints require READ_WRITE.

/task/api/:key is public by access key.

TaskType

Value	Notes
schedule	Scheduled tasks
api	API-triggered tasks

All task endpoints accept query param taskType. Default is schedule.

POST /task

Create a task.

Permission: READ_WRITE

Query

Name	Type	Required	Notes
taskType	string	No	schedule \| api

Body

Name	Type	Required	Notes
name	string	Yes	Task name.
cron	string	No	Required for schedule tasks.
logicId	string	Yes	TaskLogicEnum value.
params	object	No	Task parameters.
isEnabled	boolean	No	Enable flag.

GET /task

List tasks.

Permission: READ_WRITE

GET /task/logic/list

Return the TaskLogicList array.

Permission: READ_WRITE

GET /task/:id

Fetch a task by id.

Permission: READ_WRITE

PUT /task/:id

Update a task by id.

Permission: READ_WRITE

Body

Partial of create task fields.

DELETE /task/:id

Delete a task by id.

Permission: READ_WRITE

Response

true | false

GET /task/:id/logs

Fetch task logs.

Permission: READ_WRITE

Response

[{ "timestamp": "2024-01-01 00:00:00", "status": "success", "messages": [ { "timestamp": "2024-01-01 00:00:00", "message": "..." } ], "durationMs": 0 }]

POST /task/execute-logic

Execute task logic by task name.

Permission: READ_WRITE

Body

{ "name": "taskName" }

GET /task/api/:key

Execute an API task via its access key.

Permission: PUBLIC