SymetryML Documentation
Tasks

Get task status

Get the current runtime status of a Task's process. Only meaningful after the Task has been started via [Start task](/docs/api-reference/tasks/tasks-taskid-start-get) — the running-task registry is an in-memory map on the server, not persisted, so this reports `"not running"` both for a Task that was never started and for one that was running before the last server restart. `lastError` is misleadingly named — for a `kafkastream-app` task it's just the last line the process wrote to stderr, which routinely includes benign Kafka consumer-group rebalance `INFO` lines even while the task is healthy and `processIsAlive` is `"true"`. Don't treat a non-null `lastError` as proof the Task failed.

GET
/{user}/tasks/{taskid}

Get the current runtime status of a Task's process. Only meaningful after the Task has been started via Start task — the running-task registry is an in-memory map on the server, not persisted, so this reports "not running" both for a Task that was never started and for one that was running before the last server restart. lastError is misleadingly named — for a kafkastream-app task it's just the last line the process wrote to stderr, which routinely includes benign Kafka consumer-group rebalance INFO lines even while the task is healthy and processIsAlive is "true". Don't treat a non-null lastError as proof the Task failed.

Authorization

SymetryMLAuth
AuthorizationBearer <token>

HMAC-SHA256 signature-based authentication: requests are signed with your secret key and sent with the Customer-ID, Sym-date, Authorization, Content-MD5 and sym-version headers. See SymetryML REST API Security for the signature algorithm and a complete example.

In: header

Path Parameters

user*string

User/Customer identifier

taskid*string

Task name (used as its identifier)

Response Body

application/json

application/json

curl -X GET "https://example.com/c1/tasks/kstream_task_0"

{  "statusCode": 200,  "statusString": "OK",  "values": {    "KSVSMap": {      "values": [        {          "startDateTime": "1785257266094",          "lastError": "[KafkaTask1PartitionFilePredTest_client-StreamThread-1] INFO org.apache.kafka.clients.consumer.internals.AbstractCoordinator - [Consumer clientId=KafkaTask1PartitionFilePredTest_client-StreamThread-1-consumer, groupId=KafkaTask1PartitionFilePredTest_a8] Join group failed with org.apache.kafka.common.errors.MemberIdRequiredException: The group member needs to have a valid member id before actually entering a consumer group",          "processIsAlive": "true",          "status": "running"        }      ]    }  }}

{  "statusCode": 400,  "statusString": "Customer [c1] has no Task [nosuchtask]",  "values": {}}