Gitpod gitpod.v1.WorkflowService API
The gitpod.v1.WorkflowService API from Gitpod — 16 operation(s) for gitpod.v1.workflowservice.
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/gitpod-gitpod-v1-workflowservice-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
title: gitpod.v1 gitpod.v1.AccountService Gitpod.v1.Workflow Service API
version: v1.0.0
servers:
- url: https://api.gitpod.io
description: Gitpod API
tags:
- name: gitpod.v1.WorkflowService
x-displayName: gitpod.v1.WorkflowService
paths:
/gitpod.v1.WorkflowService/CancelWorkflowExecution:
servers: []
post:
description: "Cancels a running workflow execution.\n\n Use this method to:\n - Stop long-running executions\n - Cancel failed executions\n - Manage resource usage\n\n ### Examples\n\n - Cancel execution:\n\n Stops a running workflow execution.\n\n ```yaml\n workflowExecutionId: \"d2c94c27-3b76-4a42-b88c-95a85e392c68\"\n ```"
operationId: gitpod.v1.WorkflowService.CancelWorkflowExecution
parameters: []
requestBody:
content:
application/json:
examples:
cancel_execution:
description: Stops a running workflow execution.
value:
workflowExecutionId: d2c94c27-3b76-4a42-b88c-95a85e392c68
schema:
$ref: '#/components/schemas/gitpod.v1.CancelWorkflowExecutionRequest'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/gitpod.v1.CancelWorkflowExecutionResponse'
description: Success
default:
content:
application/json:
schema:
$ref: '#/components/schemas/connect.error'
description: Error
security:
- bearerAuth: []
summary: CancelWorkflowExecution
tags:
- gitpod.v1.WorkflowService
/gitpod.v1.WorkflowService/CancelWorkflowExecutionAction:
servers: []
post:
description: "Cancels a running workflow execution action.\n\n Use this method to:\n - Stop long-running actions\n - Cancel failed actions\n - Manage resource usage\n\n ### Examples\n\n - Cancel execution action:\n\n Stops a running workflow execution action.\n\n ```yaml\n workflowExecutionActionId: \"a1b2c3d4-5e6f-7890-abcd-ef1234567890\"\n ```"
operationId: gitpod.v1.WorkflowService.CancelWorkflowExecutionAction
parameters: []
requestBody:
content:
application/json:
examples:
cancel_execution_action:
description: Stops a running workflow execution action.
value:
workflowExecutionActionId: a1b2c3d4-5e6f-7890-abcd-ef1234567890
schema:
$ref: '#/components/schemas/gitpod.v1.CancelWorkflowExecutionActionRequest'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/gitpod.v1.CancelWorkflowExecutionActionResponse'
description: Success
default:
content:
application/json:
schema:
$ref: '#/components/schemas/connect.error'
description: Error
security:
- bearerAuth: []
summary: CancelWorkflowExecutionAction
tags:
- gitpod.v1.WorkflowService
/gitpod.v1.WorkflowService/CreateWorkflow:
servers: []
post:
description: "Creates a new workflow with specified configuration.\n\n Use this method to:\n - Set up automated workflows\n - Configure workflow triggers\n - Define workflow actions and steps\n - Set execution limits and constraints"
operationId: gitpod.v1.WorkflowService.CreateWorkflow
parameters: []
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/gitpod.v1.CreateWorkflowRequest'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/gitpod.v1.CreateWorkflowResponse'
description: Success
default:
content:
application/json:
schema:
$ref: '#/components/schemas/connect.error'
description: Error
security:
- bearerAuth: []
summary: CreateWorkflow
tags:
- gitpod.v1.WorkflowService
/gitpod.v1.WorkflowService/DeleteWorkflow:
servers: []
post:
description: "Deletes a workflow permanently.\n\n Use this method to:\n - Remove unused workflows\n - Clean up test workflows\n - Delete obsolete configurations\n\n ### Examples\n\n - Delete workflow:\n\n Permanently removes a workflow.\n\n ```yaml\n workflowId: \"b0e12f6c-4c67-429d-a4a6-d9838b5da047\"\n ```"
operationId: gitpod.v1.WorkflowService.DeleteWorkflow
parameters: []
requestBody:
content:
application/json:
examples:
delete_workflow:
description: Permanently removes a workflow.
value:
workflowId: b0e12f6c-4c67-429d-a4a6-d9838b5da047
schema:
$ref: '#/components/schemas/gitpod.v1.DeleteWorkflowRequest'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/gitpod.v1.DeleteWorkflowResponse'
description: Success
default:
content:
application/json:
schema:
$ref: '#/components/schemas/connect.error'
description: Error
security:
- bearerAuth: []
summary: DeleteWorkflow
tags:
- gitpod.v1.WorkflowService
/gitpod.v1.WorkflowService/GetWorkflow:
servers: []
post:
description: "Gets details about a specific workflow.\n\n Use this method to:\n - View workflow configuration\n - Check workflow status\n - Get workflow metadata\n\n ### Examples\n\n - Get workflow details:\n\n Retrieves information about a specific workflow.\n\n ```yaml\n workflowId: \"b0e12f6c-4c67-429d-a4a6-d9838b5da047\"\n ```"
operationId: gitpod.v1.WorkflowService.GetWorkflow
parameters: []
requestBody:
content:
application/json:
examples:
get_workflow_details:
description: Retrieves information about a specific workflow.
value:
workflowId: b0e12f6c-4c67-429d-a4a6-d9838b5da047
schema:
$ref: '#/components/schemas/gitpod.v1.GetWorkflowRequest'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/gitpod.v1.GetWorkflowResponse'
description: Success
default:
content:
application/json:
schema:
$ref: '#/components/schemas/connect.error'
description: Error
security:
- bearerAuth: []
summary: GetWorkflow
tags:
- gitpod.v1.WorkflowService
/gitpod.v1.WorkflowService/GetWorkflowExecution:
servers: []
post:
description: "Gets details about a specific workflow execution.\n\n Use this method to:\n - Check execution status\n - View execution results\n - Monitor execution progress\n\n ### Examples\n\n - Get execution details:\n\n Retrieves information about a specific execution.\n\n ```yaml\n workflowExecutionId: \"d2c94c27-3b76-4a42-b88c-95a85e392c68\"\n ```"
operationId: gitpod.v1.WorkflowService.GetWorkflowExecution
parameters: []
requestBody:
content:
application/json:
examples:
get_execution_details:
description: Retrieves information about a specific execution.
value:
workflowExecutionId: d2c94c27-3b76-4a42-b88c-95a85e392c68
schema:
$ref: '#/components/schemas/gitpod.v1.GetWorkflowExecutionRequest'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/gitpod.v1.GetWorkflowExecutionResponse'
description: Success
default:
content:
application/json:
schema:
$ref: '#/components/schemas/connect.error'
description: Error
security:
- bearerAuth: []
summary: GetWorkflowExecution
tags:
- gitpod.v1.WorkflowService
/gitpod.v1.WorkflowService/GetWorkflowExecutionAction:
servers: []
post:
description: "Gets details about a specific workflow execution action.\n\n Use this method to:\n - Check execution action status\n - View execution action results\n - Monitor execution action progress\n\n ### Examples\n\n - Get execution action details:\n\n Retrieves information about a specific execution action.\n\n ```yaml\n workflowExecutionActionId: \"a1b2c3d4-5e6f-7890-abcd-ef1234567890\"\n ```"
operationId: gitpod.v1.WorkflowService.GetWorkflowExecutionAction
parameters: []
requestBody:
content:
application/json:
examples:
get_execution_action_details:
description: Retrieves information about a specific execution action.
value:
workflowExecutionActionId: a1b2c3d4-5e6f-7890-abcd-ef1234567890
schema:
$ref: '#/components/schemas/gitpod.v1.GetWorkflowExecutionActionRequest'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/gitpod.v1.GetWorkflowExecutionActionResponse'
description: Success
default:
content:
application/json:
schema:
$ref: '#/components/schemas/connect.error'
description: Error
security:
- bearerAuth: []
summary: GetWorkflowExecutionAction
tags:
- gitpod.v1.WorkflowService
/gitpod.v1.WorkflowService/GetWorkflowExecutionSummary:
servers: []
post:
description: "Returns aggregate counts of workflow executions within a time range.\n\n Use this method to:\n - Get a summary of successful, failed, and total executions\n - Build dashboard views of automation activity\n\n ### Examples\n\n - Get execution summary for the last 7 days:\n\n ```yaml\n filter:\n dateRange:\n startTime: \"2026-03-05T00:00:00Z\"\n endTime: \"2026-03-12T00:00:00Z\"\n ```\n\n - Get execution summary for specific workflows:\n\n ```yaml\n filter:\n dateRange:\n startTime: \"2026-03-01T00:00:00Z\"\n endTime: \"2026-03-12T00:00:00Z\"\n workflowIds: [\"b0e12f6c-4c67-429d-a4a6-d9838b5da047\"]\n ```"
operationId: gitpod.v1.WorkflowService.GetWorkflowExecutionSummary
parameters: []
requestBody:
content:
application/json:
examples:
get_execution_summary_for_specific_workflows:
description: "filter:\n dateRange:\n startTime: \"2026-03-01T00:00:00Z\"\n endTime: \"2026-03-12T00:00:00Z\"\n workflowIds: [\"b0e12f6c-4c67-429d-a4a6-d9838b5da047\"]\n"
value:
filter:
dateRange:
endTime: '2026-03-12T00:00:00Z'
startTime: '2026-03-01T00:00:00Z'
workflowIds:
- b0e12f6c-4c67-429d-a4a6-d9838b5da047
get_execution_summary_for_the_last_7_days:
description: "filter:\n dateRange:\n startTime: \"2026-03-05T00:00:00Z\"\n endTime: \"2026-03-12T00:00:00Z\"\n"
value:
filter:
dateRange:
endTime: '2026-03-12T00:00:00Z'
startTime: '2026-03-05T00:00:00Z'
schema:
$ref: '#/components/schemas/gitpod.v1.GetWorkflowExecutionSummaryRequest'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/gitpod.v1.GetWorkflowExecutionSummaryResponse'
description: Success
default:
content:
application/json:
schema:
$ref: '#/components/schemas/connect.error'
description: Error
security:
- bearerAuth: []
summary: GetWorkflowExecutionSummary
tags:
- gitpod.v1.WorkflowService
/gitpod.v1.WorkflowService/GetWorkflowWebhookSecret:
servers: []
post:
description: "Gets the webhook secret for a workflow.\n\n This operation is audited for security purposes.\n\n Use this method to:\n - Retrieve webhook secret for configuration\n - Set up webhook integrations\n - Verify webhook signatures\n\n ### Examples\n\n - Get webhook secret:\n\n Retrieves the webhook secret for a workflow.\n\n ```yaml\n workflowId: \"b0e12f6c-4c67-429d-a4a6-d9838b5da047\"\n ```"
operationId: gitpod.v1.WorkflowService.GetWorkflowWebhookSecret
parameters: []
requestBody:
content:
application/json:
examples:
get_webhook_secret:
description: Retrieves the webhook secret for a workflow.
value:
workflowId: b0e12f6c-4c67-429d-a4a6-d9838b5da047
schema:
$ref: '#/components/schemas/gitpod.v1.GetWorkflowWebhookSecretRequest'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/gitpod.v1.GetWorkflowWebhookSecretResponse'
description: Success
default:
content:
application/json:
schema:
$ref: '#/components/schemas/connect.error'
description: Error
security:
- bearerAuth: []
summary: GetWorkflowWebhookSecret
tags:
- gitpod.v1.WorkflowService
/gitpod.v1.WorkflowService/ListWorkflowExecutionActions:
servers: []
post:
description: "Lists workflow execution actions with optional filtering.\n\n Use this method to:\n - Monitor individual action execution status\n - Debug action failures\n - Track resource usage per action\n\n ### Examples\n\n - List execution actions for workflow execution:\n\n Shows all execution actions for a specific workflow execution.\n\n ```yaml\n filter:\n workflowExecutionIds: [\"d2c94c27-3b76-4a42-b88c-95a85e392c68\"]\n pagination:\n pageSize: 20\n ```"
operationId: gitpod.v1.WorkflowService.ListWorkflowExecutionActions
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:
list_execution_actions_for_workflow_execution:
description: Shows all execution actions for a specific workflow execution.
value:
filter:
workflowExecutionIds:
- d2c94c27-3b76-4a42-b88c-95a85e392c68
pagination:
pageSize: 20
schema:
$ref: '#/components/schemas/gitpod.v1.ListWorkflowExecutionActionsRequest'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/gitpod.v1.ListWorkflowExecutionActionsResponse'
description: Success
default:
content:
application/json:
schema:
$ref: '#/components/schemas/connect.error'
description: Error
security:
- bearerAuth: []
summary: ListWorkflowExecutionActions
tags:
- gitpod.v1.WorkflowService
/gitpod.v1.WorkflowService/ListWorkflowExecutionOutputs:
servers: []
post:
description: "Lists outputs produced by workflow execution actions.\n\n Use this method to:\n - Retrieve test results, coverage metrics, or other structured data from executions\n - Aggregate outputs across multiple workflow executions\n - Build dashboards or reports from execution data\n\n ### Examples\n\n - List outputs for a workflow execution:\n\n Retrieves all outputs produced by actions in the specified execution.\n\n ```yaml\n filter:\n workflowExecutionIds: [\"d2c94c27-3b76-4a42-b88c-95a85e392c68\"]\n pagination:\n pageSize: 50\n ```"
operationId: gitpod.v1.WorkflowService.ListWorkflowExecutionOutputs
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:
list_outputs_for_a_workflow_execution:
description: Retrieves all outputs produced by actions in the specified execution.
value:
filter:
workflowExecutionIds:
- d2c94c27-3b76-4a42-b88c-95a85e392c68
pagination:
pageSize: 50
schema:
$ref: '#/components/schemas/gitpod.v1.ListWorkflowExecutionOutputsRequest'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/gitpod.v1.ListWorkflowExecutionOutputsResponse'
description: Success
default:
content:
application/json:
schema:
$ref: '#/components/schemas/connect.error'
description: Error
security:
- bearerAuth: []
summary: ListWorkflowExecutionOutputs
tags:
- gitpod.v1.WorkflowService
/gitpod.v1.WorkflowService/ListWorkflowExecutions:
servers: []
post:
description: "Lists workflow executions with optional filtering.\n\n Use this method to:\n - Monitor workflow execution history\n - Track execution status\n - Debug workflow issues\n\n ### Examples\n\n - List executions for workflow:\n\n Shows all executions for a specific workflow.\n\n ```yaml\n filter:\n workflowIds: [\"b0e12f6c-4c67-429d-a4a6-d9838b5da047\"]\n pagination:\n pageSize: 20\n ```"
operationId: gitpod.v1.WorkflowService.ListWorkflowExecutions
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:
list_executions_for_workflow:
description: Shows all executions for a specific workflow.
value:
filter:
workflowIds:
- b0e12f6c-4c67-429d-a4a6-d9838b5da047
pagination:
pageSize: 20
schema:
$ref: '#/components/schemas/gitpod.v1.ListWorkflowExecutionsRequest'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/gitpod.v1.ListWorkflowExecutionsResponse'
description: Success
default:
content:
application/json:
schema:
$ref: '#/components/schemas/connect.error'
description: Error
security:
- bearerAuth: []
summary: ListWorkflowExecutions
tags:
- gitpod.v1.WorkflowService
/gitpod.v1.WorkflowService/ListWorkflows:
servers: []
post:
operationId: gitpod.v1.WorkflowService.ListWorkflows
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:
schema:
$ref: '#/components/schemas/gitpod.v1.ListWorkflowsRequest'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/gitpod.v1.ListWorkflowsResponse'
description: Success
default:
content:
application/json:
schema:
$ref: '#/components/schemas/connect.error'
description: Error
security:
- bearerAuth: []
summary: ListWorkflows
tags:
- gitpod.v1.WorkflowService
/gitpod.v1.WorkflowService/RotateWorkflowWebhookSecret:
servers: []
post:
description: "Rotates the webhook secret for a workflow.\n\n Use this method to:\n - Generate a new webhook secret\n - Invalidate the old webhook secret\n\n ### Examples\n\n - Rotate webhook secret:\n\n Generates a new webhook secret for the workflow.\n\n ```yaml\n workflowId: \"b0e12f6c-4c67-429d-a4a6-d9838b5da047\"\n ```"
operationId: gitpod.v1.WorkflowService.RotateWorkflowWebhookSecret
parameters: []
requestBody:
content:
application/json:
examples:
rotate_webhook_secret:
description: Generates a new webhook secret for the workflow.
value:
workflowId: b0e12f6c-4c67-429d-a4a6-d9838b5da047
schema:
$ref: '#/components/schemas/gitpod.v1.RotateWorkflowWebhookSecretRequest'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/gitpod.v1.RotateWorkflowWebhookSecretResponse'
description: Success
default:
content:
application/json:
schema:
$ref: '#/components/schemas/connect.error'
description: Error
security:
- bearerAuth: []
summary: RotateWorkflowWebhookSecret
tags:
- gitpod.v1.WorkflowService
/gitpod.v1.WorkflowService/StartWorkflow:
servers: []
post:
description: "Starts a workflow execution.\n\n Use this method to:\n - Start workflow execution on demand\n - Test workflow configurations\n - Run workflows outside of automatic triggers\n\n ### Examples\n\n - Start workflow:\n\n Starts a workflow execution manually.\n\n ```yaml\n workflowId: \"b0e12f6c-4c67-429d-a4a6-d9838b5da047\"\n ```"
operationId: gitpod.v1.WorkflowService.StartWorkflow
parameters: []
requestBody:
content:
application/json:
examples:
start_workflow:
description: Starts a workflow execution manually.
value:
workflowId: b0e12f6c-4c67-429d-a4a6-d9838b5da047
schema:
$ref: '#/components/schemas/gitpod.v1.StartWorkflowRequest'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/gitpod.v1.StartWorkflowResponse'
description: Success
default:
content:
application/json:
schema:
$ref: '#/components/schemas/connect.error'
description: Error
security:
- bearerAuth: []
summary: StartWorkflow
tags:
- gitpod.v1.WorkflowService
/gitpod.v1.WorkflowService/UpdateWorkflow:
servers: []
post:
description: "Updates a workflow's configuration using full replacement semantics.\n\n Update Behavior:\n - All provided fields completely replace existing values\n - Optional fields that are not provided remain unchanged\n - Complex fields (triggers, action) are replaced entirely, not merged\n - To remove optional fields, explicitly set them to empty/default values\n\n Use this method to:\n - Modify workflow settings\n - Update triggers and actions\n - Change execution limits\n - Update workflow steps\n\n ### Examples\n\n - Update workflow name:\n\n Changes the workflow's display name.\n\n ```yaml\n workflowId: \"b0e12f6c-4c67-429d-a4a6-d9838b5da047\"\n name: \"Updated Workflow Name\"\n ```\n\n - Replace all triggers:\n\n Completely replaces the workflow's trigger configuration.\n\n ```yaml\n workflowId: \"b0e12f6c-4c67-429d-a4a6-d9838b5da047\"\n triggers:\n - manual: {}\n context:\n projects:\n projectIds: [\"new-project-id\"]\n ```\n\n - Update execution limits:\n\n Completely replaces the workflow's action configuration.\n\n ```yaml\n workflowId: \"b0e12f6c-4c67-429d-a4a6-d9838b5da047\"\n action:\n limits:\n maxParallel: 10\n maxTotal: 100\n steps:\n - task:\n command: \"npm test\"\n ```"
operationId: gitpod.v1.WorkflowService.UpdateWorkflow
parameters: []
requestBody:
content:
application/json:
examples:
replace_all_triggers:
description: Completely replaces the workflow's trigger configuration.
value:
triggers:
- context:
projects:
projectIds:
- new-project-id
manual: {}
workflowId: b0e12f6c-4c67-429d-a4a6-d9838b5da047
update_execution_limits:
description: Completely replaces the workflow's action configuration.
value:
action:
limits:
maxParallel: 10
maxTotal: 100
steps:
- task:
command: npm test
workflowId: b0e12f6c-4c67-429d-a4a6-d9838b5da047
update_workflow_name:
description: Changes the workflow's display name.
value:
name: Updated Workflow Name
workflowId: b0e12f6c-4c67-429d-a4a6-d9838b5da047
schema:
$ref: '#/components/schemas/gitpod.v1.UpdateWorkflowRequest'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/gitpod.v1.UpdateWorkflowResponse'
description: Success
default:
content:
application/json:
schema:
$ref: '#/components/schemas/connect.error'
description: Error
security:
- bearerAuth: []
summary: UpdateWorkflow
tags:
- gitpod.v1.WorkflowService
components:
schemas:
gitpod.v1.Workflow.Metadata:
additionalProperties: false
description: WorkflowMetadata contains workflow metadata.
properties:
createdAt:
$ref: '#/components/schemas/google.protobuf.Timestamp'
title: created_at
creator:
$ref: '#/components/schemas/gitpod.v1.Subject'
title: creator
description:
maxLength: 500
title: description
type: string
executor:
$ref: '#/components/schemas/gitpod.v1.Subject'
title: executor
name:
maxLength: 80
minLength: 1
title: name
type: string
updatedAt:
$ref: '#/components/schemas/google.protobuf.Timestamp'
title: updated_at
title: Metadata
type: object
gitpod.v1.WorkflowError:
additionalProperties: false
description: "WorkflowError provides structured error information for workflow failures.\n This enables the reconciler to make informed retry decisions and the frontend\n to display actionable error messages."
properties:
code:
$ref: '#/components/schemas/gitpod.v1.WorkflowErrorCode'
description: Error code identifying the type of error.
title: code
message:
description: Human-readable error message.
title: message
type: string
meta:
additionalProperties:
title: value
type: string
description: "Additional metadata about the error.\n Common keys include:\n - environment_id: ID of the environment\n - task_id: ID of the task\n - service_id: ID of the service\n - workflow_id: ID of the workflow\n - workflow_execution_id: ID of the workflow execution"
title: meta
type: object
reason:
description: "Reason explaining why the error occurred.\n Examples: \"not_found\", \"stopped\", \"deleted\", \"creation_failed\", \"start_failed\""
title: reason
type: string
retry:
$ref: '#/components/schemas/gitpod.v1.WorkflowError.Retry'
description: Retry configuration. If not set, the error is considered non-retriable.
title: retry
title: WorkflowError
type: object
gitpod.v1.ListWorkflowExecutionActionsRequest:
additionalProperties: false
description: ListWorkflowExecutionActionsRequest lists workflow execution actions with optional filtering.
properties:
filter:
$ref: '#/components/schemas/gitpod.v1.ListWorkflowExecutionActionsRequest.Filter'
title: filter
pagination:
$ref: '#/components/schemas/gitpod.v1.PaginationRequest'
title: pagination
title: ListWorkflowExecutionActionsRequest
type: object
gitpod.v1.PullRequest.State:
description: Current state of the pull request
enum:
- STATE_UNSPECIFIED
- STATE_OPEN
- STATE_CLOSED
- STATE_MERGED
title: State
type: string
gitpod.v1.GetWorkflowExecutionActionResponse:
additionalProperties: false
properties:
workflowExecutionAction:
$ref: '#/components/schemas/gitpod.v1.WorkflowExecutionAction'
title: workflow_execution_action
title: GetWorkflowExecutionActionResponse
type: object
gitpod.v1.WorkflowExecution.Spec:
additionalProperties: false
description: WorkflowExecutionSpec contains the specification used for this execution.
properties:
action:
$ref: '#/components/schemas/gitpod.v1.WorkflowAction'
title: action
desiredPhase:
$ref: '#/components/schemas/gitpod.v1.WorkflowExecutionPhase'
title: desired_phase
x-stainless-skip: true
report:
$ref: '#/components/schemas/gitpod.v1.WorkflowAction'
title: report
session:
title: session
type: string
x-stainless-skip: true
trigger:
$ref: '#/components/schemas/gitpod.v1.WorkflowExecutionTrigger'
title: trigger
title: Spec
type: object
gitpod.v1.WorkflowExecutionAction:
additionalProperties: false
description: WorkflowExecutionAction represents a workflow execution action instance.
properties:
id:
format: uuid
title: id
type: string
metadata:
$ref: '#/components/schemas/gitpod.v1.WorkflowExecutionAction.Metadata'
title: metadata
spec:
$ref: '#/components/schemas/gitpod.v1.WorkflowExecutionAction.Spec'
title: spec
status:
$ref: '#/components/schemas/gitpod.v1.WorkflowExecutionAction.Status'
title: status
title: WorkflowExecutionAction
type: object
gitpod.v1.GetWorkflowRequest:
additionalProperties: false
description: GetWorkflowRequest gets details about a specific workflow.
properties:
workflowId:
format: uuid
title: workflow_id
type: string
title: GetWorkflowRequest
type: object
google.protobuf.Duration:
description: "A Duration represents a signed, fixed-length span of time represented\n as a count of seconds and fractions of seconds at nanosecond\n resolution. It is independ
# --- truncated at 32 KB (103 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/gitpod/refs/heads/main/openapi/gitpod-gitpod-v1-workflowservice-api-openapi.yml