gitpod.v1.AccountService10

gitpod.v1.AgentSecurityService1

gitpod.v1.AgentService24

gitpod.v1.BaseSnapshotService6

gitpod.v1.BillingService48

gitpod.v1.EditorService3

gitpod.v1.EnvironmentAutomationService18

gitpod.v1.EnvironmentService16

gitpod.v1.ErrorsService1

gitpod.v1.EventService3

gitpod.v1.GatewayService1

gitpod.v1.GroupService14

gitpod.v1.IdentityService3

gitpod.v1.InsightsService6

gitpod.v1.IntegrationService13

gitpod.v1.NotificationService5

gitpod.v1.OnaIntelligenceService5

gitpod.v1.OrganizationService48

gitpod.v1.PrebuildService11

gitpod.v1.ProjectService15

gitpod.v1.RunnerConfigurationService22

gitpod.v1.RunnerInteractionService33

gitpod.v1.RunnerManagerService6

gitpod.v1.RunnerService16

gitpod.v1.SecretService5

gitpod.v1.SecurityService5

gitpod.v1.ServiceAccountService10

gitpod.v1.SessionService9

gitpod.v1.TeamService8

gitpod.v1.UsageService18

gitpod.v1.UserService14

gitpod.v1.WebhookService8

gitpod.v1.WorkflowService16

gitpod.v1.EnvironmentAutomationService

UpdateTask

Updates an automation task configuration.

Use this method to:

Modify task commands
Update task triggers
Change dependencies
Adjust execution settings

Examples

Update command:

Changes the task's command.

id: "d2c94c27-3b76-4a42-b88c-95a85e392c68"
spec:
  command: "npm run test:coverage"

Update triggers:

Modifies when the task runs.

id: "d2c94c27-3b76-4a42-b88c-95a85e392c68"
metadata:
  triggeredBy:
    trigger:
      - postEnvironmentStart: true

post/gitpod.v1.EnvironmentAutomationService/UpdateTask

Request body

dependsOnstring[]

dependencies specifies the IDs of the automations this task depends on.

idstring uuid

specGitpodV1UpdateTaskRequestTaskSpec — unresolved $ref

Response

Success

GitpodV1UpdateTaskResponse required

Changes

Changed in 6 of the 18 revisions of this API.7417

Jul 30, 202644d50c2ac284112See the full diff
- ▲
  removed subschema #1 subschema #2 subschema #3 from the spec/runsOn request property oneOf list
  request-property-one-of-removed
- ●
  removed the request property spec/runsOn/terminal
  request-property-removed
- ○
  added the new optional request property spec/prebuildRequiresSuccess
  new-optional-request-property
- ○
  added subschema #1 subschema #2 to the spec/runsOn request property oneOf list
  request-property-one-of-added
This revision also has 24 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Apr 2, 2026dabc0ff98cd712See the full diff
- ▲
  removed subschema #1 subschema #2 from the spec/runsOn request property oneOf list
  request-property-one-of-removed
- ○
  added the new optional request property spec/runsOn/terminal
  new-optional-request-property
- ○
  added subschema #1 subschema #2 subschema #3 to the spec/runsOn request property oneOf list
  request-property-one-of-added
Jan 21, 20262423c089f28012See the full diff
- ▲
  removed subschema #1 subschema #2 subschema #3 subschema #4 subschema #5 from the metadata/triggeredBy/trigger/items/ request property oneOf list
  request-property-one-of-removed
- ○
  added the new optional request property metadata/triggeredBy/trigger/items/beforeSnapshot
  new-optional-request-property
- ○
  added subschema #1 subschema #2 subschema #3 subschema #4 subschema #5 subschema #6 to the metadata/triggeredBy/trigger/items/ request property oneOf list
  request-property-one-of-added
Dec 15, 2025d62ef4b9187c26See the full diff
- ▲
  removed subschema #1 from the spec/runsOn request property oneOf list
  request-property-one-of-removed
- ▲
  removed subschema #1 subschema #2 subschema #3 from the metadata/triggeredBy/trigger/items/ request property oneOf list
  request-property-one-of-removed
- ○
  added the new optional request property metadata/triggeredBy/trigger/items/postMachineStart
  new-optional-request-property
- ○
  added the new optional request property metadata/triggeredBy/trigger/items/prebuild
  new-optional-request-property
- ○
  added the new optional request property spec/env
  new-optional-request-property
- ○
  added the new optional request property spec/runsOn/machine
  new-optional-request-property
- ○
  added subschema #1 subschema #2 to the spec/runsOn request property oneOf list
  request-property-one-of-added
- ○
  added subschema #1 subschema #2 subschema #3 subschema #4 subschema #5 to the metadata/triggeredBy/trigger/items/ request property oneOf list
  request-property-one-of-added
This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Feb 21, 20253655d5ad0ac3225See the full diff
- ▲
  the metadata request property type/format changed from / to object/
  request-property-type-changed
- ▲
  the spec request property type/format changed from / to object/
  request-property-type-changed
- ●
  removed gitpod.v1.UpdateTaskRequest.TaskMetadata from the metadata request property allOf list
  request-property-all-of-removed
- ●
  removed gitpod.v1.UpdateTaskRequest.TaskSpec from the spec request property allOf list
  request-property-all-of-removed
- ○
  added the new optional request property metadata/description
  new-optional-request-property
- ○
  added the new optional request property metadata/name
  new-optional-request-property
- ○
  added the new optional request property metadata/triggeredBy
  new-optional-request-property
- ○
  added the new optional request property spec/command
  new-optional-request-property
- ○
  added the new optional request property spec/runsOn
  new-optional-request-property
Feb 18, 2025cd6a05ae99d21See the full diff
- ●
  removed the optional property detail from the response with the default status
  response-optional-property-removed

Full history