Gitpod gitpod.v1.EnvironmentAutomationService API
The gitpod.v1.EnvironmentAutomationService API from Gitpod — 18 operation(s) for gitpod.v1.environmentautomationservice.
OpenAPI Specification
openapi: 3.0.0
info:
title: gitpod.v1 gitpod.v1.AccountService gitpod.v1.EnvironmentAutomationService API
version: v1.0.0
servers:
- url: https://api.gitpod.io
description: Gitpod API
tags:
- name: gitpod.v1.EnvironmentAutomationService
x-displayName: gitpod.v1.EnvironmentAutomationService
paths:
/gitpod.v1.EnvironmentAutomationService/CreateService:
servers: []
post:
description: "Creates a new automation service for an environment.\n\n Use this method to:\n - Set up long-running services\n - Configure service triggers\n - Define service dependencies\n - Specify runtime environments\n\n ### Examples\n\n - Create basic service:\n\n Creates a simple service with start command.\n\n ```yaml\n environmentId: \"07e03a28-65a5-4d98-b532-8ea67b188048\"\n metadata:\n reference: \"web-server\"\n name: \"Web Server\"\n description: \"Runs the development web server\"\n triggeredBy:\n - postDevcontainerStart: true\n spec:\n commands:\n start: \"npm run dev\"\n ready: \"curl -s http://localhost:3000\"\n ```\n\n - Create Docker-based service:\n\n Creates a service running in a specific container.\n\n ```yaml\n environmentId: \"07e03a28-65a5-4d98-b532-8ea67b188048\"\n metadata:\n reference: \"redis\"\n name: \"Redis Server\"\n description: \"Redis cache service\"\n spec:\n commands:\n start: \"redis-server\"\n runsOn:\n docker:\n image: \"redis:7\"\n ```"
operationId: gitpod.v1.EnvironmentAutomationService.CreateService
parameters: []
requestBody:
content:
application/json:
examples:
create_basic_service:
description: Creates a simple service with start command.
value:
environmentId: 07e03a28-65a5-4d98-b532-8ea67b188048
metadata:
description: Runs the development web server
name: Web Server
reference: web-server
triggeredBy:
- postDevcontainerStart: true
spec:
commands:
ready: curl -s http://localhost:3000
start: npm run dev
create_docker_based_service:
description: Creates a service running in a specific container.
value:
environmentId: 07e03a28-65a5-4d98-b532-8ea67b188048
metadata:
description: Redis cache service
name: Redis Server
reference: redis
spec:
commands:
start: redis-server
runsOn:
docker:
image: redis:7
schema:
$ref: '#/components/schemas/gitpod.v1.CreateServiceRequest'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/gitpod.v1.CreateServiceResponse'
description: Success
default:
content:
application/json:
schema:
$ref: '#/components/schemas/connect.error'
description: Error
security:
- bearerAuth: []
summary: CreateService
tags:
- gitpod.v1.EnvironmentAutomationService
/gitpod.v1.EnvironmentAutomationService/CreateTask:
servers: []
post:
description: "Creates a new automation task.\n\n Use this method to:\n - Define one-off or scheduled tasks\n - Set up build or test automation\n - Configure task dependencies\n - Specify execution environments\n\n ### Examples\n\n - Create basic task:\n\n Creates a simple build task.\n\n ```yaml\n environmentId: \"07e03a28-65a5-4d98-b532-8ea67b188048\"\n metadata:\n reference: \"build\"\n name: \"Build Project\"\n description: \"Builds the project artifacts\"\n triggeredBy:\n - postEnvironmentStart: true\n spec:\n command: \"npm run build\"\n ```\n\n - Create task with dependencies:\n\n Creates a task that depends on other services.\n\n ```yaml\n environmentId: \"07e03a28-65a5-4d98-b532-8ea67b188048\"\n metadata:\n reference: \"test\"\n name: \"Run Tests\"\n description: \"Runs the test suite\"\n spec:\n command: \"npm test\"\n dependsOn: [\"d2c94c27-3b76-4a42-b88c-95a85e392c68\"]\n ```"
operationId: gitpod.v1.EnvironmentAutomationService.CreateTask
parameters: []
requestBody:
content:
application/json:
examples:
create_basic_task:
description: Creates a simple build task.
value:
environmentId: 07e03a28-65a5-4d98-b532-8ea67b188048
metadata:
description: Builds the project artifacts
name: Build Project
reference: build
triggeredBy:
- postEnvironmentStart: true
spec:
command: npm run build
create_task_with_dependencies:
description: Creates a task that depends on other services.
value:
dependsOn:
- d2c94c27-3b76-4a42-b88c-95a85e392c68
environmentId: 07e03a28-65a5-4d98-b532-8ea67b188048
metadata:
description: Runs the test suite
name: Run Tests
reference: test
spec:
command: npm test
schema:
$ref: '#/components/schemas/gitpod.v1.CreateTaskRequest'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/gitpod.v1.CreateTaskResponse'
description: Success
default:
content:
application/json:
schema:
$ref: '#/components/schemas/connect.error'
description: Error
security:
- bearerAuth: []
summary: CreateTask
tags:
- gitpod.v1.EnvironmentAutomationService
/gitpod.v1.EnvironmentAutomationService/DeleteService:
servers: []
post:
description: "Deletes an automation service. This call does not block until the service is deleted.\n If the service is not stopped it will be stopped before deletion.\n\n Use this method to:\n - Remove unused services\n - Clean up service configurations\n - Stop and delete services\n\n ### Examples\n\n - Delete service:\n\n Removes a service after stopping it.\n\n ```yaml\n id: \"d2c94c27-3b76-4a42-b88c-95a85e392c68\"\n force: false\n ```\n\n - Force delete:\n\n Immediately removes a service.\n\n ```yaml\n id: \"d2c94c27-3b76-4a42-b88c-95a85e392c68\"\n force: true\n ```"
operationId: gitpod.v1.EnvironmentAutomationService.DeleteService
parameters: []
requestBody:
content:
application/json:
examples:
delete_service:
description: Removes a service after stopping it.
value:
force: false
id: d2c94c27-3b76-4a42-b88c-95a85e392c68
force_delete:
description: Immediately removes a service.
value:
force: true
id: d2c94c27-3b76-4a42-b88c-95a85e392c68
schema:
$ref: '#/components/schemas/gitpod.v1.DeleteServiceRequest'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/gitpod.v1.DeleteServiceResponse'
description: Success
default:
content:
application/json:
schema:
$ref: '#/components/schemas/connect.error'
description: Error
security:
- bearerAuth: []
summary: DeleteService
tags:
- gitpod.v1.EnvironmentAutomationService
/gitpod.v1.EnvironmentAutomationService/DeleteTask:
servers: []
post:
description: "Deletes an automation task.\n\n Use this method to:\n - Remove unused tasks\n - Clean up task configurations\n - Delete obsolete automations\n\n ### Examples\n\n - Delete task:\n\n Removes a task and its configuration.\n\n ```yaml\n id: \"d2c94c27-3b76-4a42-b88c-95a85e392c68\"\n ```"
operationId: gitpod.v1.EnvironmentAutomationService.DeleteTask
parameters: []
requestBody:
content:
application/json:
examples:
delete_task:
description: Removes a task and its configuration.
value:
id: d2c94c27-3b76-4a42-b88c-95a85e392c68
schema:
$ref: '#/components/schemas/gitpod.v1.DeleteTaskRequest'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/gitpod.v1.DeleteTaskResponse'
description: Success
default:
content:
application/json:
schema:
$ref: '#/components/schemas/connect.error'
description: Error
security:
- bearerAuth: []
summary: DeleteTask
tags:
- gitpod.v1.EnvironmentAutomationService
/gitpod.v1.EnvironmentAutomationService/GetService:
servers: []
post:
description: "Gets details about a specific automation service.\n\n Use this method to:\n - Check service status\n - View service configuration\n - Monitor service health\n - Retrieve service metadata\n\n ### Examples\n\n - Get service details:\n\n Retrieves information about a specific service.\n\n ```yaml\n id: \"d2c94c27-3b76-4a42-b88c-95a85e392c68\"\n ```"
operationId: gitpod.v1.EnvironmentAutomationService.GetService
parameters: []
requestBody:
content:
application/json:
examples:
get_service_details:
description: Retrieves information about a specific service.
value:
id: d2c94c27-3b76-4a42-b88c-95a85e392c68
schema:
$ref: '#/components/schemas/gitpod.v1.GetServiceRequest'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/gitpod.v1.GetServiceResponse'
description: Success
default:
content:
application/json:
schema:
$ref: '#/components/schemas/connect.error'
description: Error
security:
- bearerAuth: []
summary: GetService
tags:
- gitpod.v1.EnvironmentAutomationService
/gitpod.v1.EnvironmentAutomationService/GetTask:
servers: []
post:
description: "Gets details about a specific automation task.\n\n Use this method to:\n - Check task configuration\n - View task dependencies\n - Monitor task status\n\n ### Examples\n\n - Get task details:\n\n Retrieves information about a specific task.\n\n ```yaml\n id: \"d2c94c27-3b76-4a42-b88c-95a85e392c68\"\n ```"
operationId: gitpod.v1.EnvironmentAutomationService.GetTask
parameters: []
requestBody:
content:
application/json:
examples:
get_task_details:
description: Retrieves information about a specific task.
value:
id: d2c94c27-3b76-4a42-b88c-95a85e392c68
schema:
$ref: '#/components/schemas/gitpod.v1.GetTaskRequest'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/gitpod.v1.GetTaskResponse'
description: Success
default:
content:
application/json:
schema:
$ref: '#/components/schemas/connect.error'
description: Error
security:
- bearerAuth: []
summary: GetTask
tags:
- gitpod.v1.EnvironmentAutomationService
/gitpod.v1.EnvironmentAutomationService/GetTaskExecution:
servers: []
post:
description: "Gets details about a specific task execution.\n\n Use this method to:\n - Monitor execution progress\n - View execution logs\n - Check execution status\n - Debug failed executions\n\n ### Examples\n\n - Get execution details:\n\n Retrieves information about a specific task execution.\n\n ```yaml\n id: \"d2c94c27-3b76-4a42-b88c-95a85e392c68\"\n ```"
operationId: gitpod.v1.EnvironmentAutomationService.GetTaskExecution
parameters: []
requestBody:
content:
application/json:
examples:
get_execution_details:
description: Retrieves information about a specific task execution.
value:
id: d2c94c27-3b76-4a42-b88c-95a85e392c68
schema:
$ref: '#/components/schemas/gitpod.v1.GetTaskExecutionRequest'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/gitpod.v1.GetTaskExecutionResponse'
description: Success
default:
content:
application/json:
schema:
$ref: '#/components/schemas/connect.error'
description: Error
security:
- bearerAuth: []
summary: GetTaskExecution
tags:
- gitpod.v1.EnvironmentAutomationService
/gitpod.v1.EnvironmentAutomationService/ListServices:
servers: []
post:
description: "Lists automation services with optional filtering.\n\n Use this method to:\n - View all services in an environment\n - Filter services by reference\n - Monitor service status\n\n ### Examples\n\n - List environment services:\n\n Shows all services for an environment.\n\n ```yaml\n filter:\n environmentIds: [\"07e03a28-65a5-4d98-b532-8ea67b188048\"]\n pagination:\n pageSize: 20\n ```\n\n - Filter by reference:\n\n Lists services matching specific references.\n\n ```yaml\n filter:\n references: [\"web-server\", \"database\"]\n pagination:\n pageSize: 20\n ```"
operationId: gitpod.v1.EnvironmentAutomationService.ListServices
parameters:
- in: query
name: pageSize
schema:
default: 25
maximum: 100
minimum: 0
type: integer
- in: query
name: token
schema:
default: ''
type: string
requestBody:
content:
application/json:
examples:
filter_by_reference:
description: Lists services matching specific references.
value:
filter:
references:
- web-server
- database
pagination:
pageSize: 20
list_environment_services:
description: Shows all services for an environment.
value:
filter:
environmentIds:
- 07e03a28-65a5-4d98-b532-8ea67b188048
pagination:
pageSize: 20
schema:
$ref: '#/components/schemas/gitpod.v1.ListServicesRequest'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/gitpod.v1.ListServicesResponse'
description: Success
default:
content:
application/json:
schema:
$ref: '#/components/schemas/connect.error'
description: Error
security:
- bearerAuth: []
summary: ListServices
tags:
- gitpod.v1.EnvironmentAutomationService
/gitpod.v1.EnvironmentAutomationService/ListTaskExecutions:
servers: []
post:
description: "Lists executions of automation tasks.\n\n Use this method to:\n - View task execution history\n - Monitor running tasks\n - Track task completion status\n\n ### Examples\n\n - List all executions:\n\n Shows execution history for all tasks.\n\n ```yaml\n filter:\n environmentIds: [\"07e03a28-65a5-4d98-b532-8ea67b188048\"]\n pagination:\n pageSize: 20\n ```\n\n - Filter by phase:\n\n Lists executions in specific phases.\n\n ```yaml\n filter:\n phases: [\"TASK_EXECUTION_PHASE_RUNNING\", \"TASK_EXECUTION_PHASE_FAILED\"]\n pagination:\n pageSize: 20\n ```"
operationId: gitpod.v1.EnvironmentAutomationService.ListTaskExecutions
parameters:
- in: query
name: pageSize
schema:
default: 25
maximum: 100
minimum: 0
type: integer
- in: query
name: token
schema:
default: ''
type: string
requestBody:
content:
application/json:
examples:
filter_by_phase:
description: Lists executions in specific phases.
value:
filter:
phases:
- TASK_EXECUTION_PHASE_RUNNING
- TASK_EXECUTION_PHASE_FAILED
pagination:
pageSize: 20
list_all_executions:
description: Shows execution history for all tasks.
value:
filter:
environmentIds:
- 07e03a28-65a5-4d98-b532-8ea67b188048
pagination:
pageSize: 20
schema:
$ref: '#/components/schemas/gitpod.v1.ListTaskExecutionsRequest'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/gitpod.v1.ListTaskExecutionsResponse'
description: Success
default:
content:
application/json:
schema:
$ref: '#/components/schemas/connect.error'
description: Error
security:
- bearerAuth: []
summary: ListTaskExecutions
tags:
- gitpod.v1.EnvironmentAutomationService
/gitpod.v1.EnvironmentAutomationService/ListTasks:
servers: []
post:
description: "Lists automation tasks with optional filtering.\n\n Use this method to:\n - View all tasks in an environment\n - Filter tasks by reference\n - Monitor task status\n\n ### Examples\n\n - List environment tasks:\n\n Shows all tasks for an environment.\n\n ```yaml\n filter:\n environmentIds: [\"07e03a28-65a5-4d98-b532-8ea67b188048\"]\n pagination:\n pageSize: 20\n ```\n\n - Filter by reference:\n\n Lists tasks matching specific references.\n\n ```yaml\n filter:\n references: [\"build\", \"test\"]\n pagination:\n pageSize: 20\n ```"
operationId: gitpod.v1.EnvironmentAutomationService.ListTasks
parameters:
- in: query
name: pageSize
schema:
default: 25
maximum: 100
minimum: 0
type: integer
- in: query
name: token
schema:
default: ''
type: string
requestBody:
content:
application/json:
examples:
filter_by_reference:
description: Lists tasks matching specific references.
value:
filter:
references:
- build
- test
pagination:
pageSize: 20
list_environment_tasks:
description: Shows all tasks for an environment.
value:
filter:
environmentIds:
- 07e03a28-65a5-4d98-b532-8ea67b188048
pagination:
pageSize: 20
schema:
$ref: '#/components/schemas/gitpod.v1.ListTasksRequest'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/gitpod.v1.ListTasksResponse'
description: Success
default:
content:
application/json:
schema:
$ref: '#/components/schemas/connect.error'
description: Error
security:
- bearerAuth: []
summary: ListTasks
tags:
- gitpod.v1.EnvironmentAutomationService
/gitpod.v1.EnvironmentAutomationService/StartService:
servers: []
post:
description: "Starts an automation service. This call does not block until the service is started.\n This call will not error if the service is already running or has been started.\n\n Use this method to:\n - Start stopped services\n - Resume service operations\n - Trigger service initialization\n\n ### Examples\n\n - Start service:\n\n Starts a previously stopped service.\n\n ```yaml\n id: \"d2c94c27-3b76-4a42-b88c-95a85e392c68\"\n ```"
operationId: gitpod.v1.EnvironmentAutomationService.StartService
parameters: []
requestBody:
content:
application/json:
examples:
start_service:
description: Starts a previously stopped service.
value:
id: d2c94c27-3b76-4a42-b88c-95a85e392c68
schema:
$ref: '#/components/schemas/gitpod.v1.StartServiceRequest'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/gitpod.v1.StartServiceResponse'
description: Success
default:
content:
application/json:
schema:
$ref: '#/components/schemas/connect.error'
description: Error
security:
- bearerAuth: []
summary: StartService
tags:
- gitpod.v1.EnvironmentAutomationService
/gitpod.v1.EnvironmentAutomationService/StartTask:
servers: []
post:
description: "Starts a task by creating a new task execution.\n This call does not block until the task is started; the task will be started asynchronously.\n\n Use this method to:\n - Trigger task execution\n - Run one-off tasks\n - Start scheduled tasks immediately\n\n ### Examples\n\n - Start task:\n\n Creates a new execution of a task.\n\n ```yaml\n id: \"d2c94c27-3b76-4a42-b88c-95a85e392c68\"\n ```"
operationId: gitpod.v1.EnvironmentAutomationService.StartTask
parameters: []
requestBody:
content:
application/json:
examples:
start_task:
description: Creates a new execution of a task.
value:
id: d2c94c27-3b76-4a42-b88c-95a85e392c68
schema:
$ref: '#/components/schemas/gitpod.v1.StartTaskRequest'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/gitpod.v1.StartTaskResponse'
description: Success
default:
content:
application/json:
schema:
$ref: '#/components/schemas/connect.error'
description: Error
security:
- bearerAuth: []
summary: StartTask
tags:
- gitpod.v1.EnvironmentAutomationService
/gitpod.v1.EnvironmentAutomationService/StopService:
servers: []
post:
description: "Stops an automation service. This call does not block until the service is stopped.\n This call will not error if the service is already stopped or has been stopped.\n\n Use this method to:\n - Pause service operations\n - Gracefully stop services\n - Prepare for updates\n\n ### Examples\n\n - Stop service:\n\n Gracefully stops a running service.\n\n ```yaml\n id: \"d2c94c27-3b76-4a42-b88c-95a85e392c68\"\n ```"
operationId: gitpod.v1.EnvironmentAutomationService.StopService
parameters: []
requestBody:
content:
application/json:
examples:
stop_service:
description: Gracefully stops a running service.
value:
id: d2c94c27-3b76-4a42-b88c-95a85e392c68
schema:
$ref: '#/components/schemas/gitpod.v1.StopServiceRequest'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/gitpod.v1.StopServiceResponse'
description: Success
default:
content:
application/json:
schema:
$ref: '#/components/schemas/connect.error'
description: Error
security:
- bearerAuth: []
summary: StopService
tags:
- gitpod.v1.EnvironmentAutomationService
/gitpod.v1.EnvironmentAutomationService/StopTaskExecution:
servers: []
post:
description: "Stops a running task execution.\n\n Use this method to:\n - Cancel long-running tasks\n - Stop failed executions\n - Interrupt task processing\n\n ### Examples\n\n - Stop execution:\n\n Stops a running task execution.\n\n ```yaml\n id: \"d2c94c27-3b76-4a42-b88c-95a85e392c68\"\n ```"
operationId: gitpod.v1.EnvironmentAutomationService.StopTaskExecution
parameters: []
requestBody:
content:
application/json:
examples:
stop_execution:
description: Stops a running task execution.
value:
id: d2c94c27-3b76-4a42-b88c-95a85e392c68
schema:
$ref: '#/components/schemas/gitpod.v1.StopTaskExecutionRequest'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/gitpod.v1.StopTaskExecutionResponse'
description: Success
default:
content:
application/json:
schema:
$ref: '#/components/schemas/connect.error'
description: Error
security:
- bearerAuth: []
summary: StopTaskExecution
tags:
- gitpod.v1.EnvironmentAutomationService
/gitpod.v1.EnvironmentAutomationService/UpdateService:
servers: []
post:
description: "Updates an automation service configuration.\n\n Use this method to:\n - Modify service commands\n - Update triggers\n - Change runtime settings\n - Adjust dependencies\n\n ### Examples\n\n - Update commands:\n\n Changes service start and ready commands.\n\n ```yaml\n id: \"d2c94c27-3b76-4a42-b88c-95a85e392c68\"\n spec:\n commands:\n start: \"npm run start:dev\"\n ready: \"curl -s http://localhost:8080\"\n ```\n\n - Update triggers:\n\n Modifies when the service starts.\n\n ```yaml\n id: \"d2c94c27-3b76-4a42-b88c-95a85e392c68\"\n metadata:\n triggeredBy:\n trigger:\n - postDevcontainerStart: true\n - manual: true\n ```"
operationId: gitpod.v1.EnvironmentAutomationService.UpdateService
parameters: []
requestBody:
content:
application/json:
examples:
update_commands:
description: Changes service start and ready commands.
value:
id: d2c94c27-3b76-4a42-b88c-95a85e392c68
spec:
commands:
ready: curl -s http://localhost:8080
start: npm run start:dev
update_triggers:
description: Modifies when the service starts.
value:
id: d2c94c27-3b76-4a42-b88c-95a85e392c68
metadata:
triggeredBy:
trigger:
- postDevcontainerStart: true
- manual: true
schema:
$ref: '#/components/schemas/gitpod.v1.UpdateServiceRequest'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/gitpod.v1.UpdateServiceResponse'
description: Success
default:
content:
application/json:
schema:
$ref: '#/components/schemas/connect.error'
description: Error
security:
- bearerAuth: []
summary: UpdateService
tags:
- gitpod.v1.EnvironmentAutomationService
/gitpod.v1.EnvironmentAutomationService/UpdateTask:
servers: []
post:
description: "Updates an automation task configuration.\n\n Use this method to:\n - Modify task commands\n - Update task triggers\n - Change dependencies\n - Adjust execution settings\n\n ### Examples\n\n - Update command:\n\n Changes the task's command.\n\n ```yaml\n id: \"d2c94c27-3b76-4a42-b88c-95a85e392c68\"\n spec:\n command: \"npm run test:coverage\"\n ```\n\n - Update triggers:\n\n Modifies when the task runs.\n\n ```yaml\n id: \"d2c94c27-3b76-4a42-b88c-95a85e392c68\"\n metadata:\n triggeredBy:\n trigger:\n - postEnvironmentStart: true\n ```"
operationId: gitpod.v1.EnvironmentAutomationService.UpdateTask
parameters: []
requestBody:
content:
application/json:
examples:
update_command:
description: Changes the task's command.
value:
id: d2c94c27-3b76-4a42-b88c-95a85e392c68
spec:
command: npm run test:coverage
update_triggers:
description: Modifies when the task runs.
value:
id: d2c94c27-3b76-4a42-b88c-95a85e392c68
metadata:
triggeredBy:
trigger:
- postEnvironmentStart: true
schema:
$ref: '#/components/schemas/gitpod.v1.UpdateTaskRequest'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/gitpod.v1.UpdateTaskResponse'
description: Success
default:
content:
application/json:
schema:
$ref: '#/components/schemas/connect.error'
description: Error
security:
- bearerAuth: []
summary: UpdateTask
tags:
- gitpod.v1.EnvironmentAutomationService
/gitpod.v1.EnvironmentAutomationService/UpdateTaskExecutionStatus:
servers: []
post:
description: "Updates the status of a task execution.\n Only the environment executing a task execution is expected to call this function.\n\n Use this method to:\n - Report execution progress\n - Update step status\n - Set failure messages\n - Provide log URLs\n\n ### Examples\n\n - Update execution status:\n\n Updates status with step information.\n\n ```yaml\n id: \"d2c94c27-3b76-4a42-b88c-95a85e392c68\"\n steps:\n - id: \"step-1\"\n phase: TASK_EXECUTION_PHASE_SUCCEEDED\n logUrl: \"https://logs.gitpod.io/task-123\"\n ```\n\n - Report failure:\n\n Updates status with failure information.\n\n ```yaml\n id: \"d2c94c27-3b76-4a42-b88c-95a85e392c68\"\n failureMessage: \"Build failed due to missing dependencies\"\n steps:\n - id: \"step-1\"\n phase: TASK_EXECUTION_PHASE_FAILED\n failureMessage: \"npm install failed\"\n ```"
operationId: gitpod.v1.EnvironmentAutomationService.UpdateTaskExecutionStatus
parameters: []
requestBody:
content:
application/json:
examples:
report_failure:
description: Updates status with failure information.
value:
failureMessage: Build failed due to missing dependencies
id: d2c94c27-3b76-4a42-b88c-95a85e392c68
steps:
# --- truncated at 32 KB (89 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/gitpod/refs/heads/main/openapi/gitpod-gitpod-v1-environmentautomationservice-api-openapi.yml