The identity and technical contract details declared by the specification.
gitpod.v1.EnvironmentStatus.DevContainer.Phase
string
gitpod.v1.GetRunnerWarmPoolRequest
object
2 properties
2 required
gitpod.v1.CallPing.Request
object
1 property
gitpod.v1.WakeEvent.EnvironmentPhaseReached
object
3 properties
gitpod.v1.MarkRunnerActiveRequest
object
1 property
gitpod.v1.CallSendMessageToAgentExecution.Response
object
gitpod.v1.RunnerConfigurationSchema.EnumField.Value
object
3 properties
gitpod.v1.ListRunnerLLMIntegrationsRequest
object
3 properties
gitpod.v1.EnvironmentSpec.Secret
object
12 properties
gitpod.v1.GetLatestVersionRequest
object
3 properties
1 required
gitpod.v1.EnvironmentStatus.AutomationsFile
object
6 properties
gitpod.v1.CallListSCMOrganizations.Response
object
1 property
gitpod.v1.CallCheckAuthenticationForHost.Response
object
1 property
gitpod.v1.GetRunnerAgentExecutionRequest
object
2 properties
gitpod.v1.EnvironmentStatus.Content
object
6 properties
gitpod.v1.Subject
object
2 properties
gitpod.v1.CallParseContext.Request
object
2 properties
gitpod.v1.ListRunnerEnvironmentClassesRequest.Filter
object
1 property
gitpod.v1.WatchManagedRunnersResponse.EventType
string
gitpod.v1.GetRunnerAgentExecutionResponse
object
1 property
gitpod.v1.UpdateRunnerWarmPoolStatusResponse
object
gitpod.v1.Integration
object
Integration represents an instantiated integration within an organization
8 properties
3 required
gitpod.v1.ParseContextURLResponse
object
7 properties
gitpod.v1.IntegrationAuthentication
object
IntegrationAuthentication defines authentication requirements and options
4 properties
gitpod.v1.WakeEvent.LoopRetrigger
object
2 properties
gitpod.v1.UpdateRunnerAgentExecutionResponse
object
gitpod.v1.EnvironmentStatus.EnvironmentURLs
object
6 properties
gitpod.v1.ListRunnerLLMIntegrationsResponse
object
2 properties
gitpod.v1.CallImprovePromptForAgent.Response
object
1 property
gitpod.v1.FieldValue
object
2 properties
gitpod.v1.ListRunnerWarmPoolsRequest
object
2 properties
1 required
gitpod.v1.EnvironmentSpec.Secret.CredentialProxy
object
CredentialProxy describes how the credential proxy should inject this secret into outgoing HTTPS requests.
3 properties
gitpod.v1.ListRunnerWarmPoolsResponse
object
2 properties
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.UpdateRunnerEnvironmentStatusRequest
object
3 properties
gitpod.v1.GetLatestVersionResponse.GcpManifest
object
4 properties
gitpod.v1.LLMIntegration
object
9 properties
gitpod.v1.RunnerConfigurationSchema
object
4 properties
gitpod.v1.AgentCodeContext.ContextURL
object
2 properties
gitpod.v1.ListManagedRunnersResponse
object
2 properties
gitpod.v1.MarkRunnerActiveResponse
object
gitpod.v1.AgentExecution.Status.EnvironmentUsage
object
2 properties
gitpod.v1.WakeEvent
object
WakeEvent is sent by the backend to wake an agent when a registered interest fires. Delivered via SendToAgentExecution as a new oneof variant.
4 properties
gitpod.v1.IntegrationSourceCodeAccessCapability
object
IntegrationSourceCodeAccessCapability defines source code access capability Additional source code access configuration can be added here
gitpod.v1.KernelControlsConfig
object
KernelControlsConfig configures kernel-level controls for the environment
2 properties
gitpod.v1.EnvironmentSpec.SSHPublicKey
object
2 properties
gitpod.v1.EnvironmentActivitySignal
object
EnvironmentActivitySignal used to signal activity for an environment.
2 properties
gitpod.v1.PullRequest.Repository
object
Repository information
4 properties
gitpod.v1.ListRunnerLLMIntegrationsRequest.Filter
object
1 property
gitpod.v1.IntegrationCapabilities
object
IntegrationCapabilities defines what an integration can do
5 properties
gitpod.v1.AgentCodeContext
object
4 properties
gitpod.v1.RunnerConfigurationSchema.BoolField
object
1 property
gitpod.v1.WakeEvent.TimerFired
object
1 property
gitpod.v1.LLMIntegrationPhase
string
LLMIntegrationPhase represents the current status/phase of an LLM integration
gitpod.v1.RunnerEnvironmentSnapshot
object
4 properties
gitpod.v1.CallCheckRepositoryAccess.Response
object
1 property
gitpod.v1.MCPIntegrationPhase
string
MCPIntegrationPhase represents the status of an MCP integration connection
gitpod.v1.SupportedModel
string
gitpod.v1.EnvironmentSpec.Content
object
4 properties
gitpod.v1.GetRunnerEnvironmentSnapshotRequest
object
2 properties
2 required
gitpod.v1.EnvironmentGitStatus
object
7 properties
gitpod.v1.ParseContextURLResponse.PullRequest
object
Deprecated: Use top-level PullRequest message instead
4 properties
gitpod.v1.CallPing.Response
object
gitpod.v1.ReportRunnerMetricsResponse
object
gitpod.v1.AgentExecution.WaitingInfo.UserMessageInterest
object
gitpod.v1.CallSearchRepositories.Response
object
3 properties
gitpod.v1.RunnerConfigurationSchema.SCMConfigSchema
object
5 properties
gitpod.v1.GetRunnerLLMIntegrationResponse
object
1 property
gitpod.v1.EventSnapshotSpecChange
object
1 property
gitpod.v1.AgentExecution.WaitingInfo
object
WaitingInfo describes what an agent is waiting for when in PHASEWAITINGFORINPUT.
3 properties
gitpod.v1.RunnerConfigurationSchema.OAuth
object
1 property
gitpod.v1.IntegrationContextParsingCapability
object
IntegrationContextParsingCapability defines context parsing capability Additional context parsing configuration can be added here
gitpod.v1.AgentExecution.Status
object
26 properties
gitpod.v1.Principal
string
gitpod.v1.EnvironmentSpec.EnvironmentPort.Protocol
string
Protocol describes the communication protocol between Gateway and user environment services.
gitpod.v1.EventSCMIntegrationChange
object
1 property
gitpod.v1.CallSendMessageToAgentExecution.Request
object
4 properties
gitpod.v1.EnvironmentSpec.EnvironmentPort
object
5 properties
gitpod.v1.UserInputBlock.TextInput
object
1 property
gitpod.v1.RunnerConfigurationSchema.IntField
object
3 properties
gitpod.v1.EnvironmentStatus.RunnerACK
object
RunnerACK is the acknowledgement from the runner that is has received the environment spec.
3 properties
gitpod.v1.PullRequest.State
string
Current state of the pull request
gitpod.v1.GitInitializer.CloneTargetMode
string
CloneTargetMode is the target state in which we want to leave a GitEnvironment
gitpod.v1.UpdateRunnerStatusResponse
object
gitpod.v1.SendResponseRequest
object
12 properties
gitpod.v1.GetRunnerEnvironmentSnapshotResponse
object
1 property
1 required
gitpod.v1.ListRunnerSCMIntegrationsRequest.Filter
object
1 property
gitpod.v1.EventWarmPoolSpecChange
object
1 property
gitpod.v1.AgentExecution.Spec.LoopCondition
object
3 properties
gitpod.v1.WatchManagedRunnersRequest
object
1 property
gitpod.v1.BigPaginationRequest
object
Do not use this in user facing APIs unless you have a good reason for that
2 properties
gitpod.v1.AgentExecution.Status.CurrentOperation
object
4 properties
gitpod.v1.RunnerEnvironment
object
8 properties
gitpod.v1.EnvironmentSpec.DevContainer.LifecycleStage
string
LifecycleStage controls which devcontainer lifecycle commands are executed. See https://containers.dev/implementors/jsonreference/lifecycle-scripts
gitpod.v1.WarmPoolMetadata
object
WarmPoolMetadata contains metadata about the warm pool
6 properties
2 required
gitpod.v1.WarmPoolStatus
object
WarmPoolStatus contains the current status of a warm pool as reported by the runner
6 properties
1 required
gitpod.v1.AgentExecution.Status.ToolUse
object
2 properties
gitpod.v1.ListRunnerAgentExecutionsRequest
object
3 properties
gitpod.v1.WatchManagedRunnersResponse
object
2 properties
gitpod.v1.AgentExecution.WaitingInfo.Interest
object
5 properties
connect.error
object
Error type returned by Connect: https://connectrpc.com/docs/go/errors/http-representation
2 properties
gitpod.v1.GetLatestVersionResponse.LinuxHostManifest
object
7 properties
7 required
gitpod.v1.CallCheckAuthenticationForHost.Request
object
2 properties
gitpod.v1.EnvironmentMetadata
object
EnvironmentMetadata is data associated with an environment that's required for other parts of the system to function
14 properties
gitpod.v1.IntegrationProprietaryAppConfig
object
IntegrationProprietaryAppConfig defines proprietary application integration configuration. Used for app installations that interact with Ona (e.g., GitHub Apps…
9 properties
gitpod.v1.RunnerConfigurationSchema.EnumField
object
4 properties
gitpod.v1.GatewayInfo
object
2 properties
gitpod.v1.ListRunnerEnvironmentClassesResponse
object
2 properties
gitpod.v1.ListRunnerAgentExecutionsResponse
object
2 properties
gitpod.v1.ListRunnerIntegrationsResponse
object
2 properties
gitpod.v1.SignupRequest
object
2 properties
gitpod.v1.CheckAuthenticationForHostResponse.AuthenticationMethodPersonalAccessToken
object
4 properties
gitpod.v1.RunnerMetricsConfiguration
object
5 properties
gitpod.v1.CallSearchRepositories.Request
object
6 properties
gitpod.v1.UpdateRunnerStatusRequest
object
11 properties
gitpod.v1.AgentExecutionFailureReason
string
AgentExecutionFailureReason represents the reason why an agent execution failed
gitpod.v1.SendResponseResponse
object
gitpod.v1.IntegrationMCPCapability
object
IntegrationMCPCapability defines Model Context Protocol capability
1 property
gitpod.v1.FileChange
object
2 properties
gitpod.v1.EnvironmentSpec.Secret.CredentialProxy.Format
string
gitpod.v1.RunnerReleaseChannel
string
gitpod.v1.EnvironmentSpec.AutomationsFile
object
3 properties
gitpod.v1.EventRunnerConfigurationChange
object
gitpod.v1.RunnerEnvironmentSnapshotStatus
object
SnapshotStatus describes the current status of a snapshot
7 properties
gitpod.v1.CallValidateConfig.Request
object
2 properties
gitpod.v1.ListRunnerEnvironmentsResponse
object
2 properties
gitpod.v1.AgentExecution.WaitingInfo.TimerInterest
object
3 properties
gitpod.v1.AgentExecution.Status.OutputValue
object
4 properties
gitpod.v1.AdmissionLevel
string
Admission level describes who can access an environment instance and its ports.
gitpod.v1.EventLLMIntegrationChange
object
1 property
gitpod.v1.AgentMessage.Role
string
Role identifies the sender's relationship in the parent/child hierarchy.
gitpod.v1.RunnerEnvironmentSnapshotMetadata
object
SnapshotMetadata contains metadata about the snapshot
6 properties
1 required
gitpod.v1.ReportLLMUsageResponse
object
gitpod.v1.Veto.Exec
object
Exec controls executable blocking
7 properties
gitpod.v1.HostAuthenticationTokenSource
string
gitpod.v1.RunnerAgentExecution
object
2 properties
gitpod.v1.EnvironmentSpec.Machine
object
3 properties
gitpod.v1.EnvironmentStatus.Machine.Phase
string
gitpod.v1.GetRunnerConfigurationRequest
object
1 property
gitpod.v1.CheckAuthenticationForHostResponse
object
7 properties
gitpod.v1.RunnerEnvironmentSnapshotPhase
string
SnapshotPhase represents the lifecycle phase of a snapshot
gitpod.v1.AutomationTrigger
object
An AutomationTrigger represents a trigger for an automation action. The manual field shows a start button in the UI for manually triggering the automation. The…
6 properties
gitpod.v1.ReportRunnerMetricsRequest
object
2 properties
2 required
gitpod.v1.AgentExecution.Status.LLM
object
1 property
gitpod.v1.RunnerConfigurationSchema.StringField
object
2 properties
gitpod.v1.ReportLLMUsageRequest
object
6 properties
gitpod.v1.GetManagedRunnerRequest
object
1 property
gitpod.v1.UpdateRunnerWarmPoolStatusRequest
object
3 properties
3 required
gitpod.v1.AgentExecution.Status.LoopConditionResult
object
4 properties
gitpod.v1.EnvironmentStatus.SSHPublicKey
object
2 properties
gitpod.v1.EnvironmentSpec.Timeout
object
Timeout configures the environment timeout
1 property
gitpod.v1.RunnerEnvironmentSnapshotStatus.ProviderSnapshot
object
ProviderSnapshot contains provider-specific snapshot information
3 properties
gitpod.v1.SignupResponse
object
1 property
gitpod.v1.CheckRepositoryAccessResponse
object
2 properties
gitpod.v1.SCMIntegrationValidationResult
object
5 properties
gitpod.v1.RunnerConfigurationSchema.DisplayField
object
1 property
gitpod.v1.EnvironmentInitializer.Spec
object
2 properties
gitpod.v1.EnvironmentSpec.DevContainer.Dotfiles
object
1 property
1 required
gitpod.v1.RunnerConfigurationSchema.Field
object
10 properties
gitpod.v1.GetHostAuthenticationTokenValueRequest
object
3 properties
gitpod.v1.ListRunnerEnvironmentSnapshotsRequest
object
3 properties
gitpod.v1.UserInputBlock
object
5 properties
gitpod.v1.ContextURLInitializer
object
1 property
gitpod.v1.GetManagedRunnerResponse
object
1 property
gitpod.v1.SCMIntegrationOAuthConfig
object
3 properties
gitpod.v1.UpdateRunnerEnvironmentStatusResponse
object
gitpod.v1.GetRunnerEnvironmentRequest
object
2 properties
gitpod.v1.CallCheckRepositoryAccess.Request
object
2 properties
gitpod.v1.CallImprovePromptForAgent.Request
object
2 properties
gitpod.v1.UpdateRunnerConfigurationSchemaResponse
object
gitpod.v1.WatchRequestsRequest
object
1 property
gitpod.v1.EnvironmentStatus.DevContainer.Presence
string
gitpod.v1.KernelControlsAction
string
KernelControlsAction defines how a kernel-level policy violation is handled.
gitpod.v1.WakeEvent.LoopRetrigger.UnmetCondition
object
6 properties
gitpod.v1.WarmPoolPhase
string
WarmPoolPhase represents the lifecycle phase of a warm pool
gitpod.v1.CheckAuthenticationForHostResponse.AuthenticationMethodOAuth2
object
2 properties
gitpod.v1.SearchMode
string
gitpod.v1.EnvironmentStatus.Machine
object
7 properties
gitpod.v1.AgentMessage
object
AgentMessage is a message sent between agents (e.g. from a parent agent to a child agent execution, or vice versa).
4 properties
gitpod.v1.AgentMessage.Type
string
gitpod.v1.CallListSCMOrganizations.Request
object
2 properties
gitpod.v1.IntegrationLoginCapability
object
IntegrationLoginCapability defines login/authentication capability Additional login configuration can be added here
gitpod.v1.FieldValidationError
object
2 properties
gitpod.v1.EnvironmentStatus.EnvironmentSSHURL
object
1 property
gitpod.v1.EventHostAuthenticationTokenDeleted
object
2 properties
gitpod.v1.SearchRepositoriesResponse.Repository
object
2 properties
gitpod.v1.ListRunnerEnvironmentSnapshotsResponse
object
2 properties
gitpod.v1.WarmPoolSpec
object
WarmPoolSpec contains the desired configuration for a warm pool
6 properties
gitpod.v1.Gateway
object
Gateway represents a system gateway that provides access to services
3 properties
2 required
gitpod.v1.EnvironmentStatus.RunnerACK.StatusCode
string
gitpod.v1.GetLatestVersionResponse
object
9 properties
2 required
gitpod.v1.RunnerEnvironmentSnapshotSpec
object
SnapshotSpec specifies the configuration for creating a snapshot
2 properties
gitpod.v1.UpdateRunnerConfigurationSchemaRequest
object
2 properties
gitpod.v1.AgentExecution.WaitingInfo.EnvironmentInterest
object
2 properties
gitpod.v1.LLMIntegrationRequestHeader
object
LLMIntegrationRequestHeader represents a custom header to be passed to LLM requests. The value field contains: - Plain text values in update requests (will be…
2 properties
gitpod.v1.EnvironmentSpec
object
EnvironmentSpec specifies the configuration of an environment for an environment start
13 properties
gitpod.v1.EnvironmentSpec.DevContainer
object
5 properties
gitpod.v1.EnvironmentStatus.EnvironmentPortURL
object
2 properties
gitpod.v1.AgentExecution.Spec.Limits
object
3 properties
gitpod.v1.GetRunnerLLMIntegrationRequest
object
2 properties
gitpod.v1.ListRunnerIntegrationsRequest
object
3 properties
gitpod.v1.UpdateRunnerEnvironmentSnapshotStatusRequest
object
3 properties
2 required
gitpod.v1.GetRunnerConfigurationResponse
object
1 property
gitpod.v1.ListManagedRunnersRequest
object
2 properties
gitpod.v1.AgentExecution.Metadata
object
9 properties
gitpod.v1.SendResponseRequest.ErrorCode
string
gitpod.v1.EventEnvironmentSpecChange
object
1 property
gitpod.v1.ParseContextURLResponse.GitContext
object
8 properties
gitpod.v1.EnvironmentInitializer
object
EnvironmentInitializer specifies how an environment is to be initialized
1 property
gitpod.v1.WarmPool
object
WarmPool maintains pre-created environment instances from a prebuild snapshot for near-instant environment startup. One warm pool exists per pair.
4 properties
3 required
gitpod.v1.AgentExecution.Status.MCPIntegrationStatus
object
MCPIntegrationStatus represents the status of a single MCP integration within an agent execution context
5 properties
gitpod.v1.EventIntegrationChange
object
1 property
gitpod.v1.AgentMode
string
AgentMode defines the operational mode of an agent
gitpod.v1.RunnerCapability
string
gitpod.v1.GetRunnerConfigurationResponse.RunnerConfiguration
object
9 properties
gitpod.v1.EnvironmentStatus.AutomationsFile.Presence
string
gitpod.v1.CallValidateConfig.Response
object
2 properties
gitpod.v1.EnvironmentRole
string
EnvironmentRole represents the role of an environment
gitpod.v1.EnvironmentStatus.DevContainer
object
12 properties
gitpod.v1.ParseContextURLResponse.Issue
object
2 properties
gitpod.v1.IntegrationOAuthConfig
object
IntegrationOAuthConfig defines OAuth-specific configuration
8 properties
gitpod.v1.AgentExecution
object
4 properties
gitpod.v1.FileChange.ChangeType
string
ChangeType is the type of change that happened to the file
gitpod.v1.ManagedRunner
object
2 properties
google.protobuf.Any
object
Contains an arbitrary serialized message along with a @type that describes the type of the serialized message.
3 properties
gitpod.v1.EnvironmentStatus.Secret
object
6 properties
gitpod.v1.AgentExecution.WaitingInfo.SubAgentInterest
object
1 property
gitpod.v1.UpdateRunnerEnvironmentSnapshotStatusResponse
object
gitpod.v1.IntegrationAPIKeyConfig
object
IntegrationAPIKeyConfig defines API key authentication configuration Additional API key configuration can be added here
gitpod.v1.EnvironmentPhase
string
gitpod.v1.AgentExecution.Phase
string
gitpod.v1.EnvironmentStatus.Machine.Versions
object
3 properties
gitpod.v1.UserInputBlock.Input
object
2 properties
gitpod.v1.GitInitializer
object
5 properties
gitpod.v1.AgentExecution.Spec
object
7 properties
gitpod.v1.GetLatestVersionResponse.AwsEc2Manifest
object
3 properties
gitpod.v1.PaginationRequest
object
2 properties
gitpod.v1.ListRunnerEnvironmentClassesRequest
object
3 properties
gitpod.v1.GetRunnerWarmPoolResponse
object
1 property
1 required
gitpod.v1.UserInputBlock.ImageInput
object
ImageInput allows sending images to the agent. Client must provide the MIME type; backend validates against magic bytes.
3 properties
gitpod.v1.EnvironmentClassValidationResult
object
4 properties
gitpod.v1.LLMUsage
object
6 properties
gitpod.v1.AgentExecutionRole
string
AgentExecutionRole represents the role of an agent execution
gitpod.v1.EnvironmentClass
object
6 properties
2 required
gitpod.v1.LogLevel
string
gitpod.v1.EnvironmentSpec.Secret.Scope
string
Scope indicates the origin of the secret for filtering purposes.
gitpod.v1.SCMIntegration
object
7 properties
gitpod.v1.SCMContext
object
5 properties
gitpod.v1.EventAgentExecutionSpecChange
object
1 property
gitpod.v1.EnvironmentStatus
object
EnvironmentStatus describes an environment status
13 properties
gitpod.v1.CallParseContext.Response
object
1 property
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
gitpod.v1.GetRunnerEnvironmentResponse
object
1 property
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.GetHostAuthenticationTokenValueResponse
object
5 properties
gitpod.v1.ListRunnerIntegrationsRequest.Filter
object
1 property
gitpod.v1.WatchRequestsResponse
object
20 properties
gitpod.v1.ListRunnerAgentExecutionsRequest.Filter
object
3 properties
gitpod.v1.BPFDebugLevel
string
BPFDebugLevel controls the verbosity of BPF tracepipe output (bpfprintk). Applies to all BPF-based agents (veto exec, future agents).
gitpod.v1.ListRunnerSCMIntegrationsRequest
object
3 properties
gitpod.v1.EventEnvironmentMarkedActive
object
1 property
gitpod.v1.EnvironmentStatus.ContentPhase
string
gitpod.v1.ListSCMOrganizationsResponse.SCMOrganization
object
3 properties
gitpod.v1.FieldValueUpdate
object
2 properties
gitpod.v1.ListRunnerSCMIntegrationsResponse
object
2 properties
gitpod.v1.ListRunnerEnvironmentSnapshotsRequest.Filter
object
1 property
gitpod.v1.Veto
object
Veto controls kernel-level blocking mechanisms
1 property
gitpod.v1.ListRunnerEnvironmentsRequest
object
3 properties
gitpod.v1.UpdateWindow
object
UpdateWindow defines a daily time window (UTC) during which auto-updates are allowed. The window must be at least 2 hours long. Overnight windows are supported…
2 properties
gitpod.v1.IntegrationAgentClientCapability
object
IntegrationAgentClientCapability indicates the integration supports agent client functionality. The webhook signing secret is stored in IntegrationProprietaryA…
gitpod.v1.RunnerConfigurationSchema.PersonalAccessToken
object
2 properties
gitpod.v1.UpdateRunnerAgentExecutionRequest
object
5 properties
gitpod.v1.SendResponseRequest.CallError
object
3 properties
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Gitpod publishes across the network.