Sign in

v18

latestOpenAPI 3.0.0raw.githubusercontent.com2026-08-014211,6201.8 MB
gitpod.v1.EnvironmentAutomationService

UpdateTaskExecutionStatus

Updates the status of a task execution. Only the environment executing a task execution is expected to call this function.

Use this method to:

  • Report execution progress
  • Update step status
  • Set failure messages
  • Provide log URLs

Examples

  • Update execution status:

    Updates status with step information.

    id: "d2c94c27-3b76-4a42-b88c-95a85e392c68"
steps:
  - id: "step-1"
    phase: TASK_EXECUTION_PHASE_SUCCEEDED
logUrl: "https://logs.gitpod.io/task-123"

  • Report failure:

    Updates status with failure information.

    id: "d2c94c27-3b76-4a42-b88c-95a85e392c68"
failureMessage: "Build failed due to missing dependencies"
steps:
  - id: "step-1"
    phase: TASK_EXECUTION_PHASE_FAILED
    failureMessage: "npm install failed"
post/gitpod.v1.EnvironmentAutomationService/UpdateTaskExecutionStatus

Request body

failureMessagestring nullable

failure_message marks the task execution as failed and provides a message explaining the failure. If an individual step has failed, callers are NOT expected to set this message; only if the task execution as a whole has failed/cannot be started.

idstring uuid
logUrlstring nullable

log_url is the URL to the logs of the task's steps. If this is empty, the task either has no logs or has not yet started.

Response

Success

GitpodV1UpdateTaskExecutionStatusResponse required