API Reference
Libraries
API Overview
Accounts
DeleteAccount
POST/gitpod.v1.AccountService/DeleteAccount
GetSSOLoginURL
POST/gitpod.v1.AccountService/GetSSOLoginURL
ListJoinableOrganizations
POST/gitpod.v1.AccountService/ListJoinableOrganizations
ListLoginProviders
POST/gitpod.v1.AccountService/ListLoginProviders
ListSSOLogins
POST/gitpod.v1.AccountService/ListSSOLogins
GetAccount
POST/gitpod.v1.AccountService/GetAccount
Agents
CreateAgentExecutionConversationToken
POST/gitpod.v1.AgentService/CreateAgentExecutionConversationToken
CreatePrompt
POST/gitpod.v1.AgentService/CreatePrompt
DeleteAgentExecution
POST/gitpod.v1.AgentService/DeleteAgentExecution
DeletePrompt
POST/gitpod.v1.AgentService/DeletePrompt
ListAgentExecutions
POST/gitpod.v1.AgentService/ListAgentExecutions
ListPrompts
POST/gitpod.v1.AgentService/ListPrompts
GetAgentExecution
POST/gitpod.v1.AgentService/GetAgentExecution
GetPrompt
POST/gitpod.v1.AgentService/GetPrompt
SendToAgentExecution
POST/gitpod.v1.AgentService/SendToAgentExecution
StartAgent
POST/gitpod.v1.AgentService/StartAgent
StopAgentExecution
POST/gitpod.v1.AgentService/StopAgentExecution
UpdatePrompt
POST/gitpod.v1.AgentService/UpdatePrompt
Automations
CancelWorkflowExecution
POST/gitpod.v1.WorkflowService/CancelWorkflowExecution
CancelWorkflowExecutionAction
POST/gitpod.v1.WorkflowService/CancelWorkflowExecutionAction
CreateWorkflow
POST/gitpod.v1.WorkflowService/CreateWorkflow
DeleteWorkflow
POST/gitpod.v1.WorkflowService/DeleteWorkflow
ListWorkflows
POST/gitpod.v1.WorkflowService/ListWorkflows
ListWorkflowExecutionActions
POST/gitpod.v1.WorkflowService/ListWorkflowExecutionActions
ListWorkflowExecutionOutputs
POST/gitpod.v1.WorkflowService/ListWorkflowExecutionOutputs
ListWorkflowExecutions
POST/gitpod.v1.WorkflowService/ListWorkflowExecutions
GetWorkflow
POST/gitpod.v1.WorkflowService/GetWorkflow
GetWorkflowExecution
POST/gitpod.v1.WorkflowService/GetWorkflowExecution
GetWorkflowExecutionAction
POST/gitpod.v1.WorkflowService/GetWorkflowExecutionAction
StartWorkflow
POST/gitpod.v1.WorkflowService/StartWorkflow
UpdateWorkflow
POST/gitpod.v1.WorkflowService/UpdateWorkflow
Editors
ListEditors
POST/gitpod.v1.EditorService/ListEditors
ResolveEditorURL
POST/gitpod.v1.EditorService/ResolveEditorURL
GetEditor
POST/gitpod.v1.EditorService/GetEditor
Environments
CreateEnvironment
POST/gitpod.v1.EnvironmentService/CreateEnvironment
CreateEnvironmentAccessToken
POST/gitpod.v1.EnvironmentService/CreateEnvironmentAccessToken
CreateEnvironmentFromProject
POST/gitpod.v1.EnvironmentService/CreateEnvironmentFromProject
CreateEnvironmentLogsToken
POST/gitpod.v1.EnvironmentService/CreateEnvironmentLogsToken
DeleteEnvironment
POST/gitpod.v1.EnvironmentService/DeleteEnvironment
ListEnvironments
POST/gitpod.v1.EnvironmentService/ListEnvironments
MarkEnvironmentActive
POST/gitpod.v1.EnvironmentService/MarkEnvironmentActive
GetEnvironment
POST/gitpod.v1.EnvironmentService/GetEnvironment
StartEnvironment
POST/gitpod.v1.EnvironmentService/StartEnvironment
StopEnvironment
POST/gitpod.v1.EnvironmentService/StopEnvironment
UnarchiveEnvironment
POST/gitpod.v1.EnvironmentService/UnarchiveEnvironment
UpdateEnvironment
POST/gitpod.v1.EnvironmentService/UpdateEnvironment
EnvironmentsAutomations
UpsertAutomationsFile
POST/gitpod.v1.EnvironmentAutomationService/UpsertAutomationsFile
EnvironmentsAutomationsServices
CreateService
POST/gitpod.v1.EnvironmentAutomationService/CreateService
DeleteService
POST/gitpod.v1.EnvironmentAutomationService/DeleteService
ListServices
POST/gitpod.v1.EnvironmentAutomationService/ListServices
GetService
POST/gitpod.v1.EnvironmentAutomationService/GetService
StartService
POST/gitpod.v1.EnvironmentAutomationService/StartService
StopService
POST/gitpod.v1.EnvironmentAutomationService/StopService
UpdateService
POST/gitpod.v1.EnvironmentAutomationService/UpdateService
EnvironmentsAutomationsTasks
CreateTask
POST/gitpod.v1.EnvironmentAutomationService/CreateTask
DeleteTask
POST/gitpod.v1.EnvironmentAutomationService/DeleteTask
ListTasks
POST/gitpod.v1.EnvironmentAutomationService/ListTasks
GetTask
POST/gitpod.v1.EnvironmentAutomationService/GetTask
StartTask
POST/gitpod.v1.EnvironmentAutomationService/StartTask
UpdateTask
POST/gitpod.v1.EnvironmentAutomationService/UpdateTask
EnvironmentsAutomationsTasksExecutions
ListTaskExecutions
POST/gitpod.v1.EnvironmentAutomationService/ListTaskExecutions
GetTaskExecution
POST/gitpod.v1.EnvironmentAutomationService/GetTaskExecution
StopTaskExecution
POST/gitpod.v1.EnvironmentAutomationService/StopTaskExecution
EnvironmentsClasses
ListEnvironmentClasses
POST/gitpod.v1.EnvironmentService/ListEnvironmentClasses
Errors
ErrorsService provides endpoints for clients to report errors that will be sent to error reporting systems.
ReportErrors
POST/gitpod.v1.ErrorsService/ReportErrors
Events
ListAuditLogs
POST/gitpod.v1.EventService/ListAuditLogs
WatchEvents
POST/gitpod.v1.EventService/WatchEvents
Gateways
ListGateways
POST/gitpod.v1.GatewayService/ListGateways
Groups
CreateGroup
POST/gitpod.v1.GroupService/CreateGroup
DeleteGroup
POST/gitpod.v1.GroupService/DeleteGroup
ListGroups
POST/gitpod.v1.GroupService/ListGroups
GetGroup
POST/gitpod.v1.GroupService/GetGroup
UpdateGroup
POST/gitpod.v1.GroupService/UpdateGroup
GroupsMemberships
CreateMembership
POST/gitpod.v1.GroupService/CreateMembership
DeleteMembership
POST/gitpod.v1.GroupService/DeleteMembership
ListMemberships
POST/gitpod.v1.GroupService/ListMemberships
GetMembership
POST/gitpod.v1.GroupService/GetMembership
GroupsRole Assignments
CreateRoleAssignment
POST/gitpod.v1.GroupService/CreateRoleAssignment
DeleteRoleAssignment
POST/gitpod.v1.GroupService/DeleteRoleAssignment
ListRoleAssignments
POST/gitpod.v1.GroupService/ListRoleAssignments
GroupsShares
ShareResourceWithPrincipal
POST/gitpod.v1.GroupService/ShareResourceWithPrincipal
UnshareResourceWithPrincipal
POST/gitpod.v1.GroupService/UnshareResourceWithPrincipal
Identity
ExchangeToken
POST/gitpod.v1.IdentityService/ExchangeToken
GetAuthenticatedIdentity
POST/gitpod.v1.IdentityService/GetAuthenticatedIdentity
GetIDToken
POST/gitpod.v1.IdentityService/GetIDToken
Organizations
CreateOrganization
POST/gitpod.v1.OrganizationService/CreateOrganization
DeleteOrganization
POST/gitpod.v1.OrganizationService/DeleteOrganization
JoinOrganization
POST/gitpod.v1.OrganizationService/JoinOrganization
LeaveOrganization
POST/gitpod.v1.OrganizationService/LeaveOrganization
ListMembers
POST/gitpod.v1.OrganizationService/ListMembers
GetOrganization
POST/gitpod.v1.OrganizationService/GetOrganization
SetRole
POST/gitpod.v1.OrganizationService/SetRole
UpdateOrganization
POST/gitpod.v1.OrganizationService/UpdateOrganization
OrganizationsAnnouncement Banner
GetAnnouncementBanner
POST/gitpod.v1.OrganizationService/GetAnnouncementBanner
UpdateAnnouncementBanner
POST/gitpod.v1.OrganizationService/UpdateAnnouncementBanner
OrganizationsCustom Domains
CreateCustomDomain
POST/gitpod.v1.OrganizationService/CreateCustomDomain
DeleteCustomDomain
POST/gitpod.v1.OrganizationService/DeleteCustomDomain
GetCustomDomain
POST/gitpod.v1.OrganizationService/GetCustomDomain
UpdateCustomDomain
POST/gitpod.v1.OrganizationService/UpdateCustomDomain
OrganizationsDomain Verifications
CreateDomainVerification
POST/gitpod.v1.OrganizationService/CreateDomainVerification
DeleteDomainVerification
POST/gitpod.v1.OrganizationService/DeleteDomainVerification
ListDomainVerifications
POST/gitpod.v1.OrganizationService/ListDomainVerifications
GetDomainVerification
POST/gitpod.v1.OrganizationService/GetDomainVerification
VerifyDomain
POST/gitpod.v1.OrganizationService/VerifyDomain
OrganizationsInvites
CreateOrganizationInvite
POST/gitpod.v1.OrganizationService/CreateOrganizationInvite
GetOrganizationInviteSummary
POST/gitpod.v1.OrganizationService/GetOrganizationInviteSummary
GetOrganizationInvite
POST/gitpod.v1.OrganizationService/GetOrganizationInvite
OrganizationsPolicies
GetOrganizationPolicies
POST/gitpod.v1.OrganizationService/GetOrganizationPolicies
UpdateOrganizationPolicies
POST/gitpod.v1.OrganizationService/UpdateOrganizationPolicies
OrganizationsScim Configurations
CreateSCIMConfiguration
POST/gitpod.v1.OrganizationService/CreateSCIMConfiguration
DeleteSCIMConfiguration
POST/gitpod.v1.OrganizationService/DeleteSCIMConfiguration
ListSCIMConfigurations
POST/gitpod.v1.OrganizationService/ListSCIMConfigurations
RegenerateSCIMToken
POST/gitpod.v1.OrganizationService/RegenerateSCIMToken
GetSCIMConfiguration
POST/gitpod.v1.OrganizationService/GetSCIMConfiguration
UpdateSCIMConfiguration
POST/gitpod.v1.OrganizationService/UpdateSCIMConfiguration
OrganizationsSSO Configurations
CreateSSOConfiguration
POST/gitpod.v1.OrganizationService/CreateSSOConfiguration
DeleteSSOConfiguration
POST/gitpod.v1.OrganizationService/DeleteSSOConfiguration
ListSSOConfigurations
POST/gitpod.v1.OrganizationService/ListSSOConfigurations
GetSSOConfiguration
POST/gitpod.v1.OrganizationService/GetSSOConfiguration
UpdateSSOConfiguration
POST/gitpod.v1.OrganizationService/UpdateSSOConfiguration
Prebuilds
PrebuildService manages prebuilds for projects to enable faster environment startup times. Prebuilds create snapshots of environments that can be used to provision new environments quickly.
CancelPrebuild
POST/gitpod.v1.PrebuildService/CancelPrebuild
CreatePrebuild
POST/gitpod.v1.PrebuildService/CreatePrebuild
CreatePrebuildLogsToken
POST/gitpod.v1.PrebuildService/CreatePrebuildLogsToken
CreateWarmPool
POST/gitpod.v1.PrebuildService/CreateWarmPool
DeletePrebuild
POST/gitpod.v1.PrebuildService/DeletePrebuild
DeleteWarmPool
POST/gitpod.v1.PrebuildService/DeleteWarmPool
ListPrebuilds
POST/gitpod.v1.PrebuildService/ListPrebuilds
ListWarmPools
POST/gitpod.v1.PrebuildService/ListWarmPools
GetPrebuild
POST/gitpod.v1.PrebuildService/GetPrebuild
GetWarmPool
POST/gitpod.v1.PrebuildService/GetWarmPool
UpdateWarmPool
POST/gitpod.v1.PrebuildService/UpdateWarmPool
Projects
CreateProjects
POST/gitpod.v1.ProjectService/CreateProjects
DeleteProjects
POST/gitpod.v1.ProjectService/DeleteProjects
UpdateProjects
POST/gitpod.v1.ProjectService/UpdateProjects
CreateProject
POST/gitpod.v1.ProjectService/CreateProject
CreateProjectFromEnvironment
POST/gitpod.v1.ProjectService/CreateProjectFromEnvironment
DeleteProject
POST/gitpod.v1.ProjectService/DeleteProject
ListProjects
POST/gitpod.v1.ProjectService/ListProjects
GetProject
POST/gitpod.v1.ProjectService/GetProject
UpdateProject
POST/gitpod.v1.ProjectService/UpdateProject
ProjectsEnvironment Clases
ListProjectEnvironmentClasses
POST/gitpod.v1.ProjectService/ListProjectEnvironmentClasses
UpdateProjectEnvironmentClasses
POST/gitpod.v1.ProjectService/UpdateProjectEnvironmentClasses
ProjectsPolicies
CreateProjectPolicy
POST/gitpod.v1.ProjectService/CreateProjectPolicy
DeleteProjectPolicy
POST/gitpod.v1.ProjectService/DeleteProjectPolicy
ListProjectPolicies
POST/gitpod.v1.ProjectService/ListProjectPolicies
UpdateProjectPolicy
POST/gitpod.v1.ProjectService/UpdateProjectPolicy
Runners
CheckAuthenticationForHost
POST/gitpod.v1.RunnerService/CheckAuthenticationForHost
CheckRepositoryAccess
POST/gitpod.v1.RunnerService/CheckRepositoryAccess
CreateRunner
POST/gitpod.v1.RunnerService/CreateRunner
CreateRunnerLogsToken
POST/gitpod.v1.RunnerService/CreateRunnerLogsToken
CreateRunnerToken
POST/gitpod.v1.RunnerService/CreateRunnerToken
DeleteRunner
POST/gitpod.v1.RunnerService/DeleteRunner
ListRunners
POST/gitpod.v1.RunnerService/ListRunners
ListSCMOrganizations
POST/gitpod.v1.RunnerService/ListSCMOrganizations
ParseContextURL
POST/gitpod.v1.RunnerService/ParseContextURL
GetRunner
POST/gitpod.v1.RunnerService/GetRunner
SearchRepositories
POST/gitpod.v1.RunnerService/SearchRepositories
UpdateRunner
POST/gitpod.v1.RunnerService/UpdateRunner
RunnersConfigurations
ValidateRunnerConfiguration
POST/gitpod.v1.RunnerConfigurationService/ValidateRunnerConfiguration
RunnersConfigurationsEnvironment Classes
CreateEnvironmentClass
POST/gitpod.v1.RunnerConfigurationService/CreateEnvironmentClass
ListEnvironmentClasses
POST/gitpod.v1.RunnerConfigurationService/ListEnvironmentClasses
GetEnvironmentClass
POST/gitpod.v1.RunnerConfigurationService/GetEnvironmentClass
UpdateEnvironmentClass
POST/gitpod.v1.RunnerConfigurationService/UpdateEnvironmentClass
RunnersConfigurationsHost Authentication Tokens
CreateHostAuthenticationToken
POST/gitpod.v1.RunnerConfigurationService/CreateHostAuthenticationToken
DeleteHostAuthenticationToken
POST/gitpod.v1.RunnerConfigurationService/DeleteHostAuthenticationToken
ListHostAuthenticationTokens
POST/gitpod.v1.RunnerConfigurationService/ListHostAuthenticationTokens
GetHostAuthenticationToken
POST/gitpod.v1.RunnerConfigurationService/GetHostAuthenticationToken
UpdateHostAuthenticationToken
POST/gitpod.v1.RunnerConfigurationService/UpdateHostAuthenticationToken
RunnersConfigurationsSchema
GetRunnerConfigurationSchema
POST/gitpod.v1.RunnerConfigurationService/GetRunnerConfigurationSchema
RunnersConfigurationsScm Integrations
CreateSCMIntegration
POST/gitpod.v1.RunnerConfigurationService/CreateSCMIntegration
DeleteSCMIntegration
POST/gitpod.v1.RunnerConfigurationService/DeleteSCMIntegration
ListSCMIntegrations
POST/gitpod.v1.RunnerConfigurationService/ListSCMIntegrations
GetSCMIntegration
POST/gitpod.v1.RunnerConfigurationService/GetSCMIntegration
UpdateSCMIntegration
POST/gitpod.v1.RunnerConfigurationService/UpdateSCMIntegration
RunnersPolicies
CreateRunnerPolicy
POST/gitpod.v1.RunnerService/CreateRunnerPolicy
DeleteRunnerPolicy
POST/gitpod.v1.RunnerService/DeleteRunnerPolicy
ListRunnerPolicies
POST/gitpod.v1.RunnerService/ListRunnerPolicies
UpdateRunnerPolicy
POST/gitpod.v1.RunnerService/UpdateRunnerPolicy
Secrets
CreateSecret
POST/gitpod.v1.SecretService/CreateSecret
DeleteSecret
POST/gitpod.v1.SecretService/DeleteSecret
GetSecretValue
POST/gitpod.v1.SecretService/GetSecretValue
ListSecrets
POST/gitpod.v1.SecretService/ListSecrets
UpdateSecretValue
POST/gitpod.v1.SecretService/UpdateSecretValue
Usage
UsageService provides usage information about environments, users, and projects.
ListEnvironmentUsageRecords
POST/gitpod.v1.UsageService/ListEnvironmentUsageRecords
Users
DeleteUser
POST/gitpod.v1.UserService/DeleteUser
GetAuthenticatedUser
POST/gitpod.v1.UserService/GetAuthenticatedUser
GetUser
POST/gitpod.v1.UserService/GetUser
SetSuspended
POST/gitpod.v1.UserService/SetSuspended
UsersDotfiles
GetDotfilesConfiguration
POST/gitpod.v1.UserService/GetDotfilesConfiguration
SetDotfilesConfiguration
POST/gitpod.v1.UserService/SetDotfilesConfiguration
UsersPats
DeletePersonalAccessToken
POST/gitpod.v1.UserService/DeletePersonalAccessToken
GetPersonalAccessToken
POST/gitpod.v1.UserService/GetPersonalAccessToken
ListPersonalAccessTokens
POST/gitpod.v1.UserService/ListPersonalAccessTokens
