Gitpod gitpod.v1.WorkflowService API
The gitpod.v1.WorkflowService API from Gitpod — 16 operation(s) for gitpod.v1.workflowservice.
Gitpod gitpod.v1.WorkflowService API is one of 34 APIs that Gitpod publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
The published artifact set on APIs.io includes an OpenAPI specification and API documentation.
This API exposes 16 operations across 16 paths, and defines 105 schemas. It is described by OpenAPI 3.0.0, at version v1.0.0.
Requests are made against a single base URL, https://api.gitpod.io.
16 operations
16 paths
105 schemas
16 POST
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Gitpod gitpod.v1.WorkflowService API declares
1 security scheme
for authenticating requests.
It accepts HTTP bearer tokens (JWT) (bearerAuth).
Paths & Operations 16
Across 16 paths, the API surfaces 16 operations — 16 POST. Each is listed below with its method, path, parameters, and response codes.
gitpod.v1.WorkflowService 16
POST
/gitpod.v1.WorkflowService/CancelWorkflowExecution
CancelWorkflowExecution
POST
/gitpod.v1.WorkflowService/CancelWorkflowExecutionAction
CancelWorkflowExecutionAction
POST
/gitpod.v1.WorkflowService/CreateWorkflow
CreateWorkflow
POST
/gitpod.v1.WorkflowService/DeleteWorkflow
DeleteWorkflow
POST
/gitpod.v1.WorkflowService/GetWorkflow
GetWorkflow
POST
/gitpod.v1.WorkflowService/GetWorkflowExecution
GetWorkflowExecution
POST
/gitpod.v1.WorkflowService/GetWorkflowExecutionAction
GetWorkflowExecutionAction
POST
/gitpod.v1.WorkflowService/GetWorkflowExecutionSummary
GetWorkflowExecutionSummary
POST
/gitpod.v1.WorkflowService/GetWorkflowWebhookSecret
GetWorkflowWebhookSecret
POST
/gitpod.v1.WorkflowService/ListWorkflowExecutionActions
ListWorkflowExecutionActions
POST
/gitpod.v1.WorkflowService/ListWorkflowExecutionOutputs
ListWorkflowExecutionOutputs
POST
/gitpod.v1.WorkflowService/ListWorkflowExecutions
ListWorkflowExecutions
POST
/gitpod.v1.WorkflowService/ListWorkflows
ListWorkflows
POST
/gitpod.v1.WorkflowService/RotateWorkflowWebhookSecret
RotateWorkflowWebhookSecret
POST
/gitpod.v1.WorkflowService/StartWorkflow
StartWorkflow
POST
/gitpod.v1.WorkflowService/UpdateWorkflow
UpdateWorkflow
Schemas 105
The contract defines 105 schemas that model the data the API accepts and returns. The most detailed are gitpod.v1.WorkflowExecution.Status (11 properties), gitpod.v1.PullRequest (9 properties), gitpod.v1.WorkflowStep.Report.OutputSpec (9 properties), gitpod.v1.WorkflowExecutionAction.Status (9 properties). Each schema is shown below with its type and property counts.
gitpod.v1.WorkflowErrorCode
string
WorkflowErrorCode defines error codes specific to workflows. These codes help distinguish retriable vs non-retriable errors and provide actionable information…
gitpod.v1.GetWorkflowWebhookSecretResponse
object
1 property
gitpod.v1.WorkflowExecutionAction.Metadata
object
WorkflowExecutionActionMetadata contains workflow execution action metadata.
5 properties
gitpod.v1.UpdateWorkflowResponse
object
1 property
gitpod.v1.WorkflowStep
object
WorkflowStep defines a single step in a workflow action.
4 properties
gitpod.v1.GetWorkflowExecutionActionResponse
object
1 property
gitpod.v1.WorkflowExecutionTrigger
object
WorkflowExecutionTrigger represents a workflow execution trigger instance.
4 properties
1 required
gitpod.v1.Subject
object
2 properties
gitpod.v1.WorkflowExecution.Metadata
object
WorkflowExecutionMetadata contains workflow execution metadata.
5 properties
gitpod.v1.WorkflowExecution.Status
object
WorkflowExecutionStatus contains the current status of a workflow execution.
11 properties
gitpod.v1.WorkflowTriggerContext.Projects
object
Execute workflow in specific project environments. Creates environments for each specified project.
1 property
gitpod.v1.CountResponseRelation
string
gitpod.v1.WorkflowExecution
object
WorkflowExecution represents a workflow execution instance.
4 properties
gitpod.v1.WorkflowExecutionActionPhase
string
WorkflowExecutionActionPhase defines the phases of workflow execution action.
google.protobuf.Duration
string
A Duration represents a signed, fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independen…
gitpod.v1.AgentCodeContext.ContextURL
object
2 properties
gitpod.v1.WorkflowStep.Report.FloatSchema
object
2 properties
gitpod.v1.WorkflowStep.Agent
object
WorkflowAgentStep represents an agent step that executes with a prompt.
1 property
gitpod.v1.GetWorkflowExecutionSummaryRequest
object
GetWorkflowExecutionSummaryRequest returns aggregate counts of workflow executions.
1 property
1 required
gitpod.v1.PullRequest.Repository
object
Repository information
4 properties
gitpod.v1.DateRange
object
DateRange specifies a time period for queries.
2 properties
2 required
gitpod.v1.WorkflowAction.Limits.PerExecution
object
PerExecution defines limits per execution action.
1 property
gitpod.v1.AgentCodeContext
object
4 properties
gitpod.v1.WorkflowAction
object
WorkflowAction defines the actions to be executed in a workflow.
2 properties
1 required
gitpod.v1.WorkflowTriggerContext.Repositories.RepositoryURLs
object
RepositoryURLs contains a list of explicit repository URLs. Creates one action per repository URL.
1 property
gitpod.v1.WorkflowTrigger
object
WorkflowTrigger defines when a workflow should be executed. Each trigger type defines a specific condition that will cause the workflow to execute: - Manual: T…
4 properties
1 required
gitpod.v1.ListWorkflowsRequest
object
ListWorkflowsRequest lists workflows with optional filtering.
4 properties
gitpod.v1.WorkflowStep.Report.BooleanSchema
object
gitpod.v1.WorkflowExecutionAction.Status.StepStatus.StepPhase
string
gitpod.v1.WorkflowTriggerContext.Agent
object
Execute workflow in agent-managed environments. Agent receives the specified prompt and manages execution context.
1 property
gitpod.v1.GetWorkflowExecutionSummaryRequest.Filter
object
2 properties
1 required
gitpod.v1.WorkflowError
object
WorkflowError provides structured error information for workflow failures. This enables the reconciler to make informed retry decisions and the frontend to dis…
5 properties
gitpod.v1.ListWorkflowExecutionOutputsResponse
object
2 properties
gitpod.v1.Principal
string
gitpod.v1.GetWorkflowExecutionResponse
object
1 property
gitpod.v1.PullRequest.State
string
Current state of the pull request
gitpod.v1.WorkflowStep.Report.OutputSpec
object
9 properties
gitpod.v1.CancelWorkflowExecutionActionResponse
object
connect.error
object
Error type returned by Connect: https://connectrpc.com/docs/go/errors/http-representation
2 properties
gitpod.v1.ListWorkflowsRequest.Filter
object
6 properties
gitpod.v1.WorkflowTrigger.Time
object
Time-based trigger - executed automatically based on cron schedule. Uses standard cron expression format (minute hour day month weekday).
1 property
gitpod.v1.RotateWorkflowWebhookSecretRequest
object
1 property
gitpod.v1.WorkflowExecutionAction.Status.StepStatus
object
WorkflowExecutionActionStepStatus represents the status of a single step execution.
7 properties
gitpod.v1.WorkflowExecutionAction.Status
object
WorkflowExecutionActionStatus contains the current status of a workflow execution action.
9 properties
gitpod.v1.WorkflowTriggerContext.FromTrigger
object
Use context derived from the trigger event. Currently only supported for PullRequest triggers - uses PR repository context.
gitpod.v1.CancelWorkflowExecutionRequest
object
CancelWorkflowExecutionRequest cancels a running workflow execution.
1 property
gitpod.v1.ListWorkflowsRequest.Sort
object
2 properties
gitpod.v1.Workflow.Metadata
object
WorkflowMetadata contains workflow metadata.
6 properties
gitpod.v1.StartWorkflowRequest
object
StartWorkflowRequest starts a workflow execution.
3 properties
gitpod.v1.ListWorkflowExecutionsResponse
object
2 properties
gitpod.v1.CountResponse
object
CountResponse represents a bounded count of matching records. When the actual count exceeds the counting limit, value is capped and relation is set to GREATERT…
2 properties
gitpod.v1.AgentExecution.Status.OutputValue
object
4 properties
gitpod.v1.CreateWorkflowRequest
object
CreateWorkflowRequest creates a new workflow.
6 properties
1 required
gitpod.v1.ListWorkflowExecutionOutputsRequest.Filter
object
1 property
gitpod.v1.WorkflowAction.Limits
object
Limits defines execution limits for workflow actions. Concurrent actions limit cannot exceed total actions limit: this.maxparallel <= this.maxtotal
3 properties
gitpod.v1.CancelWorkflowExecutionResponse
object
gitpod.v1.RotateWorkflowWebhookSecretResponse
object
1 property
gitpod.v1.DeleteWorkflowResponse
object
gitpod.v1.GetWorkflowResponse
object
1 property
gitpod.v1.ListWorkflowExecutionsRequest
object
ListWorkflowExecutionsRequest lists workflow executions with optional filtering.
3 properties
gitpod.v1.WorkflowTriggerContext.Repositories
object
Execute workflow in environments created from repository URLs. Supports both explicit repository URLs and search patterns.
3 properties
gitpod.v1.WorkflowStep.Report
object
1 property
gitpod.v1.SortOrder
string
gitpod.v1.GetWorkflowWebhookSecretRequest
object
GetWorkflowWebhookSecretRequest retrieves the webhook secret for a workflow.
1 property
gitpod.v1.WorkflowStep.PullRequest
object
WorkflowPullRequestStep represents a pull request creation step.
4 properties
gitpod.v1.WorkflowTriggerContext.Repositories.RepositorySelector
object
RepositorySelector defines how to select repositories for workflow execution. Combines a search string with an SCM host to identify repositories.
2 properties
gitpod.v1.WorkflowStep.Task
object
WorkflowTaskStep represents a task step that executes a command.
1 property
gitpod.v1.CreateWorkflowResponse
object
1 property
gitpod.v1.CountRequest
object
CountRequest controls whether the response should include a bounded count of matching records.
1 property
gitpod.v1.GetWorkflowExecutionRequest
object
GetWorkflowExecutionRequest gets details about a specific workflow execution.
1 property
gitpod.v1.WorkflowStep.Report.StringSchema
object
1 property
gitpod.v1.ListWorkflowExecutionActionsResponse
object
2 properties
gitpod.v1.WorkflowTriggerContext
object
WorkflowTriggerContext defines the context in which a workflow should run. Context determines where and how the workflow executes: - Projects: Execute in speci…
4 properties
gitpod.v1.UpdateWorkflowRequest
object
UpdateWorkflowRequest updates a workflow's configuration.
8 properties
gitpod.v1.WorkflowExecutionAction
object
WorkflowExecutionAction represents a workflow execution action instance.
4 properties
gitpod.v1.Workflow.Spec
object
5 properties
gitpod.v1.WorkflowExecutionPhase
string
gitpod.v1.ListWorkflowExecutionOutputsResponse.ActionOutput
object
2 properties
gitpod.v1.StartWorkflowResponse
object
1 property
gitpod.v1.WorkflowExecutionTrigger.Time
object
Time trigger - just the timestamp when it was triggered
1 property
gitpod.v1.ListWorkflowsResponse
object
3 properties
gitpod.v1.WorkflowTrigger.PullRequest
object
Pull request trigger - executed when specified PR events occur. Only triggers for PRs in repositories matching the trigger context.
2 properties
gitpod.v1.ListWorkflowExecutionsRequest.Filter
object
5 properties
gitpod.v1.WorkflowExecutionAction.Spec
object
WorkflowExecutionActionSpec contains the specification for this execution action.
4 properties
gitpod.v1.WorkflowStep.Report.IntegerSchema
object
2 properties
gitpod.v1.WorkflowExecution.Spec
object
WorkflowExecutionSpec contains the specification used for this execution.
5 properties
gitpod.v1.GetWorkflowExecutionActionRequest
object
GetWorkflowExecutionActionRequest gets details about a specific workflow execution action.
1 property
gitpod.v1.ListWorkflowExecutionOutputsRequest
object
2 properties
gitpod.v1.WorkflowTrigger.Manual
object
Manual trigger - executed when StartWorkflow RPC is called. No additional configuration needed.
gitpod.v1.PaginationRequest
object
2 properties
gitpod.v1.GetWorkflowRequest
object
GetWorkflowRequest gets details about a specific workflow.
1 property
gitpod.v1.CancelWorkflowExecutionActionRequest
object
CancelWorkflowExecutionActionRequest cancels a running workflow execution action.
1 property
gitpod.v1.WorkflowError.Retry
object
Retry configuration for the error.
2 properties
gitpod.v1.Sort
object
2 properties
gitpod.v1.WorkflowExecutionTrigger.Manual
object
Manual trigger - empty message since no additional data needed
gitpod.v1.GetWorkflowExecutionSummaryResponse
object
4 properties
gitpod.v1.PaginationResponse
object
1 property
gitpod.v1.PullRequest
object
PullRequest represents pull request metadata from source control systems. This message is used across workflow triggers, executions, and agent contexts to main…
9 properties
google.protobuf.Timestamp
string
A Timestamp represents a point in time independent of any time zone or local calendar, encoded as a count of seconds and fractions of seconds at nanosecond res…
gitpod.v1.Workflow
object
Workflow represents a workflow configuration.
4 properties
gitpod.v1.ListWorkflowExecutionActionsRequest
object
ListWorkflowExecutionActionsRequest lists workflow execution actions with optional filtering.
2 properties
gitpod.v1.DeleteWorkflowRequest
object
DeleteWorkflowRequest deletes a workflow permanently.
2 properties
gitpod.v1.ListWorkflowExecutionActionsRequest.Filter
object
4 properties
gitpod.v1.ListWorkflowsRequest.SortField
string
gitpod.v1.WorkflowTrigger.PullRequestEvent
string
WorkflowPREvent defines pull request events that can trigger workflows.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Gitpod 12
Other APIs Gitpod publishes across the network.
Gitpod Organizations API
Gitpod Projects API
Gitpod Accounts and Billing API
Gitpod gitpod.v1.AccountService API
Gitpod gitpod.v1.AgentSecurityService API
Gitpod gitpod.v1.AgentService API
Gitpod gitpod.v1.BillingService API
Gitpod gitpod.v1.EditorService API
Gitpod gitpod.v1.EnvironmentAutomationService API
Gitpod gitpod.v1.EnvironmentService API
Gitpod gitpod.v1.ErrorsService API
Gitpod gitpod.v1.EventService API
Where this information came from
This is an independent, third-party profile of Gitpod gitpod.v1.WorkflowService API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.