New Release
Guardian 3.7.0
Ctrlk
Release NotesCalendar
youtube
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Worker Tasks

Worker-level task queue management.

Get all worker tasks

get

Returns all worker tasks.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
pageIndexnumberOptional

The number of pages to skip before starting to collect the result set

Example: 0
pageSizenumberOptional

The numbers of items to return

Example: 20
statusstringOptional

Status

Example: COMPLETE
Responses
200

Successful operation. Returns worker tasks and count.

application/json
get/worker-tasks
GET /api/v1/worker-tasks HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "createDate": "2026-03-03T17:25:53.312Z",
    "done": true,
    "id": null,
    "isRetryableTask": true,
    "processedTime": "2026-03-03T17:25:53.312Z",
    "sent": true,
    "taskId": "9db028d2-03ad-4d49-a178-cf4b67f8c147",
    "type": "send-hedera",
    "updateDate": "2026-03-03T17:25:53.312Z"
  }
]

Restart task

post

Restart task.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
taskIdstringRequired

Worker task identifier

Example: 69aeb71ef8c5b278e3bab4e5
Responses
200

Task restart request accepted. Empty response body.

application/json
object · nullableOptional
post/worker-tasks/restart
POST /api/v1/worker-tasks/restart HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 37

{
  "taskId": "69aeb71ef8c5b278e3bab4e5"
}
No content

Delete task

delete

Delete task.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
taskIdstringRequired

Task Id

Example: 69aeb71ef8c5b278e3bab4e5
Responses
200

Task deleted. Empty response body.

application/json
object · nullableOptional
delete/worker-tasks/delete/{taskId}
DELETE /api/v1/worker-tasks/delete/{taskId} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content
PreviousTasks
NextMetrics

Last updated

Was this helpful?