gitpod.v1.WorkflowService

UpdateWorkflow

Updates a workflow's configuration using full replacement semantics.

Update Behavior:

  • All provided fields completely replace existing values
  • Optional fields that are not provided remain unchanged
  • Complex fields (triggers, action) are replaced entirely, not merged
  • To remove optional fields, explicitly set them to empty/default values

Use this method to:

  • Modify workflow settings
  • Update triggers and actions
  • Change execution limits
  • Update workflow steps

Examples

  • Update workflow name:

    Changes the workflow's display name.

    workflowId: "b0e12f6c-4c67-429d-a4a6-d9838b5da047"
    name: "Updated Workflow Name"
    
  • Replace all triggers:

    Completely replaces the workflow's trigger configuration.

    workflowId: "b0e12f6c-4c67-429d-a4a6-d9838b5da047"
    triggers:
      - manual: {}
        context:
          projects:
            projectIds: ["new-project-id"]
    
  • Update execution limits:

    Completely replaces the workflow's action configuration.

    workflowId: "b0e12f6c-4c67-429d-a4a6-d9838b5da047"
    action:
      limits:
        maxParallel: 10
        maxTotal: 100
      steps:
        - task:
            command: "npm test"
    
post/gitpod.v1.WorkflowService/UpdateWorkflow

Request body

GitpodV1UpdateWorkflowRequest required— unresolved $ref

Response

Success

Changes