Workflow Tasks

Retrieve task run

Changed on

Retrieve the workflow task run with the provided ID.

get/task-runs/{taskRunId}

Request

  • Base URL
    https://api.render.com/v1
  • Auth
    HTTP bearer

Response

Task run details

idstring required
taskIdstring required
status'pending' | 'running' | 'completed' | 'succeeded' | 'failed' | 'canceled' | 'paused' required
errorstring

Error message if the task run failed.

startedAtstring date-time
completedAtstring date-time
inputInput required(unresolved $ref)
parentTaskRunIdstring required
parentTaskAttemptinteger

The 0-indexed attempt of the parent task run that spawned this task run. Omitted for root task runs and for task runs created before this field was introduced.

rootTaskRunIdstring required
retriesinteger required

Changes

    • breaking

      the // response's property type changed from no type to array for status

    • info

      api tag Workflow Tasks added

    • info

      api tag Workflow Tasks (Beta) removed

    • info

      added the non-success response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the required property // to the response with the status