openapi: 3.0.0 info: title: gitpod.v1 version: v1.0.0 servers: - url: https://api.gitpod.io description: Gitpod API tags: - name: gitpod.v1.AccountService x-displayName: gitpod.v1.AccountService - name: gitpod.v1.AgentService x-displayName: gitpod.v1.AgentService - description: "AgentSecurityService receives agent security events from runners.\n Authenticated with runner tokens (same\ \ as RunnerInteractionService)." name: gitpod.v1.AgentSecurityService x-displayName: gitpod.v1.AgentSecurityService - description: BillingService provides billing and subscription management functionality. name: gitpod.v1.BillingService x-displayName: gitpod.v1.BillingService - name: gitpod.v1.EditorService x-displayName: gitpod.v1.EditorService - name: gitpod.v1.EnvironmentAutomationService x-displayName: gitpod.v1.EnvironmentAutomationService - name: gitpod.v1.EnvironmentService x-displayName: gitpod.v1.EnvironmentService - description: "ErrorsService provides endpoints for clients to report errors\n that will be sent to error reporting systems." name: gitpod.v1.ErrorsService x-displayName: gitpod.v1.ErrorsService - name: gitpod.v1.EventService x-displayName: gitpod.v1.EventService - name: gitpod.v1.GatewayService x-displayName: gitpod.v1.GatewayService - name: gitpod.v1.GroupService x-displayName: gitpod.v1.GroupService - name: gitpod.v1.IdentityService x-displayName: gitpod.v1.IdentityService - description: "InsightsService provides AI code attribution analytics for projects.\n The CLI reports per-commit co-author\ \ data from git history, and the\n dashboard reads aggregated stats." name: gitpod.v1.InsightsService x-displayName: gitpod.v1.InsightsService - name: gitpod.v1.IntegrationService x-displayName: gitpod.v1.IntegrationService - description: NotificationService manages in-app notifications for users. name: gitpod.v1.NotificationService x-displayName: gitpod.v1.NotificationService - description: "OnaIntelligenceService manages organization-level LLM configurations for Ona Intelligence.\n This service\ \ is restricted to Ona employees with the OnaIntelligenceAdmin role." name: gitpod.v1.OnaIntelligenceService x-displayName: gitpod.v1.OnaIntelligenceService - name: gitpod.v1.OrganizationService x-displayName: gitpod.v1.OrganizationService - description: "PrebuildService manages prebuilds for projects to enable faster environment startup times.\n Prebuilds create\ \ snapshots of environments that can be used to provision new environments quickly." name: gitpod.v1.PrebuildService x-displayName: gitpod.v1.PrebuildService - name: gitpod.v1.ProjectService x-displayName: gitpod.v1.ProjectService - name: gitpod.v1.RunnerConfigurationService x-displayName: gitpod.v1.RunnerConfigurationService - description: RunnerInteractionService provides a way for the backend to interact with environment runners. name: gitpod.v1.RunnerInteractionService x-displayName: gitpod.v1.RunnerInteractionService - name: gitpod.v1.RunnerManagerService x-displayName: gitpod.v1.RunnerManagerService - name: gitpod.v1.RunnerService x-displayName: gitpod.v1.RunnerService - name: gitpod.v1.SecretService x-displayName: gitpod.v1.SecretService - name: gitpod.v1.ServiceAccountService x-displayName: gitpod.v1.ServiceAccountService - name: gitpod.v1.SessionService x-displayName: gitpod.v1.SessionService - description: "TeamService manages teams and team memberships within an organization.\n A team is an organizational unit\ \ that users can belong to.\n Each user can belong to at most one team per organization." name: gitpod.v1.TeamService x-displayName: gitpod.v1.TeamService - description: UsageService provides usage information about environments, users, and projects. name: gitpod.v1.UsageService x-displayName: gitpod.v1.UsageService - name: gitpod.v1.UserService x-displayName: gitpod.v1.UserService - name: gitpod.v1.WebhookService x-displayName: gitpod.v1.WebhookService - name: gitpod.v1.WorkflowService x-displayName: gitpod.v1.WorkflowService paths: /gitpod.v1.AccountService/BlockAccount: post: description: "Blocks an account, preventing all API access.\n\n Use this method to:\n - Revoke access for policy violations\n\ \ - Handle abuse cases\n - Enforce compliance requirements\n\n When an account is blocked:\n - All API requests return\ \ 403 PERMISSION_DENIED\n - All running environments are stopped\n - All active subscriptions are cancelled\n\n Requires\ \ the `block_account` permission.\n\n ### Examples\n\n - Block account for policy violation:\n\n ```yaml\n accountId:\ \ \"f53d2330-3795-4c5d-a1f3-453121af9c60\"\n reason: \"Terms of Service violation - spam\"\n ```" operationId: gitpod.v1.AccountService.BlockAccount parameters: [] requestBody: content: application/json: examples: block_account_for_policy_violation: description: 'accountId: "f53d2330-3795-4c5d-a1f3-453121af9c60" reason: "Terms of Service violation - spam" ' value: accountId: f53d2330-3795-4c5d-a1f3-453121af9c60 reason: Terms of Service violation - spam schema: $ref: '#/components/schemas/gitpod.v1.BlockAccountRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.BlockAccountResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: BlockAccount tags: - gitpod.v1.AccountService servers: [] /gitpod.v1.AccountService/CreateMagicLink: post: operationId: gitpod.v1.AccountService.CreateMagicLink parameters: [] requestBody: content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.CreateMagicLinkRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.CreateMagicLinkResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: CreateMagicLink tags: - gitpod.v1.AccountService servers: [] /gitpod.v1.AccountService/DeleteAccount: post: description: "Deletes an account permanently.\n\n Use this method to:\n - Remove unused accounts\n - Clean up test accounts\n\ \ - Complete account deletion requests\n\n The account must not be an active member of any organization.\n\n ### Examples\n\ \n - Delete account:\n\n Permanently removes an account.\n\n ```yaml\n accountId: \"f53d2330-3795-4c5d-a1f3-453121af9c60\"\ \n ```" operationId: gitpod.v1.AccountService.DeleteAccount parameters: [] requestBody: content: application/json: examples: delete_account: description: Permanently removes an account. value: accountId: f53d2330-3795-4c5d-a1f3-453121af9c60 schema: $ref: '#/components/schemas/gitpod.v1.DeleteAccountRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.DeleteAccountResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: DeleteAccount tags: - gitpod.v1.AccountService servers: [] /gitpod.v1.AccountService/GetAccount: post: description: "Gets information about the currently authenticated account.\n\n Use this method to:\n - Retrieve account\ \ profile information\n - Check organization memberships\n - View account settings\n - Get joinable organizations\n\ \n ### Examples\n\n - Get account details:\n\n Retrieves information about the authenticated account.\n\n ```yaml\n\ \ {}\n ```" operationId: gitpod.v1.AccountService.GetAccount parameters: [] requestBody: content: application/json: examples: get_account_details: description: Retrieves information about the authenticated account. value: {} schema: $ref: '#/components/schemas/gitpod.v1.GetAccountRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.GetAccountResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: GetAccount tags: - gitpod.v1.AccountService servers: [] /gitpod.v1.AccountService/GetChatIdentityToken: post: description: "Gets the chat identity token for the currently authenticated account.\n\n Use this method to:\n - Obtain\ \ a verification hash for in-app chat identity verification\n - Secure chat sessions against impersonation\n\n The\ \ returned hash is an HMAC-SHA256 signature of the account's email,\n used by the chat widget to verify user identity.\n\ \n ### Examples\n\n - Get chat identity token:\n\n Retrieves the identity verification hash for the authenticated\ \ account.\n\n ```yaml\n {}\n ```" operationId: gitpod.v1.AccountService.GetChatIdentityToken parameters: [] requestBody: content: application/json: examples: get_chat_identity_token: description: Retrieves the identity verification hash for the authenticated account. value: {} schema: $ref: '#/components/schemas/gitpod.v1.GetChatIdentityTokenRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.GetChatIdentityTokenResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: GetChatIdentityToken tags: - gitpod.v1.AccountService servers: [] /gitpod.v1.AccountService/GetSSOLoginURL: post: description: "Gets the SSO login URL for a specific email domain.\n\n Use this method to:\n - Initiate SSO authentication\n\ \ - Get organization-specific login URLs\n - Handle SSO redirects\n\n ### Examples\n\n - Get login URL:\n\n Retrieves\ \ SSO URL for email domain.\n\n ```yaml\n email: \"user@company.com\"\n ```\n\n - Get URL with return path:\n\ \n Gets SSO URL with specific return location.\n\n ```yaml\n email: \"user@company.com\"\n returnTo: \"https://gitpod.io/workspaces\"\ \n ```" operationId: gitpod.v1.AccountService.GetSSOLoginURL parameters: [] requestBody: content: application/json: examples: get_login_url: description: Retrieves SSO URL for email domain. value: email: user@company.com get_url_with_return_path: description: Gets SSO URL with specific return location. value: email: user@company.com returnTo: https://gitpod.io/workspaces schema: $ref: '#/components/schemas/gitpod.v1.GetSSOLoginURLRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.GetSSOLoginURLResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: GetSSOLoginURL tags: - gitpod.v1.AccountService servers: [] /gitpod.v1.AccountService/ListJoinableOrganizations: post: description: "Lists organizations that the currently authenticated account can join.\n\n Use this method to:\n - Discover\ \ organizations associated with the account's email domain.\n - Allow users to join existing organizations.\n - Display\ \ potential organizations during onboarding.\n\n ### Examples\n\n - List joinable organizations:\n\n Retrieves a\ \ list of organizations the account can join.\n\n ```yaml\n {}\n ```" operationId: gitpod.v1.AccountService.ListJoinableOrganizations 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_joinable_organizations: description: Retrieves a list of organizations the account can join. value: {} schema: $ref: '#/components/schemas/gitpod.v1.ListJoinableOrganizationsRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.ListJoinableOrganizationsResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: ListJoinableOrganizations tags: - gitpod.v1.AccountService servers: [] /gitpod.v1.AccountService/ListLoginProviders: post: description: "Lists available login providers with optional filtering.\n\n Use this method to:\n - View supported authentication\ \ methods\n - Get provider-specific login URLs\n - Filter providers by invite\n\n ### Examples\n\n - List all providers:\n\ \n Shows all available login providers.\n\n ```yaml\n pagination:\n pageSize: 20\n ```\n\n - List for\ \ specific invite:\n\n Shows providers available for an invite.\n\n ```yaml\n filter:\n inviteId: \"d2c94c27-3b76-4a42-b88c-95a85e392c68\"\ \n pagination:\n pageSize: 20\n ```" operationId: gitpod.v1.AccountService.ListLoginProviders 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_all_providers: description: Shows all available login providers. value: pagination: pageSize: 20 list_for_specific_invite: description: Shows providers available for an invite. value: filter: inviteId: d2c94c27-3b76-4a42-b88c-95a85e392c68 pagination: pageSize: 20 schema: $ref: '#/components/schemas/gitpod.v1.ListLoginProvidersRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.ListLoginProvidersResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: ListLoginProviders tags: - gitpod.v1.AccountService servers: [] /gitpod.v1.AccountService/ListSSOLogins: post: operationId: gitpod.v1.AccountService.ListSSOLogins 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.ListSSOLoginsRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.ListSSOLoginsResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: ListSSOLogins tags: - gitpod.v1.AccountService servers: [] /gitpod.v1.AccountService/UnblockAccount: post: description: "Unblocks a previously blocked account, restoring API access.\n\n Use this method to:\n - Restore access\ \ after resolving policy violations\n - Reinstate accounts after review\n\n Note: Unblocking does NOT restore:\n -\ \ Stopped environments (must be restarted manually)\n - Cancelled subscriptions (must be re-subscribed)\n - Deleted\ \ resources\n\n Requires the `block_account` permission.\n\n ### Examples\n\n - Unblock account:\n\n ```yaml\n \ \ accountId: \"f53d2330-3795-4c5d-a1f3-453121af9c60\"\n ```" operationId: gitpod.v1.AccountService.UnblockAccount parameters: [] requestBody: content: application/json: examples: unblock_account: description: 'accountId: "f53d2330-3795-4c5d-a1f3-453121af9c60" ' value: accountId: f53d2330-3795-4c5d-a1f3-453121af9c60 schema: $ref: '#/components/schemas/gitpod.v1.UnblockAccountRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.UnblockAccountResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: UnblockAccount tags: - gitpod.v1.AccountService servers: [] /gitpod.v1.AgentSecurityService/ReportExecEvent: post: description: "ReportExecEvent reports a blocked or audited process execution.\n\n Use this method to:\n - Report process\ \ executions that were blocked or audited by security policy\n\n ### Examples\n\n - Report a blocked execution:\n\n\ \ ```yaml\n environmentId: \"d2c94c27-3b76-4a42-b88c-95a85e392c68\"\n executable: \"sha256:a1b2c3d4...\"\n \ \ filename: \"/usr/bin/curl\"\n action: KERNEL_CONTROLS_ACTION_BLOCK\n process:\n pid: 1234\n tid: 1234\n\ \ name: \"curl\"\n cmdline: \"curl https://example.com\"\n startedAt: \"2026-01-15T10:30:00Z\"\n ppid:\ \ 1000\n pgid: 1000\n sid: 1000\n timestamp: \"2026-01-15T10:30:00Z\"\n ```" operationId: gitpod.v1.AgentSecurityService.ReportExecEvent parameters: [] requestBody: content: application/json: examples: report_a_blocked_execution: description: "environmentId: \"d2c94c27-3b76-4a42-b88c-95a85e392c68\"\nexecutable: \"sha256:a1b2c3d4...\"\n\ filename: \"/usr/bin/curl\"\naction: KERNEL_CONTROLS_ACTION_BLOCK\nprocess:\n pid: 1234\n tid: 1234\n\ \ name: \"curl\"\n cmdline: \"curl https://example.com\"\n startedAt: \"2026-01-15T10:30:00Z\"\n ppid:\ \ 1000\n pgid: 1000\n sid: 1000\ntimestamp: \"2026-01-15T10:30:00Z\"\n" value: action: KERNEL_CONTROLS_ACTION_BLOCK environmentId: d2c94c27-3b76-4a42-b88c-95a85e392c68 executable: sha256:a1b2c3d4... filename: /usr/bin/curl process: cmdline: curl https://example.com name: curl pgid: 1000 pid: 1234 ppid: 1000 sid: 1000 startedAt: '2026-01-15T10:30:00Z' tid: 1234 timestamp: '2026-01-15T10:30:00Z' schema: $ref: '#/components/schemas/gitpod.v1.ReportExecEventRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.ReportExecEventResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: ReportExecEvent tags: - gitpod.v1.AgentSecurityService servers: [] /gitpod.v1.AgentService/CreateAgent: post: description: "Creates a new agent.\n\n Use this method to:\n - Define new agents with custom prompts and tools" operationId: gitpod.v1.AgentService.CreateAgent parameters: [] requestBody: content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.CreateAgentRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.CreateAgentResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: CreateAgent tags: - gitpod.v1.AgentService servers: [] /gitpod.v1.AgentService/CreateAgentExecutionConversationToken: post: description: "Creates a token for conversation access with a specific agent run.\n\n This method generates a temporary\ \ token that can be used to securely\n connect to an ongoing agent conversation, for example in a web UI.\n\n ###\ \ Examples\n\n - Create a token to join an agent run conversation in a front-end application:\n\n ```yaml\n agentExecutionId:\ \ \"6fa1a3c7-fbb7-49d1-ba56-1890dc7c4c35\"\n ```" operationId: gitpod.v1.AgentService.CreateAgentExecutionConversationToken parameters: [] requestBody: content: application/json: examples: create_a_token_to_join_an_agent_run_conversation_in_a_front_end_application: description: 'agentExecutionId: "6fa1a3c7-fbb7-49d1-ba56-1890dc7c4c35" ' value: agentExecutionId: 6fa1a3c7-fbb7-49d1-ba56-1890dc7c4c35 schema: $ref: '#/components/schemas/gitpod.v1.CreateAgentExecutionConversationTokenRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.CreateAgentExecutionConversationTokenResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: CreateAgentExecutionConversationToken tags: - gitpod.v1.AgentService servers: [] /gitpod.v1.AgentService/CreateLLMAccessToken: post: description: Creates a token for LLM access with a specific agent run. operationId: gitpod.v1.AgentService.CreateLLMAccessToken parameters: [] requestBody: content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.CreateLLMAccessTokenRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.CreateLLMAccessTokenResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: CreateLLMAccessToken tags: - gitpod.v1.AgentService servers: [] /gitpod.v1.AgentService/CreateMCPAccessToken: post: description: "Creates a token for MCP access.\n\n Use this method to generate an access token for MCP integrations." operationId: gitpod.v1.AgentService.CreateMCPAccessToken parameters: [] requestBody: content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.CreateMCPAccessTokenRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.CreateMCPAccessTokenResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: CreateMCPAccessToken tags: - gitpod.v1.AgentService servers: [] /gitpod.v1.AgentService/CreatePrompt: post: description: "Creates a new prompt.\n\n Use this method to:\n - Define new prompts for templates or commands\n - Set\ \ up organization-wide prompt libraries" operationId: gitpod.v1.AgentService.CreatePrompt parameters: [] requestBody: content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.CreatePromptRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.CreatePromptResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: CreatePrompt tags: - gitpod.v1.AgentService servers: [] /gitpod.v1.AgentService/CreateSearchAccessToken: post: description: "Creates a token for search access.\n\n Use this method to generate an access token for search proxy integrations." operationId: gitpod.v1.AgentService.CreateSearchAccessToken parameters: [] requestBody: content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.CreateSearchAccessTokenRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.CreateSearchAccessTokenResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: CreateSearchAccessToken tags: - gitpod.v1.AgentService servers: [] /gitpod.v1.AgentService/DeleteAgent: post: description: "Deletes an agent.\n\n Use this method to:\n - Remove custom agents" operationId: gitpod.v1.AgentService.DeleteAgent parameters: [] requestBody: content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.DeleteAgentRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.DeleteAgentResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: DeleteAgent tags: - gitpod.v1.AgentService servers: [] /gitpod.v1.AgentService/DeleteAgentExecution: post: description: "Deletes an agent run.\n\n Use this method to:\n - Clean up agent runs that are no longer needed\n\n ###\ \ Examples\n\n - Delete an agent run by ID:\n\n ```yaml\n agentExecutionId: \"6fa1a3c7-fbb7-49d1-ba56-1890dc7c4c35\"\ \n ```" operationId: gitpod.v1.AgentService.DeleteAgentExecution parameters: [] requestBody: content: application/json: examples: delete_an_agent_run_by_id: description: 'agentExecutionId: "6fa1a3c7-fbb7-49d1-ba56-1890dc7c4c35" ' value: agentExecutionId: 6fa1a3c7-fbb7-49d1-ba56-1890dc7c4c35 schema: $ref: '#/components/schemas/gitpod.v1.DeleteAgentExecutionRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.DeleteAgentExecutionResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: DeleteAgentExecution tags: - gitpod.v1.AgentService servers: [] /gitpod.v1.AgentService/DeletePrompt: post: description: "Deletes a prompt.\n\n Use this method to:\n - Remove unused prompts" operationId: gitpod.v1.AgentService.DeletePrompt parameters: [] requestBody: content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.DeletePromptRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.DeletePromptResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: DeletePrompt tags: - gitpod.v1.AgentService servers: [] /gitpod.v1.AgentService/EmitAgentSessionActivity: post: description: "Emits an activity to the external agent session (e.g., Linear) associated\n with this agent execution.\ \ The backend resolves the session ID from the\n execution's annotations and uses the org's app token to authenticate." operationId: gitpod.v1.AgentService.EmitAgentSessionActivity parameters: [] requestBody: content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.EmitAgentSessionActivityRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.EmitAgentSessionActivityResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: EmitAgentSessionActivity tags: - gitpod.v1.AgentService servers: [] /gitpod.v1.AgentService/GetAgent: post: description: "Gets details about a specific agent including description,\n and required models.\n\n Use this method\ \ to:\n - Check if an agent is defined correctly\n - Understand which models are required for this agent\n\n ### Examples\n\ \n - Get agent details:\n\n ```yaml\n agentId: \"07e03a28-65a5-4d98-b532-8ea67b188048\"\n ```" operationId: gitpod.v1.AgentService.GetAgent parameters: [] requestBody: content: application/json: examples: get_agent_details: description: 'agentId: "07e03a28-65a5-4d98-b532-8ea67b188048" ' value: agentId: 07e03a28-65a5-4d98-b532-8ea67b188048 schema: $ref: '#/components/schemas/gitpod.v1.GetAgentRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.GetAgentResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: GetAgent tags: - gitpod.v1.AgentService servers: [] /gitpod.v1.AgentService/GetAgentExecution: post: description: "Gets details about a specific agent run, including its metadata, specification,\n and status (phase, error\ \ messages, and usage statistics).\n\n Use this method to:\n - Monitor the run's progress\n - Retrieve the agent's\ \ conversation URL\n - Check if an agent run is actively producing output\n\n ### Examples\n\n - Get agent run details\ \ by ID:\n\n ```yaml\n agentExecutionId: \"6fa1a3c7-fbb7-49d1-ba56-1890dc7c4c35\"\n ```" operationId: gitpod.v1.AgentService.GetAgentExecution parameters: [] requestBody: content: application/json: examples: get_agent_run_details_by_id: description: 'agentExecutionId: "6fa1a3c7-fbb7-49d1-ba56-1890dc7c4c35" ' value: agentExecutionId: 6fa1a3c7-fbb7-49d1-ba56-1890dc7c4c35 schema: $ref: '#/components/schemas/gitpod.v1.GetAgentExecutionRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.GetAgentExecutionResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: GetAgentExecution tags: - gitpod.v1.AgentService servers: [] /gitpod.v1.AgentService/GetPrompt: post: description: "Gets details about a specific prompt including name, description,\n and prompt content.\n\n Use this method\ \ to:\n - Retrieve prompt details for editing\n - Get prompt content for execution\n\n ### Examples\n\n - Get prompt\ \ details:\n\n ```yaml\n promptId: \"07e03a28-65a5-4d98-b532-8ea67b188048\"\n ```" operationId: gitpod.v1.AgentService.GetPrompt parameters: [] requestBody: content: application/json: examples: get_prompt_details: description: 'promptId: "07e03a28-65a5-4d98-b532-8ea67b188048" ' value: promptId: 07e03a28-65a5-4d98-b532-8ea67b188048 schema: $ref: '#/components/schemas/gitpod.v1.GetPromptRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.GetPromptResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: GetPrompt tags: - gitpod.v1.AgentService servers: [] /gitpod.v1.AgentService/ImprovePromptForAgent: post: description: "Improves an agent's prompt.\n\n Use this method to:\n - Enhance the agent's understanding of the user's\ \ request\n - Refine the agent's response to be more accurate and relevant" operationId: gitpod.v1.AgentService.ImprovePromptForAgent parameters: [] requestBody: content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.ImprovePromptForAgentRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.ImprovePromptForAgentResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: ImprovePromptForAgent tags: - gitpod.v1.AgentService servers: [] /gitpod.v1.AgentService/ListAgentExecutions: post: description: "Lists all agent runs matching the specified filter.\n\n Use this method to track multiple agent runs and\ \ their associated resources. Results are ordered by their creation time with the newest first.\n\n ### Examples\n\ \n - List agent runs by agent ID:\n\n ```yaml\n filter:\n agentIds: [\"b8a64cfa-43e2-4b9d-9fb3-07edc63f5971\"\ ]\n pagination:\n pageSize: 10\n ```" operationId: gitpod.v1.AgentService.ListAgentExecutions 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_agent_runs_by_agent_id: description: "filter:\n agentIds: [\"b8a64cfa-43e2-4b9d-9fb3-07edc63f5971\"]\npagination:\n pageSize: 10\n" value: filter: agentIds: - b8a64cfa-43e2-4b9d-9fb3-07edc63f5971 pagination: pageSize: 10 schema: $ref: '#/components/schemas/gitpod.v1.ListAgentExecutionsRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.ListAgentExecutionsResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: ListAgentExecutions tags: - gitpod.v1.AgentService servers: [] /gitpod.v1.AgentService/ListAgents: post: description: "Lists all agents matching the specified criteria.\n\n Use this method to find and monitor agents across\ \ your organization.\n Results are ordered by their creation time with the newest first.\n\n ### Examples\n\n - List\ \ all agents:\n\n Retrieves all agents with pagination.\n\n ```yaml\n pagination:\n pageSize: 10\n ```" operationId: gitpod.v1.AgentService.ListAgents 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_all_agents: description: Retrieves all agents with pagination. value: pagination: pageSize: 10 schema: $ref: '#/components/schemas/gitpod.v1.ListAgentsRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.ListAgentsResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: ListAgents tags: - gitpod.v1.AgentService servers: [] /gitpod.v1.AgentService/ListMCPIntegrations: post: description: "Lists all MCP integrations.\n\n Use this method to retrieve all configured MCP integrations.\n\n ### Examples\n\ \n - List all MCP integrations:\n\n ```yaml\n pagination:\n pageSize: 10\n ```" operationId: gitpod.v1.AgentService.ListMCPIntegrations 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_all_mcp_integrations: description: "pagination:\n pageSize: 10\n" value: pagination: pageSize: 10 schema: $ref: '#/components/schemas/gitpod.v1.ListMCPIntegrationsRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.ListMCPIntegrationsResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: ListMCPIntegrations tags: - gitpod.v1.AgentService servers: [] /gitpod.v1.AgentService/ListPrompts: post: description: "Lists all prompts matching the specified criteria.\n\n Use this method to find and browse prompts across\ \ your organization.\n Results are ordered by their creation time with the newest first.\n\n ### Examples\n\n - List\ \ all prompts:\n\n Retrieves all prompts with pagination.\n\n ```yaml\n pagination:\n pageSize: 10\n ```" operationId: gitpod.v1.AgentService.ListPrompts 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_all_prompts: description: Retrieves all prompts with pagination. value: pagination: pageSize: 10 schema: $ref: '#/components/schemas/gitpod.v1.ListPromptsRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.ListPromptsResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: ListPrompts tags: - gitpod.v1.AgentService servers: [] /gitpod.v1.AgentService/ReportAgentExecutionOutputs: post: description: "Reports outputs for an agent execution.\n\n This method allows agents to report key-value outputs during\ \ execution.\n Similar to task execution outputs, but with typed values for structured data.\n Outputs are merged\ \ with any existing outputs. The API automatically infers\n the type (int, float, bool, or string) from the value.\n\ \n Use this method to:\n - Record execution outcomes and metrics\n - Track test results, coverage, or success indicators\n\ \ - Store any execution-related data as key-value pairs\n\n Type inference rules:\n - \"true\" or \"false\" → bool\n\ \ - Valid integer (e.g., \"42\", \"-10\") → int\n - Valid float (e.g., \"85.5\", \"3.14\") → float\n - Everything\ \ else → string\n\n Validation limits (matching task execution outputs):\n - Keys: 1-128 characters\n - String values:\ \ max 4096 characters\n\n ### Examples\n\n - Report execution outputs (types will be inferred from string_value):\n\ \n ```yaml\n agentExecutionId: \"6fa1a3c7-fbb7-49d1-ba56-1890dc7c4c35\"\n outputs:\n tests_passed:\n \ \ stringValue: \"42\" # inferred as int\n coverage:\n stringValue: \"85.5\" # inferred as\ \ float\n success:\n stringValue: \"true\" # inferred as bool\n message:\n stringValue: \"\ All tests passed\" # stored as string\n ```" operationId: gitpod.v1.AgentService.ReportAgentExecutionOutputs parameters: [] requestBody: content: application/json: examples: report_execution_outputs_(types_will_be_inferred_from_string_: description: "agentExecutionId: \"6fa1a3c7-fbb7-49d1-ba56-1890dc7c4c35\"\noutputs:\n tests_passed:\n stringValue:\ \ \"42\" # inferred as int\n coverage:\n stringValue: \"85.5\" # inferred as float\n success:\n\ \ stringValue: \"true\" # inferred as bool\n message:\n stringValue: \"All tests passed\" #\ \ stored as string\n" value: agentExecutionId: 6fa1a3c7-fbb7-49d1-ba56-1890dc7c4c35 outputs: coverage: stringValue: '85.5' message: stringValue: All tests passed success: stringValue: 'true' tests_passed: stringValue: '42' schema: $ref: '#/components/schemas/gitpod.v1.ReportAgentExecutionOutputsRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.ReportAgentExecutionOutputsResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: ReportAgentExecutionOutputs tags: - gitpod.v1.AgentService servers: [] /gitpod.v1.AgentService/SendToAgentExecution: post: description: "Sends user input to an active agent run.\n\n This method is used to provide interactive or conversation-based\ \ input\n to an agent. The agent can respond with output blocks containing\n text, file changes, or tool usage requests.\n\ \n ### Examples\n\n - Send a text message to an agent:\n\n ```yaml\n agentExecutionId: \"6fa1a3c7-fbb7-49d1-ba56-1890dc7c4c35\"\ \n userInput:\n text:\n content: \"Generate a report based on the latest logs.\"\n ```" operationId: gitpod.v1.AgentService.SendToAgentExecution parameters: [] requestBody: content: application/json: examples: send_a_text_message_to_an_agent: description: "agentExecutionId: \"6fa1a3c7-fbb7-49d1-ba56-1890dc7c4c35\"\nuserInput:\n text:\n content:\ \ \"Generate a report based on the latest logs.\"\n" value: agentExecutionId: 6fa1a3c7-fbb7-49d1-ba56-1890dc7c4c35 userInput: text: content: Generate a report based on the latest logs. schema: $ref: '#/components/schemas/gitpod.v1.SendToAgentExecutionRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.SendToAgentExecutionResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: SendToAgentExecution tags: - gitpod.v1.AgentService servers: [] /gitpod.v1.AgentService/StartAgent: post: description: "Starts (or triggers) an agent run using a provided agent.\n\n Use this method to:\n - Launch an agent\ \ based on a known agent\n\n ### Examples\n\n - Start an agent with a project ID:\n\n ```yaml\n agentId: \"b8a64cfa-43e2-4b9d-9fb3-07edc63f5971\"\ \n codeContext:\n projectId: \"2d22e4eb-31da-467f-882c-27e21550992f\"\n ```" operationId: gitpod.v1.AgentService.StartAgent parameters: [] requestBody: content: application/json: examples: start_an_agent_with_a_project_id: description: "agentId: \"b8a64cfa-43e2-4b9d-9fb3-07edc63f5971\"\ncodeContext:\n projectId: \"2d22e4eb-31da-467f-882c-27e21550992f\"\ \n" value: agentId: b8a64cfa-43e2-4b9d-9fb3-07edc63f5971 codeContext: projectId: 2d22e4eb-31da-467f-882c-27e21550992f schema: $ref: '#/components/schemas/gitpod.v1.StartAgentRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.StartAgentResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: StartAgent tags: - gitpod.v1.AgentService servers: [] /gitpod.v1.AgentService/StopAgentExecution: post: description: "Stops an active agent execution.\n\n Use this method to:\n - Stop an agent that is currently running\n\ \ - Prevent further processing or resource usage\n\n ### Examples\n\n - Stop an agent execution by ID:\n\n ```yaml\n\ \ agentExecutionId: \"6fa1a3c7-fbb7-49d1-ba56-1890dc7c4c35\"\n ```" operationId: gitpod.v1.AgentService.StopAgentExecution parameters: [] requestBody: content: application/json: examples: stop_an_agent_execution_by_id: description: 'agentExecutionId: "6fa1a3c7-fbb7-49d1-ba56-1890dc7c4c35" ' value: agentExecutionId: 6fa1a3c7-fbb7-49d1-ba56-1890dc7c4c35 schema: $ref: '#/components/schemas/gitpod.v1.StopAgentExecutionRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.StopAgentExecutionResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: StopAgentExecution tags: - gitpod.v1.AgentService servers: [] /gitpod.v1.AgentService/UpdateAgent: post: description: "Updates an existing agent.\n\n Use this method to:\n - Modify agent configuration\n - Update prompts or\ \ required tools" operationId: gitpod.v1.AgentService.UpdateAgent parameters: [] requestBody: content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.UpdateAgentRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.UpdateAgentResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: UpdateAgent tags: - gitpod.v1.AgentService servers: [] /gitpod.v1.AgentService/UpdateAgentExecution: post: description: "Updates an agent execution's spec.\n\n Use this method to:\n - Set or update loop conditions on an agent\ \ execution" operationId: gitpod.v1.AgentService.UpdateAgentExecution parameters: [] requestBody: content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.UpdateAgentExecutionRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.UpdateAgentExecutionResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: UpdateAgentExecution tags: - gitpod.v1.AgentService servers: [] /gitpod.v1.AgentService/UpdatePrompt: post: description: "Updates an existing prompt.\n\n Use this method to:\n - Modify prompt content or metadata\n - Change prompt\ \ type (template/command)" operationId: gitpod.v1.AgentService.UpdatePrompt parameters: [] requestBody: content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.UpdatePromptRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.UpdatePromptResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: UpdatePrompt tags: - gitpod.v1.AgentService servers: [] /gitpod.v1.BillingService/CancelSubscription: post: description: "Cancels an existing subscription.\n\n Use this method to:\n - Cancel active subscription\n - Stop recurring\ \ billing\n - Maintain access until end of billing period\n\n ### Examples\n\n - Cancel subscription:\n\n Cancels\ \ the specified subscription.\n\n ```yaml\n organizationId: \"b0e12f6c-4c67-429d-a4a6-d9838b5da047\"\n subscriptionType:\ \ SUBSCRIPTION_TYPE_CORE\n ```" operationId: gitpod.v1.BillingService.CancelSubscription parameters: [] requestBody: content: application/json: examples: cancel_subscription: description: Cancels the specified subscription. value: organizationId: b0e12f6c-4c67-429d-a4a6-d9838b5da047 subscriptionType: SUBSCRIPTION_TYPE_CORE schema: $ref: '#/components/schemas/gitpod.v1.CancelSubscriptionRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.CancelSubscriptionResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: CancelSubscription tags: - gitpod.v1.BillingService servers: [] /gitpod.v1.BillingService/ClearTopupFailure: post: description: "Clears a topup payment failure for an organization.\n\n Use this method to:\n - Acknowledge and clear\ \ a failed topup payment\n - Allow the UI to return to normal state after user acknowledges the failure\n\n Unlike\ \ subscription failures which auto-resolve when payment succeeds,\n topup failures need explicit user acknowledgment\ \ because the commit was\n voided by Metronome and the user needs to retry with a working payment method." operationId: gitpod.v1.BillingService.ClearTopupFailure parameters: [] requestBody: content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.ClearTopupFailureRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.ClearTopupFailureResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: ClearTopupFailure tags: - gitpod.v1.BillingService servers: [] /gitpod.v1.BillingService/CompleteBillingSetup: post: description: "Completes the billing setup process after Stripe payment workflow completion.\n\n Use this method to:\n\ \ - Verify Stripe setup intent completion\n - Create Metronome contract for the organization\n - Grant free trial\ \ credits\n - Finalize billing configuration\n\n ### Examples\n\n - Complete billing setup:\n\n Finalizes billing\ \ after successful Stripe payment setup.\n\n ```yaml\n organizationId: \"b0e12f6c-4c67-429d-a4a6-d9838b5da047\"\ \n setupIntentId: \"seti_1234567890abcdef\"\n ```" operationId: gitpod.v1.BillingService.CompleteBillingSetup parameters: [] requestBody: content: application/json: examples: complete_billing_setup: description: Finalizes billing after successful Stripe payment setup. value: organizationId: b0e12f6c-4c67-429d-a4a6-d9838b5da047 setupIntentId: seti_1234567890abcdef schema: $ref: '#/components/schemas/gitpod.v1.CompleteBillingSetupRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.CompleteBillingSetupResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: CompleteBillingSetup tags: - gitpod.v1.BillingService servers: [] /gitpod.v1.BillingService/CorrectUsageEvents: post: description: "Corrects previously-synced usage events by cancelling the originals and\n creating compensating negative-value\ \ events that flow through the normal\n sync pipeline to Stripe. Internal admin operation." operationId: gitpod.v1.BillingService.CorrectUsageEvents parameters: [] requestBody: content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.CorrectUsageEventsRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.CorrectUsageEventsResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: CorrectUsageEvents tags: - gitpod.v1.BillingService servers: [] /gitpod.v1.BillingService/CreateCardVerification: post: description: "Creates a card verification entry for an account, allowing them to skip credit card verification.\n\n\ \ Use this method to:\n - Grant Ona for Open Source program participants immediate access\n - Mark pre-vetted accounts\ \ as credit card verified\n\n Requires the 'create_card_verification' account permission.\n\n ### Examples\n\n - Create\ \ card verification for open source maintainer:\n\n ```yaml\n email: \"maintainer@example.org\"\n ```" operationId: gitpod.v1.BillingService.CreateCardVerification parameters: [] requestBody: content: application/json: examples: create_card_verification_for_open_source_maintainer: description: 'email: "maintainer@example.org" ' value: email: maintainer@example.org schema: $ref: '#/components/schemas/gitpod.v1.CreateCardVerificationRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.CreateCardVerificationResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: CreateCardVerification tags: - gitpod.v1.BillingService servers: [] /gitpod.v1.BillingService/CreateCoupon: post: description: "Creates a new coupon for support staff to distribute to customers.\n\n Use this method to:\n - Create\ \ promotional coupons for marketing campaigns\n - Generate support coupons for customer service\n - Set up trial credit\ \ coupons for new users" operationId: gitpod.v1.BillingService.CreateCoupon parameters: [] requestBody: content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.CreateCouponRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.CreateCouponResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: CreateCoupon tags: - gitpod.v1.BillingService servers: [] /gitpod.v1.BillingService/CreateSubscription: post: description: "Creates a new subscription for an organization.\n\n Use this method to:\n - Create a new subscription\ \ with specified type\n - Add subscription to existing Metronome contract\n - Create new contract if none exists" operationId: gitpod.v1.BillingService.CreateSubscription parameters: [] requestBody: content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.CreateSubscriptionRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.CreateSubscriptionResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: CreateSubscription tags: - gitpod.v1.BillingService servers: [] /gitpod.v1.BillingService/CreateTeamCreditAllocation: post: description: "Creates a credit allocation (budget) for a team.\n\n Allocations are soft budgets for reporting and alerting\ \ — not enforced at usage time.\n Over-allocation (sum of team budgets > org grant) is allowed.\n\n ### Examples\n\ \n - Create a team allocation:\n\n ```yaml\n organizationId: \"b0e12f6c-4c67-429d-a4a6-d9838b5da047\"\n teamId:\ \ \"d2c94c27-3b76-4a42-b88c-95a85e392c68\"\n creditBudget: \"500\"\n ```\n\n ### Authorization\n\n Requires `billing:create`\ \ permission on the organization." operationId: gitpod.v1.BillingService.CreateTeamCreditAllocation parameters: [] requestBody: content: application/json: examples: create_a_team_allocation: description: 'organizationId: "b0e12f6c-4c67-429d-a4a6-d9838b5da047" teamId: "d2c94c27-3b76-4a42-b88c-95a85e392c68" creditBudget: "500" ' value: creditBudget: '500' organizationId: b0e12f6c-4c67-429d-a4a6-d9838b5da047 teamId: d2c94c27-3b76-4a42-b88c-95a85e392c68 schema: $ref: '#/components/schemas/gitpod.v1.CreateTeamCreditAllocationRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.CreateTeamCreditAllocationResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: CreateTeamCreditAllocation tags: - gitpod.v1.BillingService servers: [] /gitpod.v1.BillingService/DeleteTeamCreditAllocation: post: description: "Deletes the credit allocation for a team.\n\n ### Examples\n\n - Delete a team's allocation:\n\n ```yaml\n\ \ organizationId: \"b0e12f6c-4c67-429d-a4a6-d9838b5da047\"\n teamId: \"d2c94c27-3b76-4a42-b88c-95a85e392c68\"\n\ \ ```\n\n ### Authorization\n\n Requires `billing:delete` permission on the organization." operationId: gitpod.v1.BillingService.DeleteTeamCreditAllocation parameters: [] requestBody: content: application/json: examples: delete_a_team's_allocation: description: 'organizationId: "b0e12f6c-4c67-429d-a4a6-d9838b5da047" teamId: "d2c94c27-3b76-4a42-b88c-95a85e392c68" ' value: organizationId: b0e12f6c-4c67-429d-a4a6-d9838b5da047 teamId: d2c94c27-3b76-4a42-b88c-95a85e392c68 schema: $ref: '#/components/schemas/gitpod.v1.DeleteTeamCreditAllocationRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.DeleteTeamCreditAllocationResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: DeleteTeamCreditAllocation tags: - gitpod.v1.BillingService servers: [] /gitpod.v1.BillingService/GetAutoTopupSettings: post: description: Retrieves auto-topup settings for an organization. operationId: gitpod.v1.BillingService.GetAutoTopupSettings parameters: [] requestBody: content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.GetAutoTopupSettingsRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.GetAutoTopupSettingsResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: GetAutoTopupSettings tags: - gitpod.v1.BillingService servers: [] /gitpod.v1.BillingService/GetBillingInfo: post: description: "Retrieves billing information including credit balance for an organization.\n\n Use this method to:\n\ \ - Check available credits for the organization\n - Monitor credit usage and remaining balance\n - Display billing\ \ status in the dashboard\n - Implement usage-based alerts\n\n ### Examples\n\n - Get billing info:\n\n Retrieves\ \ current credit balance and usage information.\n\n ```yaml\n organizationId: \"b0e12f6c-4c67-429d-a4a6-d9838b5da047\"\ \n ```" operationId: gitpod.v1.BillingService.GetBillingInfo parameters: [] requestBody: content: application/json: examples: get_billing_info: description: Retrieves current credit balance and usage information. value: organizationId: b0e12f6c-4c67-429d-a4a6-d9838b5da047 schema: $ref: '#/components/schemas/gitpod.v1.GetBillingInfoRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.GetBillingInfoResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: GetBillingInfo tags: - gitpod.v1.BillingService servers: [] /gitpod.v1.BillingService/GetBillingRecord: post: description: Gets details about a specific billing record. operationId: gitpod.v1.BillingService.GetBillingRecord parameters: [] requestBody: content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.GetBillingRecordRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.GetBillingRecordResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: GetBillingRecord tags: - gitpod.v1.BillingService servers: [] /gitpod.v1.BillingService/GetCoupon: post: description: "Retrieves a specific coupon by its code.\n\n Use this method to:\n - Validate coupon codes during checkout\n\ \ - Display coupon details to users\n - Check coupon availability and expiration\n\n ### Examples\n\n - Get coupon\ \ by code:\n\n Retrieves coupon details for validation.\n\n ```yaml\n couponCode: \"WELCOME2024\"\n organizationId:\ \ \"123e4567-e89b-12d3-a456-426614174000\"\n ```" operationId: gitpod.v1.BillingService.GetCoupon parameters: [] requestBody: content: application/json: examples: get_coupon_by_code: description: Retrieves coupon details for validation. value: couponCode: WELCOME2024 organizationId: 123e4567-e89b-12d3-a456-426614174000 schema: $ref: '#/components/schemas/gitpod.v1.GetCouponRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.GetCouponResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: GetCoupon tags: - gitpod.v1.BillingService servers: [] /gitpod.v1.BillingService/GetCreditConsumptionTimeSeries: post: description: "Returns daily credit consumption (OCU) time series for an organization,\n broken down by metric category." operationId: gitpod.v1.BillingService.GetCreditConsumptionTimeSeries parameters: [] requestBody: content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.GetCreditConsumptionTimeSeriesRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.GetCreditConsumptionTimeSeriesResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: GetCreditConsumptionTimeSeries tags: - gitpod.v1.BillingService servers: [] /gitpod.v1.BillingService/GetCreditUsageExport: post: description: "Returns a signed download URL for a CSV export of per-user credit usage.\n The URL points to an HTTP endpoint\ \ that streams gzip-compressed CSV." operationId: gitpod.v1.BillingService.GetCreditUsageExport parameters: [] requestBody: content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.GetCreditUsageExportRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.GetCreditUsageExportResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: GetCreditUsageExport tags: - gitpod.v1.BillingService servers: [] /gitpod.v1.BillingService/GetCreditUsageReport: post: description: "Returns a daily credit usage report for an enterprise organization,\n broken down by usage type and by\ \ user." operationId: gitpod.v1.BillingService.GetCreditUsageReport parameters: [] requestBody: content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.GetCreditUsageReportRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.GetCreditUsageReportResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: GetCreditUsageReport tags: - gitpod.v1.BillingService servers: [] /gitpod.v1.BillingService/GetCumulativeCreditUsage: post: description: "Returns cumulative credit usage for an organization and its teams.\n\n Use this method to:\n - Get the\ \ total cumulative credit consumption as of a point in time\n - Get per-team cumulative usage with credit allocation\ \ (budget) comparison\n - Display team credit summaries on the usage page and team detail page\n\n ### Examples\n\n\ \ - Get current cumulative usage:\n\n ```yaml\n organizationId: \"b0e12f6c-4c67-429d-a4a6-d9838b5da047\"\n ```\n\ \n - Get cumulative usage as of a specific date:\n\n ```yaml\n organizationId: \"b0e12f6c-4c67-429d-a4a6-d9838b5da047\"\ \n asOf: \"2026-03-31T23:59:59Z\"\n ```\n\n ### Authorization\n\n Requires `billing:read_usage` permission on\ \ the organization." operationId: gitpod.v1.BillingService.GetCumulativeCreditUsage parameters: [] requestBody: content: application/json: examples: get_cumulative_usage_as_of_a_specific_date: description: 'organizationId: "b0e12f6c-4c67-429d-a4a6-d9838b5da047" asOf: "2026-03-31T23:59:59Z" ' value: asOf: '2026-03-31T23:59:59Z' organizationId: b0e12f6c-4c67-429d-a4a6-d9838b5da047 get_current_cumulative_usage: description: 'organizationId: "b0e12f6c-4c67-429d-a4a6-d9838b5da047" ' value: organizationId: b0e12f6c-4c67-429d-a4a6-d9838b5da047 schema: $ref: '#/components/schemas/gitpod.v1.GetCumulativeCreditUsageRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.GetCumulativeCreditUsageResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: GetCumulativeCreditUsage tags: - gitpod.v1.BillingService servers: [] /gitpod.v1.BillingService/GetEnterpriseBillingInfo: post: description: Returns enterprise billing info for an organization. operationId: gitpod.v1.BillingService.GetEnterpriseBillingInfo parameters: [] requestBody: content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.GetEnterpriseBillingInfoRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.GetEnterpriseBillingInfoResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: GetEnterpriseBillingInfo tags: - gitpod.v1.BillingService servers: [] /gitpod.v1.BillingService/GetStripePortalUrl: post: description: "Retrieves the Stripe Customer Portal URL for an organization.\n\n Use this method to:\n - Get the Stripe\ \ Customer Portal URL for billing management\n - Allow customers to manage their payment methods and billing details\n\ \ - Provide access to billing history and invoices\n\n ### Examples\n\n - Get Stripe portal URL:\n\n Retrieves the\ \ portal URL for the organization.\n\n ```yaml\n organizationId: \"b0e12f6c-4c67-429d-a4a6-d9838b5da047\"\n \ \ ```" operationId: gitpod.v1.BillingService.GetStripePortalUrl parameters: [] requestBody: content: application/json: examples: get_stripe_portal_url: description: Retrieves the portal URL for the organization. value: organizationId: b0e12f6c-4c67-429d-a4a6-d9838b5da047 schema: $ref: '#/components/schemas/gitpod.v1.GetStripePortalUrlRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.GetStripePortalUrlResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: GetStripePortalUrl tags: - gitpod.v1.BillingService servers: [] /gitpod.v1.BillingService/GetStripePublishableKey: post: description: "Retrieves the Stripe publishable key for an organization.\n\n Use this method to:\n - Get the appropriate\ \ Stripe publishable key for frontend payment forms\n - Support different billing realms (production/sandbox)\n -\ \ Ensure proper isolation between organizations\n\n ### Examples\n\n - Get publishable key:\n\n Retrieves the Stripe\ \ publishable key for the organization.\n\n ```yaml\n organizationId: \"b0e12f6c-4c67-429d-a4a6-d9838b5da047\"\ \n ```" operationId: gitpod.v1.BillingService.GetStripePublishableKey parameters: [] requestBody: content: application/json: examples: get_publishable_key: description: Retrieves the Stripe publishable key for the organization. value: organizationId: b0e12f6c-4c67-429d-a4a6-d9838b5da047 schema: $ref: '#/components/schemas/gitpod.v1.GetStripePublishableKeyRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.GetStripePublishableKeyResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: GetStripePublishableKey tags: - gitpod.v1.BillingService servers: [] /gitpod.v1.BillingService/GetTeamCreditAllocation: post: description: "Gets the credit allocation for a team.\n\n ### Examples\n\n - Get a team's allocation:\n\n ```yaml\n\ \ organizationId: \"b0e12f6c-4c67-429d-a4a6-d9838b5da047\"\n teamId: \"d2c94c27-3b76-4a42-b88c-95a85e392c68\"\n\ \ ```\n\n ### Authorization\n\n Requires `billing:read` permission on the organization." operationId: gitpod.v1.BillingService.GetTeamCreditAllocation parameters: [] requestBody: content: application/json: examples: get_a_team's_allocation: description: 'organizationId: "b0e12f6c-4c67-429d-a4a6-d9838b5da047" teamId: "d2c94c27-3b76-4a42-b88c-95a85e392c68" ' value: organizationId: b0e12f6c-4c67-429d-a4a6-d9838b5da047 teamId: d2c94c27-3b76-4a42-b88c-95a85e392c68 schema: $ref: '#/components/schemas/gitpod.v1.GetTeamCreditAllocationRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.GetTeamCreditAllocationResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: GetTeamCreditAllocation tags: - gitpod.v1.BillingService servers: [] /gitpod.v1.BillingService/GrantCredits: post: description: "Grants additional credits to an organization.\n\n Use this method to:\n - Grant credits to existing customers\n\ \ - Add promotional credits\n - Provide customer service credits\n\n ### Examples\n\n - Grant credits:\n\n Grants\ \ 80 credits to the organization for one year.\n\n ```yaml\n organizationId: \"b0e12f6c-4c67-429d-a4a6-d9838b5da047\"\ \n creditsAmount: 80.0\n ```" operationId: gitpod.v1.BillingService.GrantCredits parameters: [] requestBody: content: application/json: examples: grant_credits: description: Grants 80 credits to the organization for one year. value: creditsAmount: 80 organizationId: b0e12f6c-4c67-429d-a4a6-d9838b5da047 schema: $ref: '#/components/schemas/gitpod.v1.GrantCreditsRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.GrantCreditsResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: GrantCredits tags: - gitpod.v1.BillingService servers: [] /gitpod.v1.BillingService/InsertUsageEvents: post: description: "Inserts usage events from an external source (e.g., backfilling missing\n LLM token usage from a provider\ \ console export). Internal admin operation." operationId: gitpod.v1.BillingService.InsertUsageEvents parameters: [] requestBody: content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.InsertUsageEventsRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.InsertUsageEventsResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: InsertUsageEvents tags: - gitpod.v1.BillingService servers: [] /gitpod.v1.BillingService/ListCoupons: post: description: "Lists existing coupons with filtering and pagination support.\n\n Use this method to:\n - View all created\ \ coupons\n - Filter coupons by status or type\n - Monitor coupon usage and expiration" operationId: gitpod.v1.BillingService.ListCoupons 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.ListCouponsRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.ListCouponsResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: ListCoupons tags: - gitpod.v1.BillingService servers: [] /gitpod.v1.BillingService/ListSubscriptions: post: description: "Lists current subscriptions for an organization.\n\n Use this method to:\n - View all active subscriptions\n\ \ - Check subscription status and details\n - Monitor subscription lifecycle\n\n ### Examples\n\n - List subscriptions:\n\ \n Retrieves all subscriptions for the organization.\n\n ```yaml\n organizationId: \"b0e12f6c-4c67-429d-a4a6-d9838b5da047\"\ \n ```" operationId: gitpod.v1.BillingService.ListSubscriptions 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_subscriptions: description: Retrieves all subscriptions for the organization. value: organizationId: b0e12f6c-4c67-429d-a4a6-d9838b5da047 schema: $ref: '#/components/schemas/gitpod.v1.ListSubscriptionsRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.ListSubscriptionsResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: ListSubscriptions tags: - gitpod.v1.BillingService servers: [] /gitpod.v1.BillingService/ReconcileBilling: post: description: "Reconciles billing state for an organization.\n\n Use this method to:\n - Ensure billing state is up-to-date\ \ with external providers (Stripe, Metronome)\n - Sync organization tier based on active contracts\n - Update credit\ \ status and payment failure state\n\n Call this when the user navigates to the billing page to ensure\n they see\ \ the most current billing information.\n\n ### Examples\n\n - Reconcile billing:\n\n Triggers billing reconciliation\ \ for the organization.\n\n ```yaml\n organizationId: \"b0e12f6c-4c67-429d-a4a6-d9838b5da047\"\n ```" operationId: gitpod.v1.BillingService.ReconcileBilling parameters: [] requestBody: content: application/json: examples: reconcile_billing: description: Triggers billing reconciliation for the organization. value: organizationId: b0e12f6c-4c67-429d-a4a6-d9838b5da047 schema: $ref: '#/components/schemas/gitpod.v1.ReconcileBillingRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.ReconcileBillingResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: ReconcileBilling tags: - gitpod.v1.BillingService servers: [] /gitpod.v1.BillingService/RequestRecoveryCredit: post: description: "Requests a one-time recovery credit grant for an organization that is out of credits.\n Grants a small\ \ amount of free credits so the user can start an environment and push\n uncommitted work. Can only be used once per\ \ organization." operationId: gitpod.v1.BillingService.RequestRecoveryCredit parameters: [] requestBody: content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.RequestRecoveryCreditRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.RequestRecoveryCreditResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: RequestRecoveryCredit tags: - gitpod.v1.BillingService servers: [] /gitpod.v1.BillingService/SetBillingAddress: post: description: "Sets or updates the billing address for an organization.\n\n Use this method to:\n - Set billing address\ \ for tax calculation and compliance\n - Update existing billing address information\n - Support international billing\ \ requirements\n\n ### Examples\n\n - Set billing address:\n\n Sets a complete billing address for the organization.\n\ \n ```yaml\n organizationId: \"b0e12f6c-4c67-429d-a4a6-d9838b5da047\"\n name: \"John Doe\"\n address:\n \ \ line1: \"123 Main St\"\n line2: \"Suite 100\"\n city: \"San Francisco\"\n state: \"CA\"\n postalCode:\ \ \"94105\"\n country: \"US\"\n ```" operationId: gitpod.v1.BillingService.SetBillingAddress parameters: [] requestBody: content: application/json: examples: set_billing_address: description: Sets a complete billing address for the organization. value: address: city: San Francisco country: US line1: 123 Main St line2: Suite 100 postalCode: '94105' state: CA name: John Doe organizationId: b0e12f6c-4c67-429d-a4a6-d9838b5da047 schema: $ref: '#/components/schemas/gitpod.v1.SetBillingAddressRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.SetBillingAddressResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: SetBillingAddress tags: - gitpod.v1.BillingService servers: [] /gitpod.v1.BillingService/SetBillingRealm: post: description: "Sets the billing realm for an organization.\n\n Use this method to:\n - Change organization's billing\ \ realm between sandbox and production\n - Configure billing environment for the organization\n - Requires Account\ \ permissions to perform the operation\n\n ### Examples\n\n - Set billing realm:\n\n Changes organization billing\ \ realm to production.\n\n ```yaml\n organizationId: \"b0e12f6c-4c67-429d-a4a6-d9838b5da047\"\n realm: BILLING_REALM_PRODUCTION\n\ \ ```" operationId: gitpod.v1.BillingService.SetBillingRealm parameters: [] requestBody: content: application/json: examples: set_billing_realm: description: Changes organization billing realm to production. value: organizationId: b0e12f6c-4c67-429d-a4a6-d9838b5da047 realm: BILLING_REALM_PRODUCTION schema: $ref: '#/components/schemas/gitpod.v1.SetBillingRealmRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.SetBillingRealmResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: SetBillingRealm tags: - gitpod.v1.BillingService servers: [] /gitpod.v1.BillingService/SetOrganizationCreditGrant: post: description: "Sets the contracted credit grant for an organization.\n\n This is an admin-only operation for setting\ \ the total credit budget\n allocated to an enterprise organization under their contract.\n\n ### Examples\n\n - Set\ \ credit grant:\n\n ```yaml\n organizationId: \"b0e12f6c-4c67-429d-a4a6-d9838b5da047\"\n creditGrant: \"10000\"\ \n ```\n\n ### Authorization\n\n Requires `change_billing_realm` account permission." operationId: gitpod.v1.BillingService.SetOrganizationCreditGrant parameters: [] requestBody: content: application/json: examples: set_credit_grant: description: 'organizationId: "b0e12f6c-4c67-429d-a4a6-d9838b5da047" creditGrant: "10000" ' value: creditGrant: '10000' organizationId: b0e12f6c-4c67-429d-a4a6-d9838b5da047 schema: $ref: '#/components/schemas/gitpod.v1.SetOrganizationCreditGrantRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.SetOrganizationCreditGrantResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: SetOrganizationCreditGrant tags: - gitpod.v1.BillingService servers: [] /gitpod.v1.BillingService/SetTaxID: post: description: "Sets or updates the tax ID for an organization.\n\n Use this method to:\n - Set tax ID for billing purposes\n\ \ - Update existing tax ID information\n - Support various tax ID types (VAT, GST, etc.)\n\n ### Examples\n\n - Set\ \ EU VAT ID:\n\n Sets a VAT ID for an EU organization.\n\n ```yaml\n organizationId: \"b0e12f6c-4c67-429d-a4a6-d9838b5da047\"\ \n taxIdType: \"eu_vat\"\n taxIdValue: \"DE123456789\"\n ```" operationId: gitpod.v1.BillingService.SetTaxID parameters: [] requestBody: content: application/json: examples: set_eu_vat_id: description: Sets a VAT ID for an EU organization. value: organizationId: b0e12f6c-4c67-429d-a4a6-d9838b5da047 taxIdType: eu_vat taxIdValue: DE123456789 schema: $ref: '#/components/schemas/gitpod.v1.SetTaxIDRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.SetTaxIDResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: SetTaxID tags: - gitpod.v1.BillingService servers: [] /gitpod.v1.BillingService/SetupBilling: post: operationId: gitpod.v1.BillingService.SetupBilling parameters: [] requestBody: content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.SetupBillingRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.SetupBillingResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: SetupBilling tags: - gitpod.v1.BillingService servers: [] /gitpod.v1.BillingService/SetupEnterpriseBilling: post: description: "Sets up enterprise billing for an organization.\n\n Creates a Stripe customer, subscribes to the enterprise\ \ pricing plan,\n and updates the billing realm. Idempotent — safe to retry on failure.\n\n Requires the 'change_billing_realm'\ \ account permission.\n\n ### Examples\n\n - Setup enterprise billing (production):\n\n ```yaml\n organizationId:\ \ \"b0e12f6c-4c67-429d-a4a6-d9838b5da047\"\n email: \"billing@example.com\"\n ```\n\n - Setup enterprise billing\ \ (sandbox):\n\n ```yaml\n organizationId: \"b0e12f6c-4c67-429d-a4a6-d9838b5da047\"\n sandbox: true\n ```" operationId: gitpod.v1.BillingService.SetupEnterpriseBilling parameters: [] requestBody: content: application/json: examples: setup_enterprise_billing_(production): description: 'organizationId: "b0e12f6c-4c67-429d-a4a6-d9838b5da047" email: "billing@example.com" ' value: email: billing@example.com organizationId: b0e12f6c-4c67-429d-a4a6-d9838b5da047 setup_enterprise_billing_(sandbox): description: 'organizationId: "b0e12f6c-4c67-429d-a4a6-d9838b5da047" sandbox: true ' value: organizationId: b0e12f6c-4c67-429d-a4a6-d9838b5da047 sandbox: true schema: $ref: '#/components/schemas/gitpod.v1.SetupEnterpriseBillingRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.SetupEnterpriseBillingResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: SetupEnterpriseBilling tags: - gitpod.v1.BillingService servers: [] /gitpod.v1.BillingService/UpdateAutoTopupSettings: post: description: "Updates auto-topup settings for an organization.\n\n Use this method to:\n - Enable or disable automatic\ \ credit top-ups\n - Configure the top-up amount and threshold\n - Set a daily safety cap on automatic top-ups\n\n\ \ Requires Core tier and the auto-topup feature flag." operationId: gitpod.v1.BillingService.UpdateAutoTopupSettings parameters: [] requestBody: content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.UpdateAutoTopupSettingsRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.UpdateAutoTopupSettingsResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: UpdateAutoTopupSettings tags: - gitpod.v1.BillingService servers: [] /gitpod.v1.BillingService/UpdateBillingRecord: post: description: Updates a billing record operationId: gitpod.v1.BillingService.UpdateBillingRecord parameters: [] requestBody: content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.UpdateBillingRecordRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.UpdateBillingRecordResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: UpdateBillingRecord tags: - gitpod.v1.BillingService servers: [] /gitpod.v1.BillingService/UpdateSubscription: post: description: "Updates an existing subscription's amount mid billing period, without cancellation.\n\n Use this method\ \ to:\n - Change the subscription amount without cancelling and re-subscribing\n - Switch between billing plans mid\ \ billing cycle" operationId: gitpod.v1.BillingService.UpdateSubscription parameters: [] requestBody: content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.UpdateSubscriptionRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.UpdateSubscriptionResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: UpdateSubscription tags: - gitpod.v1.BillingService servers: [] /gitpod.v1.BillingService/UpdateTeamCreditAllocation: post: description: "Updates the credit allocation for a team.\n\n ### Examples\n\n - Update a team's budget:\n\n ```yaml\n\ \ organizationId: \"b0e12f6c-4c67-429d-a4a6-d9838b5da047\"\n teamId: \"d2c94c27-3b76-4a42-b88c-95a85e392c68\"\n\ \ creditBudget: \"750\"\n ```\n\n ### Authorization\n\n Requires `billing:update` permission on the organization." operationId: gitpod.v1.BillingService.UpdateTeamCreditAllocation parameters: [] requestBody: content: application/json: examples: update_a_team's_budget: description: 'organizationId: "b0e12f6c-4c67-429d-a4a6-d9838b5da047" teamId: "d2c94c27-3b76-4a42-b88c-95a85e392c68" creditBudget: "750" ' value: creditBudget: '750' organizationId: b0e12f6c-4c67-429d-a4a6-d9838b5da047 teamId: d2c94c27-3b76-4a42-b88c-95a85e392c68 schema: $ref: '#/components/schemas/gitpod.v1.UpdateTeamCreditAllocationRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.UpdateTeamCreditAllocationResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: UpdateTeamCreditAllocation tags: - gitpod.v1.BillingService servers: [] /gitpod.v1.EditorService/GetEditor: post: description: "Gets details about a specific editor.\n\n Use this method to:\n - View editor information\n - Get editor\ \ configuration\n\n ### Examples\n\n - Get editor details:\n\n Retrieves information about a specific editor.\n\n\ \ ```yaml\n id: \"d2c94c27-3b76-4a42-b88c-95a85e392c68\"\n ```" operationId: gitpod.v1.EditorService.GetEditor parameters: [] requestBody: content: application/json: examples: get_editor_details: description: Retrieves information about a specific editor. value: id: d2c94c27-3b76-4a42-b88c-95a85e392c68 schema: $ref: '#/components/schemas/gitpod.v1.GetEditorRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.GetEditorResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: GetEditor tags: - gitpod.v1.EditorService servers: [] /gitpod.v1.EditorService/ListEditors: post: description: "Lists all available code editors, optionally filtered to those allowed in an organization.\n\n Use this\ \ method to:\n - View supported editors\n - Get editor capabilities\n - Browse editor options\n - Check editor availability\n\ \n ### Examples\n\n - List editors:\n\n Shows all available editors with pagination.\n\n ```yaml\n pagination:\n\ \ pageSize: 20\n ```\n\n - List editors available to the organization:\n\n Shows all available editors that\ \ are allowed by the policies enforced in the organization with pagination.\n\n ```yaml\n pagination:\n pageSize:\ \ 20\n filter:\n allowedByPolicy: true\n ```" operationId: gitpod.v1.EditorService.ListEditors 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_editors: description: Shows all available editors with pagination. value: pagination: pageSize: 20 list_editors_available_to_the_organization: description: Shows all available editors that are allowed by the policies enforced in the organization with pagination. value: filter: allowedByPolicy: true pagination: pageSize: 20 schema: $ref: '#/components/schemas/gitpod.v1.ListEditorsRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.ListEditorsResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: ListEditors tags: - gitpod.v1.EditorService servers: [] /gitpod.v1.EditorService/ResolveEditorURL: post: description: "Resolves the URL for accessing an editor in a specific environment.\n\n Use this method to:\n - Get editor\ \ access URLs\n - Launch editors for environments\n - Set up editor connections\n - Configure editor access\n\n ###\ \ Examples\n\n - Resolve editor URL:\n\n Gets the URL for accessing an editor in an environment.\n\n ```yaml\n\ \ editorId: \"d2c94c27-3b76-4a42-b88c-95a85e392c68\"\n environmentId: \"07e03a28-65a5-4d98-b532-8ea67b188048\"\ \n organizationId: \"b0e12f6c-4c67-429d-a4a6-d9838b5da047\"\n ```" operationId: gitpod.v1.EditorService.ResolveEditorURL parameters: [] requestBody: content: application/json: examples: resolve_editor_url: description: Gets the URL for accessing an editor in an environment. value: editorId: d2c94c27-3b76-4a42-b88c-95a85e392c68 environmentId: 07e03a28-65a5-4d98-b532-8ea67b188048 organizationId: b0e12f6c-4c67-429d-a4a6-d9838b5da047 schema: $ref: '#/components/schemas/gitpod.v1.ResolveEditorURLRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.ResolveEditorURLResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: ResolveEditorURL tags: - gitpod.v1.EditorService servers: [] /gitpod.v1.EnvironmentAutomationService/CreateService: post: description: "Creates a new automation service for an environment.\n\n Use this method to:\n - Set up long-running services\n\ \ - Configure service triggers\n - Define service dependencies\n - Specify runtime environments\n\n ### Examples\n\ \n - Create basic service:\n\n Creates a simple service with start command.\n\n ```yaml\n environmentId: \"\ 07e03a28-65a5-4d98-b532-8ea67b188048\"\n metadata:\n reference: \"web-server\"\n name: \"Web Server\"\n\ \ description: \"Runs the development web server\"\n triggeredBy:\n - postDevcontainerStart: true\n\ \ spec:\n commands:\n start: \"npm run dev\"\n ready: \"curl -s http://localhost:3000\"\n ```\n\ \n - Create Docker-based service:\n\n Creates a service running in a specific container.\n\n ```yaml\n environmentId:\ \ \"07e03a28-65a5-4d98-b532-8ea67b188048\"\n metadata:\n reference: \"redis\"\n name: \"Redis Server\"\n\ \ description: \"Redis cache service\"\n spec:\n commands:\n start: \"redis-server\"\n runsOn:\n\ \ docker:\n image: \"redis:7\"\n ```" operationId: gitpod.v1.EnvironmentAutomationService.CreateService parameters: [] requestBody: content: application/json: examples: create_basic_service: description: Creates a simple service with start command. value: environmentId: 07e03a28-65a5-4d98-b532-8ea67b188048 metadata: description: Runs the development web server name: Web Server reference: web-server triggeredBy: - postDevcontainerStart: true spec: commands: ready: curl -s http://localhost:3000 start: npm run dev create_docker_based_service: description: Creates a service running in a specific container. value: environmentId: 07e03a28-65a5-4d98-b532-8ea67b188048 metadata: description: Redis cache service name: Redis Server reference: redis spec: commands: start: redis-server runsOn: docker: image: redis:7 schema: $ref: '#/components/schemas/gitpod.v1.CreateServiceRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.CreateServiceResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: CreateService tags: - gitpod.v1.EnvironmentAutomationService servers: [] /gitpod.v1.EnvironmentAutomationService/CreateTask: post: description: "Creates a new automation task.\n\n Use this method to:\n - Define one-off or scheduled tasks\n - Set up\ \ build or test automation\n - Configure task dependencies\n - Specify execution environments\n\n ### Examples\n\n\ \ - Create basic task:\n\n Creates a simple build task.\n\n ```yaml\n environmentId: \"07e03a28-65a5-4d98-b532-8ea67b188048\"\ \n metadata:\n reference: \"build\"\n name: \"Build Project\"\n description: \"Builds the project artifacts\"\ \n triggeredBy:\n - postEnvironmentStart: true\n spec:\n command: \"npm run build\"\n ```\n\n -\ \ Create task with dependencies:\n\n Creates a task that depends on other services.\n\n ```yaml\n environmentId:\ \ \"07e03a28-65a5-4d98-b532-8ea67b188048\"\n metadata:\n reference: \"test\"\n name: \"Run Tests\"\n \ \ description: \"Runs the test suite\"\n spec:\n command: \"npm test\"\n dependsOn: [\"d2c94c27-3b76-4a42-b88c-95a85e392c68\"\ ]\n ```" operationId: gitpod.v1.EnvironmentAutomationService.CreateTask parameters: [] requestBody: content: application/json: examples: create_basic_task: description: Creates a simple build task. value: environmentId: 07e03a28-65a5-4d98-b532-8ea67b188048 metadata: description: Builds the project artifacts name: Build Project reference: build triggeredBy: - postEnvironmentStart: true spec: command: npm run build create_task_with_dependencies: description: Creates a task that depends on other services. value: dependsOn: - d2c94c27-3b76-4a42-b88c-95a85e392c68 environmentId: 07e03a28-65a5-4d98-b532-8ea67b188048 metadata: description: Runs the test suite name: Run Tests reference: test spec: command: npm test schema: $ref: '#/components/schemas/gitpod.v1.CreateTaskRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.CreateTaskResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: CreateTask tags: - gitpod.v1.EnvironmentAutomationService servers: [] /gitpod.v1.EnvironmentAutomationService/DeleteService: post: description: "Deletes an automation service. This call does not block until the service is deleted.\n If the service\ \ is not stopped it will be stopped before deletion.\n\n Use this method to:\n - Remove unused services\n - Clean\ \ up service configurations\n - Stop and delete services\n\n ### Examples\n\n - Delete service:\n\n Removes a service\ \ after stopping it.\n\n ```yaml\n id: \"d2c94c27-3b76-4a42-b88c-95a85e392c68\"\n force: false\n ```\n\n -\ \ Force delete:\n\n Immediately removes a service.\n\n ```yaml\n id: \"d2c94c27-3b76-4a42-b88c-95a85e392c68\"\ \n force: true\n ```" operationId: gitpod.v1.EnvironmentAutomationService.DeleteService parameters: [] requestBody: content: application/json: examples: delete_service: description: Removes a service after stopping it. value: force: false id: d2c94c27-3b76-4a42-b88c-95a85e392c68 force_delete: description: Immediately removes a service. value: force: true id: d2c94c27-3b76-4a42-b88c-95a85e392c68 schema: $ref: '#/components/schemas/gitpod.v1.DeleteServiceRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.DeleteServiceResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: DeleteService tags: - gitpod.v1.EnvironmentAutomationService servers: [] /gitpod.v1.EnvironmentAutomationService/DeleteTask: post: description: "Deletes an automation task.\n\n Use this method to:\n - Remove unused tasks\n - Clean up task configurations\n\ \ - Delete obsolete automations\n\n ### Examples\n\n - Delete task:\n\n Removes a task and its configuration.\n\n\ \ ```yaml\n id: \"d2c94c27-3b76-4a42-b88c-95a85e392c68\"\n ```" operationId: gitpod.v1.EnvironmentAutomationService.DeleteTask parameters: [] requestBody: content: application/json: examples: delete_task: description: Removes a task and its configuration. value: id: d2c94c27-3b76-4a42-b88c-95a85e392c68 schema: $ref: '#/components/schemas/gitpod.v1.DeleteTaskRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.DeleteTaskResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: DeleteTask tags: - gitpod.v1.EnvironmentAutomationService servers: [] /gitpod.v1.EnvironmentAutomationService/GetService: post: description: "Gets details about a specific automation service.\n\n Use this method to:\n - Check service status\n -\ \ View service configuration\n - Monitor service health\n - Retrieve service metadata\n\n ### Examples\n\n - Get service\ \ details:\n\n Retrieves information about a specific service.\n\n ```yaml\n id: \"d2c94c27-3b76-4a42-b88c-95a85e392c68\"\ \n ```" operationId: gitpod.v1.EnvironmentAutomationService.GetService parameters: [] requestBody: content: application/json: examples: get_service_details: description: Retrieves information about a specific service. value: id: d2c94c27-3b76-4a42-b88c-95a85e392c68 schema: $ref: '#/components/schemas/gitpod.v1.GetServiceRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.GetServiceResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: GetService tags: - gitpod.v1.EnvironmentAutomationService servers: [] /gitpod.v1.EnvironmentAutomationService/GetTask: post: description: "Gets details about a specific automation task.\n\n Use this method to:\n - Check task configuration\n\ \ - View task dependencies\n - Monitor task status\n\n ### Examples\n\n - Get task details:\n\n Retrieves information\ \ about a specific task.\n\n ```yaml\n id: \"d2c94c27-3b76-4a42-b88c-95a85e392c68\"\n ```" operationId: gitpod.v1.EnvironmentAutomationService.GetTask parameters: [] requestBody: content: application/json: examples: get_task_details: description: Retrieves information about a specific task. value: id: d2c94c27-3b76-4a42-b88c-95a85e392c68 schema: $ref: '#/components/schemas/gitpod.v1.GetTaskRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.GetTaskResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: GetTask tags: - gitpod.v1.EnvironmentAutomationService servers: [] /gitpod.v1.EnvironmentAutomationService/GetTaskExecution: post: description: "Gets details about a specific task execution.\n\n Use this method to:\n - Monitor execution progress\n\ \ - View execution logs\n - Check execution status\n - Debug failed executions\n\n ### Examples\n\n - Get execution\ \ details:\n\n Retrieves information about a specific task execution.\n\n ```yaml\n id: \"d2c94c27-3b76-4a42-b88c-95a85e392c68\"\ \n ```" operationId: gitpod.v1.EnvironmentAutomationService.GetTaskExecution parameters: [] requestBody: content: application/json: examples: get_execution_details: description: Retrieves information about a specific task execution. value: id: d2c94c27-3b76-4a42-b88c-95a85e392c68 schema: $ref: '#/components/schemas/gitpod.v1.GetTaskExecutionRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.GetTaskExecutionResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: GetTaskExecution tags: - gitpod.v1.EnvironmentAutomationService servers: [] /gitpod.v1.EnvironmentAutomationService/ListServices: post: description: "Lists automation services with optional filtering.\n\n Use this method to:\n - View all services in an\ \ environment\n - Filter services by reference\n - Monitor service status\n\n ### Examples\n\n - List environment\ \ services:\n\n Shows all services for an environment.\n\n ```yaml\n filter:\n environmentIds: [\"07e03a28-65a5-4d98-b532-8ea67b188048\"\ ]\n pagination:\n pageSize: 20\n ```\n\n - Filter by reference:\n\n Lists services matching specific references.\n\ \n ```yaml\n filter:\n references: [\"web-server\", \"database\"]\n pagination:\n pageSize: 20\n ```" operationId: gitpod.v1.EnvironmentAutomationService.ListServices 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: filter_by_reference: description: Lists services matching specific references. value: filter: references: - web-server - database pagination: pageSize: 20 list_environment_services: description: Shows all services for an environment. value: filter: environmentIds: - 07e03a28-65a5-4d98-b532-8ea67b188048 pagination: pageSize: 20 schema: $ref: '#/components/schemas/gitpod.v1.ListServicesRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.ListServicesResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: ListServices tags: - gitpod.v1.EnvironmentAutomationService servers: [] /gitpod.v1.EnvironmentAutomationService/ListTaskExecutions: post: description: "Lists executions of automation tasks.\n\n Use this method to:\n - View task execution history\n - Monitor\ \ running tasks\n - Track task completion status\n\n ### Examples\n\n - List all executions:\n\n Shows execution\ \ history for all tasks.\n\n ```yaml\n filter:\n environmentIds: [\"07e03a28-65a5-4d98-b532-8ea67b188048\"\ ]\n pagination:\n pageSize: 20\n ```\n\n - Filter by phase:\n\n Lists executions in specific phases.\n\n\ \ ```yaml\n filter:\n phases: [\"TASK_EXECUTION_PHASE_RUNNING\", \"TASK_EXECUTION_PHASE_FAILED\"]\n pagination:\n\ \ pageSize: 20\n ```" operationId: gitpod.v1.EnvironmentAutomationService.ListTaskExecutions 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: filter_by_phase: description: Lists executions in specific phases. value: filter: phases: - TASK_EXECUTION_PHASE_RUNNING - TASK_EXECUTION_PHASE_FAILED pagination: pageSize: 20 list_all_executions: description: Shows execution history for all tasks. value: filter: environmentIds: - 07e03a28-65a5-4d98-b532-8ea67b188048 pagination: pageSize: 20 schema: $ref: '#/components/schemas/gitpod.v1.ListTaskExecutionsRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.ListTaskExecutionsResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: ListTaskExecutions tags: - gitpod.v1.EnvironmentAutomationService servers: [] /gitpod.v1.EnvironmentAutomationService/ListTasks: post: description: "Lists automation tasks with optional filtering.\n\n Use this method to:\n - View all tasks in an environment\n\ \ - Filter tasks by reference\n - Monitor task status\n\n ### Examples\n\n - List environment tasks:\n\n Shows all\ \ tasks for an environment.\n\n ```yaml\n filter:\n environmentIds: [\"07e03a28-65a5-4d98-b532-8ea67b188048\"\ ]\n pagination:\n pageSize: 20\n ```\n\n - Filter by reference:\n\n Lists tasks matching specific references.\n\ \n ```yaml\n filter:\n references: [\"build\", \"test\"]\n pagination:\n pageSize: 20\n ```" operationId: gitpod.v1.EnvironmentAutomationService.ListTasks 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: filter_by_reference: description: Lists tasks matching specific references. value: filter: references: - build - test pagination: pageSize: 20 list_environment_tasks: description: Shows all tasks for an environment. value: filter: environmentIds: - 07e03a28-65a5-4d98-b532-8ea67b188048 pagination: pageSize: 20 schema: $ref: '#/components/schemas/gitpod.v1.ListTasksRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.ListTasksResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: ListTasks tags: - gitpod.v1.EnvironmentAutomationService servers: [] /gitpod.v1.EnvironmentAutomationService/StartService: post: description: "Starts an automation service. This call does not block until the service is started.\n This call will\ \ not error if the service is already running or has been started.\n\n Use this method to:\n - Start stopped services\n\ \ - Resume service operations\n - Trigger service initialization\n\n ### Examples\n\n - Start service:\n\n Starts\ \ a previously stopped service.\n\n ```yaml\n id: \"d2c94c27-3b76-4a42-b88c-95a85e392c68\"\n ```" operationId: gitpod.v1.EnvironmentAutomationService.StartService parameters: [] requestBody: content: application/json: examples: start_service: description: Starts a previously stopped service. value: id: d2c94c27-3b76-4a42-b88c-95a85e392c68 schema: $ref: '#/components/schemas/gitpod.v1.StartServiceRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.StartServiceResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: StartService tags: - gitpod.v1.EnvironmentAutomationService servers: [] /gitpod.v1.EnvironmentAutomationService/StartTask: post: description: "Starts a task by creating a new task execution.\n This call does not block until the task is started;\ \ the task will be started asynchronously.\n\n Use this method to:\n - Trigger task execution\n - Run one-off tasks\n\ \ - Start scheduled tasks immediately\n\n ### Examples\n\n - Start task:\n\n Creates a new execution of a task.\n\ \n ```yaml\n id: \"d2c94c27-3b76-4a42-b88c-95a85e392c68\"\n ```" operationId: gitpod.v1.EnvironmentAutomationService.StartTask parameters: [] requestBody: content: application/json: examples: start_task: description: Creates a new execution of a task. value: id: d2c94c27-3b76-4a42-b88c-95a85e392c68 schema: $ref: '#/components/schemas/gitpod.v1.StartTaskRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.StartTaskResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: StartTask tags: - gitpod.v1.EnvironmentAutomationService servers: [] /gitpod.v1.EnvironmentAutomationService/StopService: post: description: "Stops an automation service. This call does not block until the service is stopped.\n This call will not\ \ error if the service is already stopped or has been stopped.\n\n Use this method to:\n - Pause service operations\n\ \ - Gracefully stop services\n - Prepare for updates\n\n ### Examples\n\n - Stop service:\n\n Gracefully stops a\ \ running service.\n\n ```yaml\n id: \"d2c94c27-3b76-4a42-b88c-95a85e392c68\"\n ```" operationId: gitpod.v1.EnvironmentAutomationService.StopService parameters: [] requestBody: content: application/json: examples: stop_service: description: Gracefully stops a running service. value: id: d2c94c27-3b76-4a42-b88c-95a85e392c68 schema: $ref: '#/components/schemas/gitpod.v1.StopServiceRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.StopServiceResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: StopService tags: - gitpod.v1.EnvironmentAutomationService servers: [] /gitpod.v1.EnvironmentAutomationService/StopTaskExecution: post: description: "Stops a running task execution.\n\n Use this method to:\n - Cancel long-running tasks\n - Stop failed\ \ executions\n - Interrupt task processing\n\n ### Examples\n\n - Stop execution:\n\n Stops a running task execution.\n\ \n ```yaml\n id: \"d2c94c27-3b76-4a42-b88c-95a85e392c68\"\n ```" operationId: gitpod.v1.EnvironmentAutomationService.StopTaskExecution parameters: [] requestBody: content: application/json: examples: stop_execution: description: Stops a running task execution. value: id: d2c94c27-3b76-4a42-b88c-95a85e392c68 schema: $ref: '#/components/schemas/gitpod.v1.StopTaskExecutionRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.StopTaskExecutionResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: StopTaskExecution tags: - gitpod.v1.EnvironmentAutomationService servers: [] /gitpod.v1.EnvironmentAutomationService/UpdateService: post: description: "Updates an automation service configuration.\n\n Use this method to:\n - Modify service commands\n - Update\ \ triggers\n - Change runtime settings\n - Adjust dependencies\n\n ### Examples\n\n - Update commands:\n\n Changes\ \ service start and ready commands.\n\n ```yaml\n id: \"d2c94c27-3b76-4a42-b88c-95a85e392c68\"\n spec:\n \ \ commands:\n start: \"npm run start:dev\"\n ready: \"curl -s http://localhost:8080\"\n ```\n\n - Update\ \ triggers:\n\n Modifies when the service starts.\n\n ```yaml\n id: \"d2c94c27-3b76-4a42-b88c-95a85e392c68\"\ \n metadata:\n triggeredBy:\n trigger:\n - postDevcontainerStart: true\n - manual: true\n\ \ ```" operationId: gitpod.v1.EnvironmentAutomationService.UpdateService parameters: [] requestBody: content: application/json: examples: update_commands: description: Changes service start and ready commands. value: id: d2c94c27-3b76-4a42-b88c-95a85e392c68 spec: commands: ready: curl -s http://localhost:8080 start: npm run start:dev update_triggers: description: Modifies when the service starts. value: id: d2c94c27-3b76-4a42-b88c-95a85e392c68 metadata: triggeredBy: trigger: - postDevcontainerStart: true - manual: true schema: $ref: '#/components/schemas/gitpod.v1.UpdateServiceRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.UpdateServiceResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: UpdateService tags: - gitpod.v1.EnvironmentAutomationService servers: [] /gitpod.v1.EnvironmentAutomationService/UpdateTask: post: description: "Updates an automation task configuration.\n\n Use this method to:\n - Modify task commands\n - Update\ \ task triggers\n - Change dependencies\n - Adjust execution settings\n\n ### Examples\n\n - Update command:\n\n \ \ Changes the task's command.\n\n ```yaml\n id: \"d2c94c27-3b76-4a42-b88c-95a85e392c68\"\n spec:\n command:\ \ \"npm run test:coverage\"\n ```\n\n - Update triggers:\n\n Modifies when the task runs.\n\n ```yaml\n id:\ \ \"d2c94c27-3b76-4a42-b88c-95a85e392c68\"\n metadata:\n triggeredBy:\n trigger:\n - postEnvironmentStart:\ \ true\n ```" operationId: gitpod.v1.EnvironmentAutomationService.UpdateTask parameters: [] requestBody: content: application/json: examples: update_command: description: Changes the task's command. value: id: d2c94c27-3b76-4a42-b88c-95a85e392c68 spec: command: npm run test:coverage update_triggers: description: Modifies when the task runs. value: id: d2c94c27-3b76-4a42-b88c-95a85e392c68 metadata: triggeredBy: trigger: - postEnvironmentStart: true schema: $ref: '#/components/schemas/gitpod.v1.UpdateTaskRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.UpdateTaskResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: UpdateTask tags: - gitpod.v1.EnvironmentAutomationService servers: [] /gitpod.v1.EnvironmentAutomationService/UpdateTaskExecutionStatus: post: description: "Updates the status of a task execution.\n Only the environment executing a task execution is expected\ \ to call this function.\n\n Use this method to:\n - Report execution progress\n - Update step status\n - Set failure\ \ messages\n - Provide log URLs\n\n ### Examples\n\n - Update execution status:\n\n Updates status with step information.\n\ \n ```yaml\n id: \"d2c94c27-3b76-4a42-b88c-95a85e392c68\"\n steps:\n - id: \"step-1\"\n phase: TASK_EXECUTION_PHASE_SUCCEEDED\n\ \ logUrl: \"https://logs.gitpod.io/task-123\"\n ```\n\n - Report failure:\n\n Updates status with failure information.\n\ \n ```yaml\n id: \"d2c94c27-3b76-4a42-b88c-95a85e392c68\"\n failureMessage: \"Build failed due to missing dependencies\"\ \n steps:\n - id: \"step-1\"\n phase: TASK_EXECUTION_PHASE_FAILED\n failureMessage: \"npm install\ \ failed\"\n ```" operationId: gitpod.v1.EnvironmentAutomationService.UpdateTaskExecutionStatus parameters: [] requestBody: content: application/json: examples: report_failure: description: Updates status with failure information. value: failureMessage: Build failed due to missing dependencies id: d2c94c27-3b76-4a42-b88c-95a85e392c68 steps: - failureMessage: npm install failed id: step-1 phase: TASK_EXECUTION_PHASE_FAILED update_execution_status: description: Updates status with step information. value: id: d2c94c27-3b76-4a42-b88c-95a85e392c68 logUrl: https://logs.gitpod.io/task-123 steps: - id: step-1 phase: TASK_EXECUTION_PHASE_SUCCEEDED schema: $ref: '#/components/schemas/gitpod.v1.UpdateTaskExecutionStatusRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.UpdateTaskExecutionStatusResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: UpdateTaskExecutionStatus tags: - gitpod.v1.EnvironmentAutomationService servers: [] /gitpod.v1.EnvironmentAutomationService/UpsertAutomationsFile: post: description: "Upserts the automations file for the given environment.\n\n Use this method to:\n - Configure environment\ \ automations\n - Update automation settings\n - Manage automation files\n\n ### Examples\n\n - Update automations\ \ file:\n\n Updates or creates the automations configuration.\n\n ```yaml\n environmentId: \"07e03a28-65a5-4d98-b532-8ea67b188048\"\ \n automationsFile:\n services:\n web-server:\n name: \"Web Server\"\n description: \"\ Development web server\"\n commands:\n start: \"npm run dev\"\n ready: \"curl -s http://localhost:3000\"\ \n triggeredBy:\n - postDevcontainerStart\n tasks:\n build:\n name: \"Build Project\"\ \n description: \"Builds the project artifacts\"\n command: \"npm run build\"\n triggeredBy:\n\ \ - postEnvironmentStart\n ```" operationId: gitpod.v1.EnvironmentAutomationService.UpsertAutomationsFile parameters: [] requestBody: content: application/json: examples: update_automations_file: description: Updates or creates the automations configuration. value: automationsFile: services: web-server: commands: ready: curl -s http://localhost:3000 start: npm run dev description: Development web server name: Web Server triggeredBy: - postDevcontainerStart tasks: build: command: npm run build description: Builds the project artifacts name: Build Project triggeredBy: - postEnvironmentStart environmentId: 07e03a28-65a5-4d98-b532-8ea67b188048 schema: $ref: '#/components/schemas/gitpod.v1.UpsertAutomationsFileRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.UpsertAutomationsFileResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: UpsertAutomationsFile tags: - gitpod.v1.EnvironmentAutomationService servers: [] /gitpod.v1.EnvironmentService/AllowPortAccess: post: deprecated: true description: "Deprecated: Use local validation with the environment state cache instead.\n\n Checks if the authenticated\ \ caller can access a specific port on an environment.\n This is called by the Runner Proxy to validate access tokens\ \ against current state.\n The caller's identity is extracted from the JWT in the request context.\n\n ### Examples\n\ \n - Check port access:\n\n Verifies if the caller can access port 8080 on an environment.\n\n ```yaml\n environmentId:\ \ \"07e03a28-65a5-4d98-b532-8ea67b188048\"\n port: 8080\n ```" operationId: gitpod.v1.EnvironmentService.AllowPortAccess parameters: [] requestBody: content: application/json: examples: check_port_access: description: Verifies if the caller can access port 8080 on an environment. value: environmentId: 07e03a28-65a5-4d98-b532-8ea67b188048 port: 8080 schema: $ref: '#/components/schemas/gitpod.v1.AllowPortAccessRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.AllowPortAccessResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: AllowPortAccess tags: - gitpod.v1.EnvironmentService servers: [] /gitpod.v1.EnvironmentService/CreateEnvironment: post: description: "Creates a development environment from a context URL (e.g. Git repository) and starts it.\n\n The `class`\ \ field must be a valid environment class ID. You can find a list of\n available environment classes with the `ListEnvironmentClasses`\ \ method.\n\n ### Examples\n\n - Create from context URL:\n\n Creates an environment from a Git repository URL with\ \ default settings.\n\n ```yaml\n spec:\n machine:\n class: \"d2c94c27-3b76-4a42-b88c-95a85e392c68\"\ \n content:\n initializer:\n specs:\n - contextUrl:\n url: \"https://github.com/gitpod-io/gitpod\"\ \n ```\n\n - Create from Git repository:\n\n Creates an environment from a Git repository with specific branch\ \ targeting.\n\n ```yaml\n spec:\n machine:\n class: \"d2c94c27-3b76-4a42-b88c-95a85e392c68\"\n \ \ content:\n initializer:\n specs:\n - git:\n remoteUri: \"https://github.com/gitpod-io/gitpod\"\ \n cloneTarget: \"main\"\n targetMode: \"CLONE_TARGET_MODE_REMOTE_BRANCH\"\n ```\n\n\ \ - Create with custom timeout and ports:\n\n Creates an environment with custom inactivity timeout and exposed\ \ port configuration.\n\n ```yaml\n spec:\n machine:\n class: \"d2c94c27-3b76-4a42-b88c-95a85e392c68\"\ \n content:\n initializer:\n specs:\n - contextUrl:\n url: \"https://github.com/gitpod-io/gitpod\"\ \n timeout:\n disconnected: \"7200s\" # 2 hours in seconds\n ports:\n - port: 3000\n \ \ admission: \"ADMISSION_LEVEL_EVERYONE\"\n name: \"Web App\"\n ```" operationId: gitpod.v1.EnvironmentService.CreateEnvironment parameters: [] requestBody: content: application/json: examples: create_from_context_url: description: Creates an environment from a Git repository URL with default settings. value: spec: content: initializer: specs: - contextUrl: url: https://github.com/gitpod-io/gitpod machine: class: d2c94c27-3b76-4a42-b88c-95a85e392c68 create_from_git_repository: description: Creates an environment from a Git repository with specific branch targeting. value: spec: content: initializer: specs: - git: cloneTarget: main remoteUri: https://github.com/gitpod-io/gitpod targetMode: CLONE_TARGET_MODE_REMOTE_BRANCH machine: class: d2c94c27-3b76-4a42-b88c-95a85e392c68 create_with_custom_timeout_and_ports: description: Creates an environment with custom inactivity timeout and exposed port configuration. value: spec: content: initializer: specs: - contextUrl: url: https://github.com/gitpod-io/gitpod machine: class: d2c94c27-3b76-4a42-b88c-95a85e392c68 ports: - admission: ADMISSION_LEVEL_EVERYONE name: Web App port: 3000 timeout: disconnected: 7200s schema: $ref: '#/components/schemas/gitpod.v1.CreateEnvironmentRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.CreateEnvironmentResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: CreateEnvironment tags: - gitpod.v1.EnvironmentService servers: [] /gitpod.v1.EnvironmentService/CreateEnvironmentAccessToken: post: description: "Creates an access token for the environment.\n\n Generated tokens are valid for one hour and provide environment-specific\ \ access permissions.\n The token is scoped to a specific environment.\n\n ### Examples\n\n - Generate environment\ \ token:\n\n Creates a temporary access token for accessing an environment.\n\n ```yaml\n environmentId: \"\ 07e03a28-65a5-4d98-b532-8ea67b188048\"\n ```" operationId: gitpod.v1.EnvironmentService.CreateEnvironmentAccessToken parameters: [] requestBody: content: application/json: examples: generate_environment_token: description: Creates a temporary access token for accessing an environment. value: environmentId: 07e03a28-65a5-4d98-b532-8ea67b188048 schema: $ref: '#/components/schemas/gitpod.v1.CreateEnvironmentAccessTokenRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.CreateEnvironmentAccessTokenResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: CreateEnvironmentAccessToken tags: - gitpod.v1.EnvironmentService servers: [] /gitpod.v1.EnvironmentService/CreateEnvironmentFromProject: post: description: "Creates an environment from an existing project configuration and starts it.\n\n This method uses project\ \ settings as defaults but allows overriding specific\n configurations. Project settings take precedence over default\ \ configurations,\n while custom specifications in the request override project settings.\n\n ### Examples\n\n - Create\ \ with project defaults:\n\n Creates an environment using all default settings from the project configuration.\n\ \n ```yaml\n projectId: \"b0e12f6c-4c67-429d-a4a6-d9838b5da047\"\n ```\n\n - Create with custom compute resources:\n\ \n Creates an environment from project with custom machine class and timeout settings.\n\n ```yaml\n projectId:\ \ \"b0e12f6c-4c67-429d-a4a6-d9838b5da047\"\n spec:\n machine:\n class: \"d2c94c27-3b76-4a42-b88c-95a85e392c68\"\ \n timeout:\n disconnected: \"14400s\" # 4 hours in seconds\n ```" operationId: gitpod.v1.EnvironmentService.CreateEnvironmentFromProject parameters: [] requestBody: content: application/json: examples: create_with_custom_compute_resources: description: Creates an environment from project with custom machine class and timeout settings. value: projectId: b0e12f6c-4c67-429d-a4a6-d9838b5da047 spec: machine: class: d2c94c27-3b76-4a42-b88c-95a85e392c68 timeout: disconnected: 14400s create_with_project_defaults: description: Creates an environment using all default settings from the project configuration. value: projectId: b0e12f6c-4c67-429d-a4a6-d9838b5da047 schema: $ref: '#/components/schemas/gitpod.v1.CreateEnvironmentFromProjectRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.CreateEnvironmentFromProjectResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: CreateEnvironmentFromProject tags: - gitpod.v1.EnvironmentService servers: [] /gitpod.v1.EnvironmentService/CreateEnvironmentLogsToken: post: description: "Creates an access token for retrieving environment logs.\n\n Generated tokens are valid for one hour and\ \ provide read-only access\n to the environment's logs.\n\n ### Examples\n\n - Generate logs token:\n\n Creates\ \ a temporary access token for retrieving environment logs.\n\n ```yaml\n environmentId: \"07e03a28-65a5-4d98-b532-8ea67b188048\"\ \n ```" operationId: gitpod.v1.EnvironmentService.CreateEnvironmentLogsToken parameters: [] requestBody: content: application/json: examples: generate_logs_token: description: Creates a temporary access token for retrieving environment logs. value: environmentId: 07e03a28-65a5-4d98-b532-8ea67b188048 schema: $ref: '#/components/schemas/gitpod.v1.CreateEnvironmentLogsTokenRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.CreateEnvironmentLogsTokenResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: CreateEnvironmentLogsToken tags: - gitpod.v1.EnvironmentService servers: [] /gitpod.v1.EnvironmentService/CreatePortAccessToken: post: description: "Creates an access token for a specific port on an environment.\n\n The token grants access to the specified\ \ port based on the port's admission level.\n Tokens are short-lived (~1 hour) with refresh tokens for long-running\ \ connections.\n\n ### Examples\n\n - Generate port access token:\n\n Creates a token for accessing port 8080 on\ \ an environment.\n\n ```yaml\n environmentId: \"07e03a28-65a5-4d98-b532-8ea67b188048\"\n port: 8080\n ```" operationId: gitpod.v1.EnvironmentService.CreatePortAccessToken parameters: [] requestBody: content: application/json: examples: generate_port_access_token: description: Creates a token for accessing port 8080 on an environment. value: environmentId: 07e03a28-65a5-4d98-b532-8ea67b188048 port: 8080 schema: $ref: '#/components/schemas/gitpod.v1.CreatePortAccessTokenRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.CreatePortAccessTokenResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: CreatePortAccessToken tags: - gitpod.v1.EnvironmentService servers: [] /gitpod.v1.EnvironmentService/DeleteEnvironment: post: description: "Permanently deletes an environment.\n\n Running environments are automatically stopped before deletion.\ \ If force\n is true, the environment is deleted immediately without graceful shutdown.\n\n ### Examples\n\n - Delete\ \ with graceful shutdown:\n\n Deletes an environment after gracefully stopping it.\n\n ```yaml\n environmentId:\ \ \"07e03a28-65a5-4d98-b532-8ea67b188048\"\n force: false\n ```\n\n - Force delete:\n\n Immediately deletes\ \ an environment without waiting for graceful shutdown.\n\n ```yaml\n environmentId: \"07e03a28-65a5-4d98-b532-8ea67b188048\"\ \n force: true\n ```" operationId: gitpod.v1.EnvironmentService.DeleteEnvironment parameters: [] requestBody: content: application/json: examples: delete_with_graceful_shutdown: description: Deletes an environment after gracefully stopping it. value: environmentId: 07e03a28-65a5-4d98-b532-8ea67b188048 force: false force_delete: description: Immediately deletes an environment without waiting for graceful shutdown. value: environmentId: 07e03a28-65a5-4d98-b532-8ea67b188048 force: true schema: $ref: '#/components/schemas/gitpod.v1.DeleteEnvironmentRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.DeleteEnvironmentResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: DeleteEnvironment tags: - gitpod.v1.EnvironmentService servers: [] /gitpod.v1.EnvironmentService/GetEnvironment: post: description: "Gets details about a specific environment including its status, configuration, and context URL.\n\n Use\ \ this method to:\n - Check if an environment is ready to use\n - Get connection details for IDE and exposed ports\n\ \ - Monitor environment health and resource usage\n - Debug environment setup issues\n\n ### Examples\n\n - Get environment\ \ details:\n\n Retrieves detailed information about a specific environment using its unique identifier.\n\n ```yaml\n\ \ environmentId: \"07e03a28-65a5-4d98-b532-8ea67b188048\"\n ```" operationId: gitpod.v1.EnvironmentService.GetEnvironment parameters: [] requestBody: content: application/json: examples: get_environment_details: description: Retrieves detailed information about a specific environment using its unique identifier. value: environmentId: 07e03a28-65a5-4d98-b532-8ea67b188048 schema: $ref: '#/components/schemas/gitpod.v1.GetEnvironmentRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.GetEnvironmentResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: GetEnvironment tags: - gitpod.v1.EnvironmentService servers: [] /gitpod.v1.EnvironmentService/ListEnvironmentClasses: post: description: "Lists available environment classes with their specifications and resource limits.\n\n Use this method\ \ to understand what types of environments you can create and their\n capabilities. Environment classes define the\ \ compute resources and features available\n to your environments.\n\n ### Examples\n\n - List all available classes:\n\ \n Retrieves a list of all environment classes with their specifications.\n\n ```yaml\n {}\n ```\n buf:lint:ignore\ \ RPC_REQUEST_RESPONSE_UNIQUE" operationId: gitpod.v1.EnvironmentService.ListEnvironmentClasses 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_all_available_classes: description: Retrieves a list of all environment classes with their specifications. value: {} schema: $ref: '#/components/schemas/gitpod.v1.ListEnvironmentClassesRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.ListEnvironmentClassesResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: ListEnvironmentClasses tags: - gitpod.v1.EnvironmentService servers: [] /gitpod.v1.EnvironmentService/ListEnvironments: post: description: "Lists all environments matching the specified criteria.\n\n Use this method to find and monitor environments\ \ across your organization.\n Results are ordered by creation time with newest environments first.\n\n ### Examples\n\ \n - List running environments for a project:\n\n Retrieves all running environments for a specific project with\ \ pagination.\n\n ```yaml\n filter:\n statusPhases: [\"ENVIRONMENT_PHASE_RUNNING\"]\n projectIds: [\"\ b0e12f6c-4c67-429d-a4a6-d9838b5da047\"]\n pagination:\n pageSize: 10\n ```\n\n - List all environments for\ \ a specific runner:\n\n Filters environments by runner ID and creator ID.\n\n ```yaml\n filter:\n runnerIds:\ \ [\"e6aa9c54-89d3-42c1-ac31-bd8d8f1concentrate\"]\n creatorIds: [\"f53d2330-3795-4c5d-a1f3-453121af9c60\"]\n\ \ ```\n\n - List stopped and deleted environments:\n\n Retrieves all environments in stopped or deleted state.\n\ \n ```yaml\n filter:\n statusPhases: [\"ENVIRONMENT_PHASE_STOPPED\", \"ENVIRONMENT_PHASE_DELETED\"]\n ```" operationId: gitpod.v1.EnvironmentService.ListEnvironments 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_all_environments_for_a_specific_runner: description: Filters environments by runner ID and creator ID. value: filter: creatorIds: - f53d2330-3795-4c5d-a1f3-453121af9c60 runnerIds: - e6aa9c54-89d3-42c1-ac31-bd8d8f1concentrate list_running_environments_for_a_project: description: Retrieves all running environments for a specific project with pagination. value: filter: projectIds: - b0e12f6c-4c67-429d-a4a6-d9838b5da047 statusPhases: - ENVIRONMENT_PHASE_RUNNING pagination: pageSize: 10 list_stopped_and_deleted_environments: description: Retrieves all environments in stopped or deleted state. value: filter: statusPhases: - ENVIRONMENT_PHASE_STOPPED - ENVIRONMENT_PHASE_DELETED schema: $ref: '#/components/schemas/gitpod.v1.ListEnvironmentsRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.ListEnvironmentsResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: ListEnvironments tags: - gitpod.v1.EnvironmentService servers: [] /gitpod.v1.EnvironmentService/MarkEnvironmentActive: post: description: "Records environment activity to prevent automatic shutdown.\n\n Activity signals should be sent every\ \ 5 minutes while the environment\n is actively being used. The source must be between 3-80 characters.\n\n ### Examples\n\ \n - Signal VS Code activity:\n\n Records VS Code editor activity to prevent environment shutdown.\n\n ```yaml\n\ \ environmentId: \"07e03a28-65a5-4d98-b532-8ea67b188048\"\n activitySignal:\n source: \"VS Code\"\n timestamp:\ \ \"2025-02-12T14:30:00Z\"\n ```" operationId: gitpod.v1.EnvironmentService.MarkEnvironmentActive parameters: [] requestBody: content: application/json: examples: signal_vs_code_activity: description: Records VS Code editor activity to prevent environment shutdown. value: activitySignal: source: VS Code timestamp: '2025-02-12T14:30:00Z' environmentId: 07e03a28-65a5-4d98-b532-8ea67b188048 schema: $ref: '#/components/schemas/gitpod.v1.MarkEnvironmentActiveRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.MarkEnvironmentActiveResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: MarkEnvironmentActive tags: - gitpod.v1.EnvironmentService servers: [] /gitpod.v1.EnvironmentService/StartEnvironment: post: description: "Starts a stopped environment.\n\n Use this method to resume work on a previously stopped environment.\ \ The environment\n retains its configuration and workspace content from when it was stopped.\n\n ### Examples\n\n\ \ - Start an environment:\n\n Resumes a previously stopped environment with its existing configuration.\n\n ```yaml\n\ \ environmentId: \"07e03a28-65a5-4d98-b532-8ea67b188048\"\n ```" operationId: gitpod.v1.EnvironmentService.StartEnvironment parameters: [] requestBody: content: application/json: examples: start_an_environment: description: Resumes a previously stopped environment with its existing configuration. value: environmentId: 07e03a28-65a5-4d98-b532-8ea67b188048 schema: $ref: '#/components/schemas/gitpod.v1.StartEnvironmentRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.StartEnvironmentResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: StartEnvironment tags: - gitpod.v1.EnvironmentService servers: [] /gitpod.v1.EnvironmentService/StopEnvironment: post: description: "Stops a running environment.\n\n Use this method to pause work while preserving the environment's state.\n\ \ The environment can be resumed later using StartEnvironment.\n\n ### Examples\n\n - Stop an environment:\n\n Gracefully\ \ stops a running environment while preserving its state.\n\n ```yaml\n environmentId: \"07e03a28-65a5-4d98-b532-8ea67b188048\"\ \n ```" operationId: gitpod.v1.EnvironmentService.StopEnvironment parameters: [] requestBody: content: application/json: examples: stop_an_environment: description: Gracefully stops a running environment while preserving its state. value: environmentId: 07e03a28-65a5-4d98-b532-8ea67b188048 schema: $ref: '#/components/schemas/gitpod.v1.StopEnvironmentRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.StopEnvironmentResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: StopEnvironment tags: - gitpod.v1.EnvironmentService servers: [] /gitpod.v1.EnvironmentService/UnarchiveEnvironment: post: description: "Unarchives an environment.\n\n ### Examples\n\n - Unarchive an environment:\n\n ```yaml\n environmentId:\ \ \"07e03a28-65a5-4d98-b532-8ea67b188048\"\n ```" operationId: gitpod.v1.EnvironmentService.UnarchiveEnvironment parameters: [] requestBody: content: application/json: examples: unarchive_an_environment: description: 'environmentId: "07e03a28-65a5-4d98-b532-8ea67b188048" ' value: environmentId: 07e03a28-65a5-4d98-b532-8ea67b188048 schema: $ref: '#/components/schemas/gitpod.v1.UnarchiveEnvironmentRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.UnarchiveEnvironmentResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: UnarchiveEnvironment tags: - gitpod.v1.EnvironmentService servers: [] /gitpod.v1.EnvironmentService/UpdateEnvironment: post: description: "Updates an environment's configuration while it is running.\n\n Updates are limited to:\n - Git credentials\ \ (username, email)\n - SSH public keys\n - Content initialization\n - Port configurations\n - Automation files\n\ \ - Environment timeouts\n\n ### Examples\n\n - Update Git credentials:\n\n Updates the Git configuration for the\ \ environment.\n\n ```yaml\n environmentId: \"07e03a28-65a5-4d98-b532-8ea67b188048\"\n spec:\n content:\n\ \ gitUsername: \"example-user\"\n gitEmail: \"user@example.com\"\n ```\n\n - Add SSH public key:\n\n\ \ Adds a new SSH public key for authentication.\n\n ```yaml\n environmentId: \"07e03a28-65a5-4d98-b532-8ea67b188048\"\ \n spec:\n sshPublicKeys:\n - id: \"0194b7c1-c954-718d-91a4-9a742aa5fc11\"\n value: \"ssh-ed25519\ \ AAAAC3NzaC1lZDI1NTE5AAAAI...\"\n ```\n\n - Update content session:\n\n Updates the content session identifier\ \ for the environment.\n\n ```yaml\n environmentId: \"07e03a28-65a5-4d98-b532-8ea67b188048\"\n spec:\n content:\n\ \ session: \"0194b7c1-c954-718d-91a4-9a742aa5fc11\"\n ```\n\n Note: Machine class changes require stopping\ \ the environment and creating a new one." operationId: gitpod.v1.EnvironmentService.UpdateEnvironment parameters: [] requestBody: content: application/json: examples: add_ssh_public_key: description: Adds a new SSH public key for authentication. value: environmentId: 07e03a28-65a5-4d98-b532-8ea67b188048 spec: sshPublicKeys: - id: 0194b7c1-c954-718d-91a4-9a742aa5fc11 value: ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAI... update_content_session: description: Updates the content session identifier for the environment. value: environmentId: 07e03a28-65a5-4d98-b532-8ea67b188048 spec: content: session: 0194b7c1-c954-718d-91a4-9a742aa5fc11 update_git_credentials: description: Updates the Git configuration for the environment. value: environmentId: 07e03a28-65a5-4d98-b532-8ea67b188048 spec: content: gitEmail: user@example.com gitUsername: example-user schema: $ref: '#/components/schemas/gitpod.v1.UpdateEnvironmentRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.UpdateEnvironmentResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: UpdateEnvironment tags: - gitpod.v1.EnvironmentService servers: [] /gitpod.v1.ErrorsService/ReportErrors: post: description: "ReportErrors allows clients to report batches of errors that will be sent to error reporting systems.\n\ \ The structure is fully compatible with Sentry's event payload format.\n\n Use this method to:\n - Report client-side\ \ errors and exceptions\n - Track application crashes and panics\n - Send error context and metadata for debugging\n\ \n ### Examples\n\n - Report a JavaScript error with Sentry-compatible structure:\n The service accepts events with\ \ comprehensive error information\n including stack traces, identity context, breadcrumbs, and metadata\n that\ \ align with Sentry's event payload format." operationId: gitpod.v1.ErrorsService.ReportErrors parameters: [] requestBody: content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.ReportErrorsRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.ReportErrorsResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: ReportErrors tags: - gitpod.v1.ErrorsService servers: [] /gitpod.v1.EventService/ListAuditLogs: post: description: "Lists audit logs with filtering and pagination options.\n\n Use this method to:\n - View audit history\n\ \ - Track user actions\n - Monitor system changes\n\n ### Examples\n\n - List all logs:\n\n ```yaml\n pagination:\n\ \ pageSize: 20\n ```\n\n - Filter by actor:\n\n ```yaml\n filter:\n actorIds: [\"d2c94c27-3b76-4a42-b88c-95a85e392c68\"\ ]\n actorPrincipals: [\"PRINCIPAL_USER\"]\n pagination:\n pageSize: 20\n ```\n\n - Filter by time range:\n\ \n ```yaml\n filter:\n from: \"2024-01-01T00:00:00Z\"\n to: \"2024-02-01T00:00:00Z\"\n pagination:\n\ \ pageSize: 20\n ```" operationId: gitpod.v1.EventService.ListAuditLogs 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: filter_by_actor: description: "filter:\n actorIds: [\"d2c94c27-3b76-4a42-b88c-95a85e392c68\"]\n actorPrincipals: [\"PRINCIPAL_USER\"\ ]\npagination:\n pageSize: 20\n" value: filter: actorIds: - d2c94c27-3b76-4a42-b88c-95a85e392c68 actorPrincipals: - PRINCIPAL_USER pagination: pageSize: 20 filter_by_time_range: description: "filter:\n from: \"2024-01-01T00:00:00Z\"\n to: \"2024-02-01T00:00:00Z\"\npagination:\n pageSize:\ \ 20\n" value: filter: from: '2024-01-01T00:00:00Z' to: '2024-02-01T00:00:00Z' pagination: pageSize: 20 list_all_logs: description: "pagination:\n pageSize: 20\n" value: pagination: pageSize: 20 schema: $ref: '#/components/schemas/gitpod.v1.ListAuditLogsRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.ListAuditLogsResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: ListAuditLogs tags: - gitpod.v1.EventService servers: [] /gitpod.v1.EventService/WatchEvents: post: description: "Streams events for all projects, runners, environments, tasks, and services based on the\n specified scope.\n\ \n Use this method to:\n - Monitor resource changes in real-time\n - Track system events\n - Receive notifications\n\ \n The scope parameter determines which events to watch:\n - Organization scope (default): Watch all organization-wide\ \ events including projects,\n runners and environments. Task and service events are not included. Use by setting\n\ \ organization=true or omitting the scope.\n - Environment scope: Watch events for a specific environment, including\ \ its tasks,\n task executions, and services. Use by setting environment_id to the UUID of the\n environment to\ \ watch." operationId: gitpod.v1.EventService.WatchEvents parameters: [] requestBody: content: application/jsonl: schema: $ref: '#/components/schemas/gitpod.v1.WatchEventsRequest' required: true responses: '200': content: application/jsonl: schema: $ref: '#/components/schemas/gitpod.v1.WatchEventsResponse' description: Success default: content: application/jsonl: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: WatchEvents tags: - gitpod.v1.EventService servers: [] /gitpod.v1.GatewayService/ListGateways: post: operationId: gitpod.v1.GatewayService.ListGateways 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.ListGatewaysRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.ListGatewaysResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: ListGateways tags: - gitpod.v1.GatewayService servers: [] /gitpod.v1.GroupService/CreateGroup: post: description: "Creates a new group within an organization.\n\n Use this method to:\n - Create teams for access control\n\ \ - Organize users by department or function\n - Set up role-based access groups\n\n ### Examples\n\n - Create a basic\ \ group:\n\n Creates a group with name and description.\n\n ```yaml\n organizationId: \"b0e12f6c-4c67-429d-a4a6-d9838b5da047\"\ \n name: \"Backend Team\"\n description: \"Backend engineering team\"\n ```\n\n ### Authorization\n\n Requires\ \ `org:admin` role on the organization." operationId: gitpod.v1.GroupService.CreateGroup parameters: [] requestBody: content: application/json: examples: create_a_basic_group: description: Creates a group with name and description. value: description: Backend engineering team name: Backend Team organizationId: b0e12f6c-4c67-429d-a4a6-d9838b5da047 schema: $ref: '#/components/schemas/gitpod.v1.CreateGroupRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.CreateGroupResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: CreateGroup tags: - gitpod.v1.GroupService servers: [] /gitpod.v1.GroupService/CreateMembership: post: description: "Creates a membership for a user in a group.\n\n Use this method to:\n - Add users to groups\n - Grant\ \ group-based permissions to users\n\n ### Examples\n\n - Add a user to a group:\n\n Creates a membership for a\ \ user in a group.\n\n ```yaml\n groupId: \"d2c94c27-3b76-4a42-b88c-95a85e392c68\"\n subject:\n id: \"f53d2330-3795-4c5d-a1f3-453121af9c60\"\ \n principal: PRINCIPAL_USER\n ```\n\n ### Authorization\n\n Requires `org:admin` permission on the organization\ \ or `group:admin` permission on the specific group." operationId: gitpod.v1.GroupService.CreateMembership parameters: [] requestBody: content: application/json: examples: add_a_user_to_a_group: description: Creates a membership for a user in a group. value: groupId: d2c94c27-3b76-4a42-b88c-95a85e392c68 subject: id: f53d2330-3795-4c5d-a1f3-453121af9c60 principal: PRINCIPAL_USER schema: $ref: '#/components/schemas/gitpod.v1.CreateMembershipRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.CreateMembershipResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: CreateMembership tags: - gitpod.v1.GroupService servers: [] /gitpod.v1.GroupService/CreateRoleAssignment: post: description: "Creates a role assignment for a group on a resource.\n\n Use this method to:\n - Assign specific roles\ \ to groups on runners, projects, or environments\n - Grant group-based access to resources\n\n ### Examples\n\n -\ \ Assign admin role on a runner:\n\n Grants the group admin access to a runner.\n\n ```yaml\n groupId: \"d2c94c27-3b76-4a42-b88c-95a85e392c68\"\ \n resourceType: RESOURCE_TYPE_RUNNER\n resourceId: \"f53d2330-3795-4c5d-a1f3-453121af9c60\"\n resourceRole:\ \ RESOURCE_ROLE_RUNNER_ADMIN\n ```\n\n - Assign user role on a project:\n\n Grants the group user access to a\ \ project.\n\n ```yaml\n groupId: \"d2c94c27-3b76-4a42-b88c-95a85e392c68\"\n resourceType: RESOURCE_TYPE_PROJECT\n\ \ resourceId: \"a1b2c3d4-5678-90ab-cdef-1234567890ab\"\n resourceRole: RESOURCE_ROLE_PROJECT_USER\n ```\n\n\ \ ### Authorization\n\n Requires admin role on the specific resource." operationId: gitpod.v1.GroupService.CreateRoleAssignment parameters: [] requestBody: content: application/json: examples: assign_admin_role_on_a_runner: description: Grants the group admin access to a runner. value: groupId: d2c94c27-3b76-4a42-b88c-95a85e392c68 resourceId: f53d2330-3795-4c5d-a1f3-453121af9c60 resourceRole: RESOURCE_ROLE_RUNNER_ADMIN resourceType: RESOURCE_TYPE_RUNNER assign_user_role_on_a_project: description: Grants the group user access to a project. value: groupId: d2c94c27-3b76-4a42-b88c-95a85e392c68 resourceId: a1b2c3d4-5678-90ab-cdef-1234567890ab resourceRole: RESOURCE_ROLE_PROJECT_USER resourceType: RESOURCE_TYPE_PROJECT schema: $ref: '#/components/schemas/gitpod.v1.CreateRoleAssignmentRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.CreateRoleAssignmentResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: CreateRoleAssignment tags: - gitpod.v1.GroupService servers: [] /gitpod.v1.GroupService/DeleteGroup: post: description: "Deletes a group and removes all its resource assignments.\n\n When a group is deleted, all resource assignments\ \ revert to org-level scope.\n\n Use this method to:\n - Remove unused groups\n - Clean up after team reorganization\n\ \n ### Examples\n\n - Delete a group:\n\n Permanently removes a group.\n\n ```yaml\n groupId: \"d2c94c27-3b76-4a42-b88c-95a85e392c68\"\ \n ```\n\n ### Authorization\n\n Requires `org:admin` role on the organization." operationId: gitpod.v1.GroupService.DeleteGroup parameters: [] requestBody: content: application/json: examples: delete_a_group: description: Permanently removes a group. value: groupId: d2c94c27-3b76-4a42-b88c-95a85e392c68 schema: $ref: '#/components/schemas/gitpod.v1.DeleteGroupRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.DeleteGroupResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: DeleteGroup tags: - gitpod.v1.GroupService servers: [] /gitpod.v1.GroupService/DeleteMembership: post: description: "Deletes a membership for a user in a group.\n\n Use this method to:\n - Remove users from groups\n - Revoke\ \ group-based permissions\n\n ### Examples\n\n - Remove a user from a group:\n\n Deletes a membership by its ID.\n\ \n ```yaml\n membershipId: \"a1b2c3d4-5678-90ab-cdef-1234567890ab\"\n ```\n\n ### Authorization\n\n Requires\ \ `org:admin` permission on the organization or `group:admin` permission on the specific group." operationId: gitpod.v1.GroupService.DeleteMembership parameters: [] requestBody: content: application/json: examples: remove_a_user_from_a_group: description: Deletes a membership by its ID. value: membershipId: a1b2c3d4-5678-90ab-cdef-1234567890ab schema: $ref: '#/components/schemas/gitpod.v1.DeleteMembershipRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.DeleteMembershipResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: DeleteMembership tags: - gitpod.v1.GroupService servers: [] /gitpod.v1.GroupService/DeleteRoleAssignment: post: description: "Deletes a role assignment.\n\n Use this method to:\n - Remove group access to resources\n - Revoke role-based\ \ permissions\n\n ### Examples\n\n - Delete a role assignment:\n\n Removes a role assignment by its ID.\n\n ```yaml\n\ \ assignmentId: \"a1b2c3d4-5678-90ab-cdef-1234567890ab\"\n ```\n\n ### Authorization\n\n Requires admin role on\ \ the specific resource." operationId: gitpod.v1.GroupService.DeleteRoleAssignment parameters: [] requestBody: content: application/json: examples: delete_a_role_assignment: description: Removes a role assignment by its ID. value: assignmentId: a1b2c3d4-5678-90ab-cdef-1234567890ab schema: $ref: '#/components/schemas/gitpod.v1.DeleteRoleAssignmentRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.DeleteRoleAssignmentResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: DeleteRoleAssignment tags: - gitpod.v1.GroupService servers: [] /gitpod.v1.GroupService/GetGroup: post: description: "Gets information about a specific group by ID or name.\n\n Use this method to:\n - Retrieve group details\ \ and metadata\n - Check group configuration\n - View member count\n\n ### Examples\n\n - Get group by ID:\n\n Retrieves\ \ information about a specific group by its unique ID.\n\n ```yaml\n id: \"d2c94c27-3b76-4a42-b88c-95a85e392c68\"\ \n ```\n\n ### Authorization\n\n All organization members can view group information (transparency model)." operationId: gitpod.v1.GroupService.GetGroup parameters: [] requestBody: content: application/json: examples: get_group_by_id: description: Retrieves information about a specific group by its unique ID. value: id: d2c94c27-3b76-4a42-b88c-95a85e392c68 schema: $ref: '#/components/schemas/gitpod.v1.GetGroupRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.GetGroupResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: GetGroup tags: - gitpod.v1.GroupService servers: [] /gitpod.v1.GroupService/GetMembership: post: description: "Gets a specific membership by group ID and subject.\n\n Use this method to:\n - Check if a user or service\ \ account is a member of a group\n - Verify group membership for access control\n\n ### Examples\n\n - Check user\ \ membership:\n\n Checks if a user is a member of a specific group.\n\n ```yaml\n groupId: \"d2c94c27-3b76-4a42-b88c-95a85e392c68\"\ \n subject:\n id: \"f53d2330-3795-4c5d-a1f3-453121af9c60\"\n principal: PRINCIPAL_USER\n ```\n\n ### Authorization\n\ \n All organization members can check group membership (transparency model)." operationId: gitpod.v1.GroupService.GetMembership parameters: [] requestBody: content: application/json: examples: check_user_membership: description: Checks if a user is a member of a specific group. value: groupId: d2c94c27-3b76-4a42-b88c-95a85e392c68 subject: id: f53d2330-3795-4c5d-a1f3-453121af9c60 principal: PRINCIPAL_USER schema: $ref: '#/components/schemas/gitpod.v1.GetMembershipRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.GetMembershipResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: GetMembership tags: - gitpod.v1.GroupService servers: [] /gitpod.v1.GroupService/ListGroups: post: description: "Lists groups with optional pagination.\n\n Use this method to:\n - View all groups in an organization\n\ \ - Check group memberships\n - Monitor group configurations\n - Audit group access\n\n ### Examples\n\n - List all\ \ groups:\n\n Shows all groups with pagination.\n\n ```yaml\n pagination:\n pageSize: 20\n ```\n\n - List\ \ with custom page size:\n\n Shows groups with specified page size.\n\n ```yaml\n pagination:\n pageSize:\ \ 50\n token: \"next-page-token-from-previous-response\"\n ```\n\n ### Authorization\n\n All organization members\ \ can list groups (transparency model)." operationId: gitpod.v1.GroupService.ListGroups 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_all_groups: description: Shows all groups with pagination. value: pagination: pageSize: 20 list_with_custom_page_size: description: Shows groups with specified page size. value: pagination: pageSize: 50 token: next-page-token-from-previous-response schema: $ref: '#/components/schemas/gitpod.v1.ListGroupsRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.ListGroupsResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: ListGroups tags: - gitpod.v1.GroupService servers: [] /gitpod.v1.GroupService/ListMemberships: post: description: "Lists all memberships of a group.\n\n Use this method to:\n - View all members of a group\n - Audit group\ \ membership\n\n ### Examples\n\n - List group members:\n\n Shows all members of a specific group.\n\n ```yaml\n\ \ groupId: \"d2c94c27-3b76-4a42-b88c-95a85e392c68\"\n pagination:\n pageSize: 20\n ```\n\n ### Authorization\n\ \n All organization members can view group membership (transparency model)." operationId: gitpod.v1.GroupService.ListMemberships 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_group_members: description: Shows all members of a specific group. value: groupId: d2c94c27-3b76-4a42-b88c-95a85e392c68 pagination: pageSize: 20 schema: $ref: '#/components/schemas/gitpod.v1.ListMembershipsRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.ListMembershipsResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: ListMemberships tags: - gitpod.v1.GroupService servers: [] /gitpod.v1.GroupService/ListRoleAssignments: post: description: "Lists role assignments for a group or resource.\n\n Use this method to:\n - View all role assignments\ \ for a group\n - Audit resource access\n - Check which groups have access to resources\n\n ### Examples\n\n - List\ \ role assignments for a group:\n\n Shows all role assignments for a specific group.\n\n ```yaml\n filter:\n\ \ groupId: \"d2c94c27-3b76-4a42-b88c-95a85e392c68\"\n pagination:\n pageSize: 20\n ```\n\n - List role\ \ assignments by resource type:\n\n Shows all role assignments for runners.\n\n ```yaml\n filter:\n resourceTypes:\n\ \ - RESOURCE_TYPE_RUNNER\n pagination:\n pageSize: 20\n ```\n\n ### Authorization\n\n All organization\ \ members can view role assignments (transparency model)." operationId: gitpod.v1.GroupService.ListRoleAssignments 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_role_assignments_by_resource_type: description: Shows all role assignments for runners. value: filter: resourceTypes: - RESOURCE_TYPE_RUNNER pagination: pageSize: 20 list_role_assignments_for_a_group: description: Shows all role assignments for a specific group. value: filter: groupId: d2c94c27-3b76-4a42-b88c-95a85e392c68 pagination: pageSize: 20 schema: $ref: '#/components/schemas/gitpod.v1.ListRoleAssignmentsRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.ListRoleAssignmentsResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: ListRoleAssignments tags: - gitpod.v1.GroupService servers: [] /gitpod.v1.GroupService/ShareResourceWithPrincipal: post: description: "Shares a resource directly with a principal (user or service account).\n\n Use this method to:\n - Grant\ \ a user or service account direct access to a runner, project, or other resource\n - Share resources without creating\ \ and managing groups manually\n\n ### Examples\n\n - Share a runner with a user:\n\n Grants admin access to a runner\ \ for a specific user.\n\n ```yaml\n resourceType: RESOURCE_TYPE_RUNNER\n resourceId: \"d2c94c27-3b76-4a42-b88c-95a85e392c68\"\ \n principal: PRINCIPAL_USER\n principalId: \"f53d2330-3795-4c5d-a1f3-453121af9c60\"\n role: RESOURCE_ROLE_RUNNER_ADMIN\n\ \ ```\n\n - Share a runner with a service account:\n\n Grants user access to a runner for a service account.\n\ \n ```yaml\n resourceType: RESOURCE_TYPE_RUNNER\n resourceId: \"d2c94c27-3b76-4a42-b88c-95a85e392c68\"\n principal:\ \ PRINCIPAL_SERVICE_ACCOUNT\n principalId: \"a1b2c3d4-5678-90ab-cdef-1234567890ab\"\n role: RESOURCE_ROLE_RUNNER_USER\n\ \ ```\n\n ### Authorization\n\n Requires admin role on the specific resource." operationId: gitpod.v1.GroupService.ShareResourceWithPrincipal parameters: [] requestBody: content: application/json: examples: share_a_runner_with_a_service_account: description: Grants user access to a runner for a service account. value: principal: PRINCIPAL_SERVICE_ACCOUNT principalId: a1b2c3d4-5678-90ab-cdef-1234567890ab resourceId: d2c94c27-3b76-4a42-b88c-95a85e392c68 resourceType: RESOURCE_TYPE_RUNNER role: RESOURCE_ROLE_RUNNER_USER share_a_runner_with_a_user: description: Grants admin access to a runner for a specific user. value: principal: PRINCIPAL_USER principalId: f53d2330-3795-4c5d-a1f3-453121af9c60 resourceId: d2c94c27-3b76-4a42-b88c-95a85e392c68 resourceType: RESOURCE_TYPE_RUNNER role: RESOURCE_ROLE_RUNNER_ADMIN schema: $ref: '#/components/schemas/gitpod.v1.ShareResourceWithPrincipalRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.ShareResourceWithPrincipalResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: ShareResourceWithPrincipal tags: - gitpod.v1.GroupService servers: [] /gitpod.v1.GroupService/UnshareResourceWithPrincipal: post: description: "Removes direct access for a principal (user or service account) from a resource.\n\n Use this method to:\n\ \ - Revoke a principal's direct access to a resource\n - Remove sharing without affecting group-based access\n\n ###\ \ Examples\n\n - Remove user access from a runner:\n\n Revokes a user's direct access to a runner.\n\n ```yaml\n\ \ resourceType: RESOURCE_TYPE_RUNNER\n resourceId: \"d2c94c27-3b76-4a42-b88c-95a85e392c68\"\n principal: PRINCIPAL_USER\n\ \ principalId: \"f53d2330-3795-4c5d-a1f3-453121af9c60\"\n ```\n\n ### Authorization\n\n Requires admin role on\ \ the specific resource." operationId: gitpod.v1.GroupService.UnshareResourceWithPrincipal parameters: [] requestBody: content: application/json: examples: remove_user_access_from_a_runner: description: Revokes a user's direct access to a runner. value: principal: PRINCIPAL_USER principalId: f53d2330-3795-4c5d-a1f3-453121af9c60 resourceId: d2c94c27-3b76-4a42-b88c-95a85e392c68 resourceType: RESOURCE_TYPE_RUNNER schema: $ref: '#/components/schemas/gitpod.v1.UnshareResourceWithPrincipalRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.UnshareResourceWithPrincipalResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: UnshareResourceWithPrincipal tags: - gitpod.v1.GroupService servers: [] /gitpod.v1.GroupService/UpdateGroup: post: description: "Updates group information.\n\n Use this method to:\n - Rename a group\n - Update group description\n\n\ \ ### Examples\n\n - Update group name:\n\n Changes the name of an existing group.\n\n ```yaml\n groupId: \"\ d2c94c27-3b76-4a42-b88c-95a85e392c68\"\n name: \"Platform Team\"\n description: \"Platform engineering team\"\n\ \ ```\n\n ### Authorization\n\n Requires `org:admin` permission on the organization or `group:admin` permission\ \ on the specific group." operationId: gitpod.v1.GroupService.UpdateGroup parameters: [] requestBody: content: application/json: examples: update_group_name: description: Changes the name of an existing group. value: description: Platform engineering team groupId: d2c94c27-3b76-4a42-b88c-95a85e392c68 name: Platform Team schema: $ref: '#/components/schemas/gitpod.v1.UpdateGroupRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.UpdateGroupResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: UpdateGroup tags: - gitpod.v1.GroupService servers: [] /gitpod.v1.IdentityService/ExchangeToken: post: description: "Exchanges an exchange token for a new access token.\n\n Use this method to:\n - Convert exchange tokens\ \ to access tokens\n - Obtain new access credentials\n - Complete token exchange flows\n\n ### Examples\n\n - Exchange\ \ token:\n\n Trades an exchange token for an access token.\n\n ```yaml\n exchangeToken: \"exchange-token-value\"\ \n ```" operationId: gitpod.v1.IdentityService.ExchangeToken parameters: [] requestBody: content: application/json: examples: exchange_token: description: Trades an exchange token for an access token. value: exchangeToken: exchange-token-value schema: $ref: '#/components/schemas/gitpod.v1.ExchangeTokenRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.ExchangeTokenResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: ExchangeToken tags: - gitpod.v1.IdentityService servers: [] /gitpod.v1.IdentityService/GetAuthenticatedIdentity: post: description: "Retrieves information about the currently authenticated identity.\n\n Use this method to:\n - Get current\ \ user information\n - Check authentication status\n - Retrieve organization context\n - Validate authentication principal\n\ \n ### Examples\n\n - Get current identity:\n\n Retrieves details about the authenticated user.\n\n ```yaml\n\ \ {}\n ```" operationId: gitpod.v1.IdentityService.GetAuthenticatedIdentity parameters: [] requestBody: content: application/json: examples: get_current_identity: description: Retrieves details about the authenticated user. value: {} schema: $ref: '#/components/schemas/gitpod.v1.GetAuthenticatedIdentityRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.GetAuthenticatedIdentityResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: GetAuthenticatedIdentity tags: - gitpod.v1.IdentityService servers: [] /gitpod.v1.IdentityService/GetIDToken: post: description: "Gets an ID token for authenticating with other services.\n\n Use this method to:\n - Obtain authentication\ \ tokens for service-to-service calls\n - Access protected resources\n - Generate scoped access tokens\n\n ### Examples\n\ \n - Get token for single service:\n\n Retrieves a token for authenticating with one service.\n\n ```yaml\n \ \ audience:\n - \"https://api.gitpod.io\"\n ```\n\n - Get token for multiple services:\n\n Retrieves a token\ \ valid for multiple services.\n\n ```yaml\n audience:\n - \"https://api.gitpod.io\"\n - \"https://ws.gitpod.io\"\ \n ```" operationId: gitpod.v1.IdentityService.GetIDToken parameters: [] requestBody: content: application/json: examples: get_token_for_multiple_services: description: Retrieves a token valid for multiple services. value: audience: - https://api.gitpod.io - https://ws.gitpod.io get_token_for_single_service: description: Retrieves a token for authenticating with one service. value: audience: - https://api.gitpod.io schema: $ref: '#/components/schemas/gitpod.v1.GetIDTokenRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.GetIDTokenResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: GetIDToken tags: - gitpod.v1.IdentityService servers: [] /gitpod.v1.InsightsService/DisableProjectInsights: post: description: "Disables co-author insights for a project. Idempotent.\n Removes the associated workflow (if any) and\ \ sets enabled to false." operationId: gitpod.v1.InsightsService.DisableProjectInsights parameters: [] requestBody: content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.DisableProjectInsightsRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.DisableProjectInsightsResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: DisableProjectInsights tags: - gitpod.v1.InsightsService servers: [] /gitpod.v1.InsightsService/EnableProjectInsights: post: description: Enables co-author insights for a project. Idempotent. operationId: gitpod.v1.InsightsService.EnableProjectInsights parameters: [] requestBody: content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.EnableProjectInsightsRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.EnableProjectInsightsResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: EnableProjectInsights tags: - gitpod.v1.InsightsService servers: [] /gitpod.v1.InsightsService/GetAgentTraceStats: post: deprecated: true description: "Deprecated: Use UsageService.GetAgentTraceSummary and\n UsageService.GetAgentTraceTimeSeries instead." operationId: gitpod.v1.InsightsService.GetAgentTraceStats parameters: [] requestBody: content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.GetAgentTraceStatsRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.GetAgentTraceStatsResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: GetAgentTraceStats tags: - gitpod.v1.InsightsService servers: [] /gitpod.v1.InsightsService/GetCoAuthorStats: post: deprecated: true description: "Deprecated: Use UsageService.GetCoAuthorSummary and\n UsageService.GetCoAuthorTimeSeries instead.\n This\ \ will later be removed." operationId: gitpod.v1.InsightsService.GetCoAuthorStats parameters: [] requestBody: content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.GetCoAuthorStatsRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.GetCoAuthorStatsResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: GetCoAuthorStats tags: - gitpod.v1.InsightsService servers: [] /gitpod.v1.InsightsService/GetInsightsSummary: post: description: Returns how many projects have insights enabled vs total projects in the org. operationId: gitpod.v1.InsightsService.GetInsightsSummary parameters: [] requestBody: content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.GetInsightsSummaryRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.GetInsightsSummaryResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: GetInsightsSummary tags: - gitpod.v1.InsightsService servers: [] /gitpod.v1.InsightsService/GetPrStatsSummary: post: deprecated: true description: "Deprecated: Use UsageService.GetPrSummary and\n UsageService.GetPrTimeSeries instead." operationId: gitpod.v1.InsightsService.GetPrStatsSummary parameters: [] requestBody: content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.GetPrStatsSummaryRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.GetPrStatsSummaryResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: GetPrStatsSummary tags: - gitpod.v1.InsightsService servers: [] /gitpod.v1.InsightsService/GetProjectInsightsStatus: post: description: Returns whether co-author insights is enabled for a project. operationId: gitpod.v1.InsightsService.GetProjectInsightsStatus parameters: [] requestBody: content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.GetProjectInsightsStatusRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.GetProjectInsightsStatusResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: GetProjectInsightsStatus tags: - gitpod.v1.InsightsService servers: [] /gitpod.v1.InsightsService/ReportAgentTrace: post: description: "Reports an agent trace session for a project environment.\n Stores the raw trace alongside denormalized\ \ line-change totals." operationId: gitpod.v1.InsightsService.ReportAgentTrace parameters: [] requestBody: content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.ReportAgentTraceRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.ReportAgentTraceResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: ReportAgentTrace tags: - gitpod.v1.InsightsService servers: [] /gitpod.v1.InsightsService/ReportCoAuthorStats: post: description: "Reports co-author analysis results from a project's git history.\n Accepts a batch of per-commit stats.\ \ Writes are idempotent: re-reporting\n the same commit (project_id + commit_hash) overwrites the previous row." operationId: gitpod.v1.InsightsService.ReportCoAuthorStats parameters: [] requestBody: content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.ReportCoAuthorStatsRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.ReportCoAuthorStatsResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: ReportCoAuthorStats tags: - gitpod.v1.InsightsService servers: [] /gitpod.v1.InsightsService/ReportPrStats: post: description: "Reports PR speed metrics collected from SCM APIs.\n Accepts a batch of per-PR stats. Writes are idempotent:\ \ re-reporting\n the same PR (project_id + pr_number) overwrites the previous row." operationId: gitpod.v1.InsightsService.ReportPrStats parameters: [] requestBody: content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.ReportPrStatsRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.ReportPrStatsResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: ReportPrStats tags: - gitpod.v1.InsightsService servers: [] /gitpod.v1.IntegrationService/CreateIntegration: post: description: "Creates a new integration instance within an organization.\n\n Use this method to:\n - Instantiate an\ \ integration for an organization\n - Configure integration-specific settings\n - Enable integration capabilities" operationId: gitpod.v1.IntegrationService.CreateIntegration parameters: [] requestBody: content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.CreateIntegrationRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.CreateIntegrationResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: CreateIntegration tags: - gitpod.v1.IntegrationService servers: [] /gitpod.v1.IntegrationService/CreateIntegrationDefinition: post: description: "Creates a new integration definition.\n Requires service account authentication.\n\n Use this method to:\n\ \ - Add new integration types dynamically\n - Configure integration capabilities\n - Set up authentication requirements" operationId: gitpod.v1.IntegrationService.CreateIntegrationDefinition parameters: [] requestBody: content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.CreateIntegrationDefinitionRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.CreateIntegrationDefinitionResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: CreateIntegrationDefinition tags: - gitpod.v1.IntegrationService servers: [] /gitpod.v1.IntegrationService/DeleteIntegration: post: description: "Deletes an integration instance.\n\n Use this method to:\n - Remove unused integrations\n - Clean up configurations\n\ \ - Revoke integration access" operationId: gitpod.v1.IntegrationService.DeleteIntegration parameters: [] requestBody: content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.DeleteIntegrationRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.DeleteIntegrationResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: DeleteIntegration tags: - gitpod.v1.IntegrationService servers: [] /gitpod.v1.IntegrationService/DeleteIntegrationDefinition: post: description: "Deletes an integration definition.\n Requires service account authentication.\n Fails if any integrations\ \ depend on this definition.\n\n Use this method to:\n - Remove unused integration types\n - Clean up deprecated integrations" operationId: gitpod.v1.IntegrationService.DeleteIntegrationDefinition parameters: [] requestBody: content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.DeleteIntegrationDefinitionRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.DeleteIntegrationDefinitionResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: DeleteIntegrationDefinition tags: - gitpod.v1.IntegrationService servers: [] /gitpod.v1.IntegrationService/GetIntegration: post: description: "Gets details about a specific integration instance.\n\n Use this method to:\n - View integration configuration\n\ \ - Check integration status\n - Verify enabled capabilities" operationId: gitpod.v1.IntegrationService.GetIntegration parameters: [] requestBody: content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.GetIntegrationRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.GetIntegrationResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: GetIntegration tags: - gitpod.v1.IntegrationService servers: [] /gitpod.v1.IntegrationService/GetIntegrationDefinition: post: description: "Gets details about a specific integration definition.\n\n Use this method to:\n - View integration definition\ \ configuration\n - Check supported capabilities\n - Verify authentication requirements" operationId: gitpod.v1.IntegrationService.GetIntegrationDefinition parameters: [] requestBody: content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.GetIntegrationDefinitionRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.GetIntegrationDefinitionResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: GetIntegrationDefinition tags: - gitpod.v1.IntegrationService servers: [] /gitpod.v1.IntegrationService/ListIntegrationDefinitions: post: description: "Lists available integration definitions.\n\n Use this method to:\n - View all available integrations\n\ \ - Check integration capabilities\n - Discover supported services" operationId: gitpod.v1.IntegrationService.ListIntegrationDefinitions 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.ListIntegrationDefinitionsRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.ListIntegrationDefinitionsResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: ListIntegrationDefinitions tags: - gitpod.v1.IntegrationService servers: [] /gitpod.v1.IntegrationService/ListIntegrations: post: description: "Lists integration instances for the organization.\n\n Use this method to:\n - View all integrations for\ \ an organization\n - Monitor integration configurations" operationId: gitpod.v1.IntegrationService.ListIntegrations 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.ListIntegrationsRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.ListIntegrationsResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: ListIntegrations tags: - gitpod.v1.IntegrationService servers: [] /gitpod.v1.IntegrationService/UpdateIntegration: post: description: "Updates an existing integration instance.\n\n Use this method to:\n - Modify integration settings\n -\ \ Enable/disable capabilities\n - Change integration status" operationId: gitpod.v1.IntegrationService.UpdateIntegration parameters: [] requestBody: content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.UpdateIntegrationRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.UpdateIntegrationResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: UpdateIntegration tags: - gitpod.v1.IntegrationService servers: [] /gitpod.v1.IntegrationService/UpdateIntegrationDefinition: post: description: "Updates an existing integration definition.\n Requires service account authentication.\n\n Use this method\ \ to:\n - Modify integration capabilities\n - Update authentication configuration\n - Change integration metadata" operationId: gitpod.v1.IntegrationService.UpdateIntegrationDefinition parameters: [] requestBody: content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.UpdateIntegrationDefinitionRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.UpdateIntegrationDefinitionResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: UpdateIntegrationDefinition tags: - gitpod.v1.IntegrationService servers: [] /gitpod.v1.IntegrationService/ValidateIntegration: post: description: "Validates an integration's configuration and connectivity.\n\n Runs a set of checks (e.g. app token validity)\ \ and returns results for each.\n All checks are always returned; failing checks include a message and an optional\ \ action_hint." operationId: gitpod.v1.IntegrationService.ValidateIntegration parameters: [] requestBody: content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.ValidateIntegrationRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.ValidateIntegrationResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: ValidateIntegration tags: - gitpod.v1.IntegrationService servers: [] /gitpod.v1.NotificationService/DeleteNotifications: post: description: Deletes notifications. operationId: gitpod.v1.NotificationService.DeleteNotifications parameters: [] requestBody: content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.DeleteNotificationsRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.DeleteNotificationsResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: DeleteNotifications tags: - gitpod.v1.NotificationService servers: [] /gitpod.v1.NotificationService/ListNotifications: post: description: "Lists notifications for the authenticated user.\n Response includes unread_count and total_count for the\ \ inbox badge." operationId: gitpod.v1.NotificationService.ListNotifications 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.ListNotificationsRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.ListNotificationsResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: ListNotifications tags: - gitpod.v1.NotificationService servers: [] /gitpod.v1.NotificationService/MarkNotificationsRead: post: description: Marks notifications as read. operationId: gitpod.v1.NotificationService.MarkNotificationsRead parameters: [] requestBody: content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.MarkNotificationsReadRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.MarkNotificationsReadResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: MarkNotificationsRead tags: - gitpod.v1.NotificationService servers: [] /gitpod.v1.NotificationService/MarkNotificationsUnread: post: description: Marks notifications as unread. operationId: gitpod.v1.NotificationService.MarkNotificationsUnread parameters: [] requestBody: content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.MarkNotificationsUnreadRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.MarkNotificationsUnreadResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: MarkNotificationsUnread tags: - gitpod.v1.NotificationService servers: [] /gitpod.v1.OnaIntelligenceService/CreateOrganizationLLMConfiguration: post: description: "Creates or updates the Anthropic API key configuration for an organization.\n\n Use this method to:\n\ \ - Configure Anthropic API access for an organization\n - Rotate existing API keys\n\n The API key is encrypted before\ \ storage using organization-scoped encryption." operationId: gitpod.v1.OnaIntelligenceService.CreateOrganizationLLMConfiguration parameters: [] requestBody: content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.CreateOrganizationLLMConfigurationRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.CreateOrganizationLLMConfigurationResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: CreateOrganizationLLMConfiguration tags: - gitpod.v1.OnaIntelligenceService servers: [] /gitpod.v1.OnaIntelligenceService/DeleteOrganizationLLMConfiguration: post: description: "Deletes the organization's LLM API key configuration.\n\n Use this method to:\n - Remove API key access\ \ for an organization\n - Clean up unused configurations" operationId: gitpod.v1.OnaIntelligenceService.DeleteOrganizationLLMConfiguration parameters: [] requestBody: content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.DeleteOrganizationLLMConfigurationRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.DeleteOrganizationLLMConfigurationResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: DeleteOrganizationLLMConfiguration tags: - gitpod.v1.OnaIntelligenceService servers: [] /gitpod.v1.OnaIntelligenceService/GetOrganizationLLMConfiguration: post: description: "Gets metadata about the organization's LLM configuration.\n\n Use this method to:\n - Check if an organization\ \ has an API key configured\n - View when the key was last updated\n\n For security reasons, this method does not\ \ return the actual API key,\n only metadata including the last 4 characters for identification." operationId: gitpod.v1.OnaIntelligenceService.GetOrganizationLLMConfiguration parameters: [] requestBody: content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.GetOrganizationLLMConfigurationRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.GetOrganizationLLMConfigurationResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: GetOrganizationLLMConfiguration tags: - gitpod.v1.OnaIntelligenceService servers: [] /gitpod.v1.OnaIntelligenceService/GetOrganizationLLMUsage: post: description: "Gets credit usage summary for the caller's organization.\n\n The organization is inferred from the caller's\ \ identity.\n\n Use this method to:\n - View Ona credit consumption for your organization\n - Track usage over time\n\ \ - Display usage data to organization admins\n\n Returns pre-aggregated summaries for week, month, and year." operationId: gitpod.v1.OnaIntelligenceService.GetOrganizationLLMUsage parameters: [] requestBody: content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.GetOrganizationLLMUsageRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.GetOrganizationLLMUsageResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: GetOrganizationLLMUsage tags: - gitpod.v1.OnaIntelligenceService servers: [] /gitpod.v1.OnaIntelligenceService/ListOrganizationLLMConfigurations: post: description: "Lists all organization LLM configurations.\n\n Use this method to:\n - View all organizations with LLM\ \ configurations\n - Audit API key usage" operationId: gitpod.v1.OnaIntelligenceService.ListOrganizationLLMConfigurations 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.ListOrganizationLLMConfigurationsRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.ListOrganizationLLMConfigurationsResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: ListOrganizationLLMConfigurations tags: - gitpod.v1.OnaIntelligenceService servers: [] /gitpod.v1.OnaIntelligenceService/UpdateOrganizationLLMConfiguration: post: description: "Updates the Anthropic API key configuration for an organization.\n\n Use this method to:\n - Update existing\ \ API key\n - Modify configuration settings\n\n Only provided fields will be updated (partial update)." operationId: gitpod.v1.OnaIntelligenceService.UpdateOrganizationLLMConfiguration parameters: [] requestBody: content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.UpdateOrganizationLLMConfigurationRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.UpdateOrganizationLLMConfigurationResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: UpdateOrganizationLLMConfiguration tags: - gitpod.v1.OnaIntelligenceService servers: [] /gitpod.v1.OrganizationService/CreateCustomDomain: post: description: "Creates a custom domain configuration for an organization.\n\n Use this method to configure custom domains\ \ for organization workspaces\n\n ### Examples\n\n - Configure AWS custom domain:\n\n Sets up a custom domain with\ \ AWS provider.\n\n ```yaml\n organizationId: \"b0e12f6c-4c67-429d-a4a6-d9838b5da047\"\n domainName: \"workspaces.acme-corp.com\"\ \n provider: CUSTOM_DOMAIN_PROVIDER_AWS\n awsAccountId: \"123456789012\"\n ```" operationId: gitpod.v1.OrganizationService.CreateCustomDomain parameters: [] requestBody: content: application/json: examples: configure_aws_custom_domain: description: Sets up a custom domain with AWS provider. value: awsAccountId: '123456789012' domainName: workspaces.acme-corp.com organizationId: b0e12f6c-4c67-429d-a4a6-d9838b5da047 provider: CUSTOM_DOMAIN_PROVIDER_AWS schema: $ref: '#/components/schemas/gitpod.v1.CreateCustomDomainRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.CreateCustomDomainResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: CreateCustomDomain tags: - gitpod.v1.OrganizationService servers: [] /gitpod.v1.OrganizationService/CreateDomainVerification: post: description: "Initiates domain verification process to enable organization features.\n\n Use this method to:\n - Start\ \ domain ownership verification\n - Enable automatic team joining\n - Set up SSO restrictions\n - Configure email-based\ \ policies\n\n ### Examples\n\n - Verify primary domain:\n\n Starts verification for main company domain.\n\n \ \ ```yaml\n organizationId: \"b0e12f6c-4c67-429d-a4a6-d9838b5da047\"\n domain: \"acme-corp.com\"\n ```\n\n -\ \ Verify subsidiary domain:\n\n Adds verification for additional company domain.\n\n ```yaml\n organizationId:\ \ \"b0e12f6c-4c67-429d-a4a6-d9838b5da047\"\n domain: \"acme-subsidiary.com\"\n ```" operationId: gitpod.v1.OrganizationService.CreateDomainVerification parameters: [] requestBody: content: application/json: examples: verify_primary_domain: description: Starts verification for main company domain. value: domain: acme-corp.com organizationId: b0e12f6c-4c67-429d-a4a6-d9838b5da047 verify_subsidiary_domain: description: Adds verification for additional company domain. value: domain: acme-subsidiary.com organizationId: b0e12f6c-4c67-429d-a4a6-d9838b5da047 schema: $ref: '#/components/schemas/gitpod.v1.CreateDomainVerificationRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.CreateDomainVerificationResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: CreateDomainVerification tags: - gitpod.v1.OrganizationService servers: [] /gitpod.v1.OrganizationService/CreateOrganization: post: description: "Creates a new organization with the specified name and settings.\n\n Use this method to:\n - Create a\ \ new organization for team collaboration\n - Set up automatic domain-based invites for team members\n - Join the\ \ organization immediately upon creation\n\n ### Examples\n\n - Create a basic organization:\n\n Creates an organization\ \ with just a name.\n\n ```yaml\n name: \"Acme Corp Engineering\"\n joinOrganization: true\n ```\n\n - Create\ \ with domain-based invites:\n\n Creates an organization that automatically invites users with matching email domains.\n\ \n ```yaml\n name: \"Acme Corp\"\n joinOrganization: true\n inviteAccountsWithMatchingDomain: true\n ```" operationId: gitpod.v1.OrganizationService.CreateOrganization parameters: [] requestBody: content: application/json: examples: create_a_basic_organization: description: Creates an organization with just a name. value: joinOrganization: true name: Acme Corp Engineering create_with_domain_based_invites: description: Creates an organization that automatically invites users with matching email domains. value: inviteAccountsWithMatchingDomain: true joinOrganization: true name: Acme Corp schema: $ref: '#/components/schemas/gitpod.v1.CreateOrganizationRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.CreateOrganizationResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: CreateOrganization tags: - gitpod.v1.OrganizationService servers: [] /gitpod.v1.OrganizationService/CreateOrganizationInvite: post: description: "Creates an invite link for joining an organization.\n Any existing OrganizationInvites are invalidated\ \ and can no longer be used.\n\n Use this method to:\n - Generate shareable invite links\n - Manage team growth\n\ \ - Control organization access\n\n ### Examples\n\n - Create organization invite:\n\n Generates a new invite link\ \ for the organization.\n\n ```yaml\n organizationId: \"b0e12f6c-4c67-429d-a4a6-d9838b5da047\"\n ```" operationId: gitpod.v1.OrganizationService.CreateOrganizationInvite parameters: [] requestBody: content: application/json: examples: create_organization_invite: description: Generates a new invite link for the organization. value: organizationId: b0e12f6c-4c67-429d-a4a6-d9838b5da047 schema: $ref: '#/components/schemas/gitpod.v1.CreateOrganizationInviteRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.CreateOrganizationInviteResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: CreateOrganizationInvite tags: - gitpod.v1.OrganizationService servers: [] /gitpod.v1.OrganizationService/CreateSCIMConfiguration: post: description: "Creates a new SCIM configuration for automated user provisioning.\n\n Use this method to:\n - Set up SCIM\ \ 2.0 provisioning from an identity provider\n - Generate a bearer token for SCIM API authentication\n - Link SCIM\ \ provisioning to an existing SSO configuration\n\n ### Examples\n\n - Create basic SCIM configuration:\n\n Creates\ \ a SCIM configuration linked to an SSO provider with default 1 year token expiration.\n\n ```yaml\n organizationId:\ \ \"b0e12f6c-4c67-429d-a4a6-d9838b5da047\"\n ssoConfigurationId: \"d2c94c27-3b76-4a42-b88c-95a85e392c68\"\n ```\n\ \n - Create SCIM configuration with custom token expiration:\n\n Creates a SCIM configuration with a 90-day token\ \ expiration.\n\n ```yaml\n organizationId: \"b0e12f6c-4c67-429d-a4a6-d9838b5da047\"\n ssoConfigurationId: \"\ d2c94c27-3b76-4a42-b88c-95a85e392c68\"\n tokenExpiresIn: \"7776000s\"\n ```" operationId: gitpod.v1.OrganizationService.CreateSCIMConfiguration parameters: [] requestBody: content: application/json: examples: create_basic_scim_configuration: description: Creates a SCIM configuration linked to an SSO provider with default 1 year token expiration. value: organizationId: b0e12f6c-4c67-429d-a4a6-d9838b5da047 ssoConfigurationId: d2c94c27-3b76-4a42-b88c-95a85e392c68 create_scim_configuration_with_custom_token_expiration: description: Creates a SCIM configuration with a 90-day token expiration. value: organizationId: b0e12f6c-4c67-429d-a4a6-d9838b5da047 ssoConfigurationId: d2c94c27-3b76-4a42-b88c-95a85e392c68 tokenExpiresIn: 7776000s schema: $ref: '#/components/schemas/gitpod.v1.CreateSCIMConfigurationRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.CreateSCIMConfigurationResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: CreateSCIMConfiguration tags: - gitpod.v1.OrganizationService servers: [] /gitpod.v1.OrganizationService/CreateSSOConfiguration: post: description: "Creates or updates SSO configuration for organizational authentication.\n\n Use this method to:\n - Configure\ \ OIDC-based SSO providers\n - Set up built-in providers (Google, GitHub, etc.)\n - Define custom identity providers\n\ \ - Manage authentication policies\n\n ### Examples\n\n - Configure built-in Google SSO:\n\n Sets up SSO using Google\ \ Workspace.\n\n ```yaml\n organizationId: \"b0e12f6c-4c67-429d-a4a6-d9838b5da047\"\n clientId: \"012345678-abcdefghijklmnopqrstuvwxyz.apps.googleusercontent.com\"\ \n clientSecret: \"GOCSPX-abcdefghijklmnopqrstuvwxyz123456\"\n issuerUrl: \"https://accounts.google.com\"\n \ \ emailDomain: \"acme-corp.com\"\n ```\n\n - Configure custom OIDC provider:\n\n Sets up SSO with a custom identity\ \ provider.\n\n ```yaml\n organizationId: \"b0e12f6c-4c67-429d-a4a6-d9838b5da047\"\n clientId: \"acme-corp-gitpod\"\ \n clientSecret: \"secret-token-value\"\n issuerUrl: \"https://sso.acme-corp.com\"\n emailDomain: \"acme-corp.com\"\ \n ```" operationId: gitpod.v1.OrganizationService.CreateSSOConfiguration parameters: [] requestBody: content: application/json: examples: configure_built_in_google_sso: description: Sets up SSO using Google Workspace. value: clientId: 012345678-abcdefghijklmnopqrstuvwxyz.apps.googleusercontent.com clientSecret: GOCSPX-abcdefghijklmnopqrstuvwxyz123456 emailDomain: acme-corp.com issuerUrl: https://accounts.google.com organizationId: b0e12f6c-4c67-429d-a4a6-d9838b5da047 configure_custom_oidc_provider: description: Sets up SSO with a custom identity provider. value: clientId: acme-corp-gitpod clientSecret: secret-token-value emailDomain: acme-corp.com issuerUrl: https://sso.acme-corp.com organizationId: b0e12f6c-4c67-429d-a4a6-d9838b5da047 schema: $ref: '#/components/schemas/gitpod.v1.CreateSSOConfigurationRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.CreateSSOConfigurationResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: CreateSSOConfiguration tags: - gitpod.v1.OrganizationService servers: [] /gitpod.v1.OrganizationService/DeleteCustomDomain: post: description: "Removes a custom domain configuration from an organization.\n\n Use this method to:\n - Disable custom\ \ domain functionality\n - Remove outdated configurations\n - Clean up unused domains\n\n ### Examples\n\n - Delete\ \ custom domain configuration:\n\n Removes a specific custom domain configuration.\n\n ```yaml\n organizationId:\ \ \"b0e12f6c-4c67-429d-a4a6-d9838b5da047\"\n ```" operationId: gitpod.v1.OrganizationService.DeleteCustomDomain parameters: [] requestBody: content: application/json: examples: delete_custom_domain_configuration: description: Removes a specific custom domain configuration. value: organizationId: b0e12f6c-4c67-429d-a4a6-d9838b5da047 schema: $ref: '#/components/schemas/gitpod.v1.DeleteCustomDomainRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.DeleteCustomDomainResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: DeleteCustomDomain tags: - gitpod.v1.OrganizationService servers: [] /gitpod.v1.OrganizationService/DeleteDomainVerification: post: description: "Removes a domain verification request.\n\n Use this method to:\n - Cancel pending verifications\n - Remove\ \ verified domains\n - Clean up unused domain records\n\n ### Examples\n\n - Delete verification:\n\n Removes a\ \ domain verification request.\n\n ```yaml\n domainVerificationId: \"d2c94c27-3b76-4a42-b88c-95a85e392c68\"\n\ \ ```" operationId: gitpod.v1.OrganizationService.DeleteDomainVerification parameters: [] requestBody: content: application/json: examples: delete_verification: description: Removes a domain verification request. value: domainVerificationId: d2c94c27-3b76-4a42-b88c-95a85e392c68 schema: $ref: '#/components/schemas/gitpod.v1.DeleteDomainVerificationRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.DeleteDomainVerificationResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: DeleteDomainVerification tags: - gitpod.v1.OrganizationService servers: [] /gitpod.v1.OrganizationService/DeleteOrganization: post: description: "Permanently deletes an organization.\n\n Use this method to:\n - Remove unused organizations\n - Clean\ \ up test organizations\n - Complete organization migration\n\n ### Examples\n\n - Delete organization:\n\n Permanently\ \ removes an organization and all its data.\n\n ```yaml\n organizationId: \"b0e12f6c-4c67-429d-a4a6-d9838b5da047\"\ \n ```" operationId: gitpod.v1.OrganizationService.DeleteOrganization parameters: [] requestBody: content: application/json: examples: delete_organization: description: Permanently removes an organization and all its data. value: organizationId: b0e12f6c-4c67-429d-a4a6-d9838b5da047 schema: $ref: '#/components/schemas/gitpod.v1.DeleteOrganizationRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.DeleteOrganizationResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: DeleteOrganization tags: - gitpod.v1.OrganizationService servers: [] /gitpod.v1.OrganizationService/DeleteSCIMConfiguration: post: description: "Removes a SCIM configuration from an organization.\n\n Use this method to:\n - Disable SCIM provisioning\ \ completely\n - Remove unused configurations\n - Clean up after migration\n\n ### Examples\n\n - Delete SCIM configuration:\n\ \n Removes a specific SCIM configuration.\n\n ```yaml\n scimConfigurationId: \"d2c94c27-3b76-4a42-b88c-95a85e392c68\"\ \n ```" operationId: gitpod.v1.OrganizationService.DeleteSCIMConfiguration parameters: [] requestBody: content: application/json: examples: delete_scim_configuration: description: Removes a specific SCIM configuration. value: scimConfigurationId: d2c94c27-3b76-4a42-b88c-95a85e392c68 schema: $ref: '#/components/schemas/gitpod.v1.DeleteSCIMConfigurationRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.DeleteSCIMConfigurationResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: DeleteSCIMConfiguration tags: - gitpod.v1.OrganizationService servers: [] /gitpod.v1.OrganizationService/DeleteSSOConfiguration: post: description: "Removes an SSO configuration from an organization.\n\n Use this method to:\n - Disable SSO authentication\n\ \ - Remove outdated providers\n - Clean up unused configurations\n\n ### Examples\n\n - Delete SSO configuration:\n\ \n Removes a specific SSO configuration.\n\n ```yaml\n ssoConfigurationId: \"d2c94c27-3b76-4a42-b88c-95a85e392c68\"\ \n ```" operationId: gitpod.v1.OrganizationService.DeleteSSOConfiguration parameters: [] requestBody: content: application/json: examples: delete_sso_configuration: description: Removes a specific SSO configuration. value: ssoConfigurationId: d2c94c27-3b76-4a42-b88c-95a85e392c68 schema: $ref: '#/components/schemas/gitpod.v1.DeleteSSOConfigurationRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.DeleteSSOConfigurationResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: DeleteSSOConfiguration tags: - gitpod.v1.OrganizationService servers: [] /gitpod.v1.OrganizationService/GetAnnouncementBanner: post: description: "Retrieves the announcement banner configuration for an organization.\n\n Use this method to fetch the\ \ current announcement banner settings.\n All organization members can read the banner configuration.\n\n ### Examples\n\ \n - Get announcement banner:\n\n ```yaml\n organizationId: \"b0e12f6c-4c67-429d-a4a6-d9838b5da047\"\n ```" operationId: gitpod.v1.OrganizationService.GetAnnouncementBanner parameters: [] requestBody: content: application/json: examples: get_announcement_banner: description: 'organizationId: "b0e12f6c-4c67-429d-a4a6-d9838b5da047" ' value: organizationId: b0e12f6c-4c67-429d-a4a6-d9838b5da047 schema: $ref: '#/components/schemas/gitpod.v1.GetAnnouncementBannerRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.GetAnnouncementBannerResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: GetAnnouncementBanner tags: - gitpod.v1.OrganizationService servers: [] /gitpod.v1.OrganizationService/GetCustomDomain: post: description: "Retrieves a specific custom domain configuration.\n\n Use this method to view custom domain details\n\n\ \ ### Examples\n\n - Get custom domain configuration:\n\n Retrieves details of a specific custom domain.\n\n ```yaml\n\ \ organizationId: \"b0e12f6c-4c67-429d-a4a6-d9838b5da047\"\n ```" operationId: gitpod.v1.OrganizationService.GetCustomDomain parameters: [] requestBody: content: application/json: examples: get_custom_domain_configuration: description: Retrieves details of a specific custom domain. value: organizationId: b0e12f6c-4c67-429d-a4a6-d9838b5da047 schema: $ref: '#/components/schemas/gitpod.v1.GetCustomDomainRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.GetCustomDomainResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: GetCustomDomain tags: - gitpod.v1.OrganizationService servers: [] /gitpod.v1.OrganizationService/GetDomainVerification: post: description: "Retrieves the status of a domain verification request.\n\n Use this method to:\n - Check verification\ \ progress\n - View verification requirements\n - Monitor domain status\n\n ### Examples\n\n - Get verification status:\n\ \n Checks the current state of a domain verification.\n\n ```yaml\n domainVerificationId: \"d2c94c27-3b76-4a42-b88c-95a85e392c68\"\ \n ```" operationId: gitpod.v1.OrganizationService.GetDomainVerification parameters: [] requestBody: content: application/json: examples: get_verification_status: description: Checks the current state of a domain verification. value: domainVerificationId: d2c94c27-3b76-4a42-b88c-95a85e392c68 schema: $ref: '#/components/schemas/gitpod.v1.GetDomainVerificationRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.GetDomainVerificationResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: GetDomainVerification tags: - gitpod.v1.OrganizationService servers: [] /gitpod.v1.OrganizationService/GetOIDCConfig: post: description: "Retrieves the OIDC token configuration for an organization.\n\n Use this method to:\n - Check which OIDC\ \ token version is active (V2 or V3)\n - View extra sub claim fields (V3 only)\n\n ### Examples\n\n - Get OIDC config:\n\ \n ```yaml\n organizationId: \"b0e12f6c-4c67-429d-a4a6-d9838b5da047\"\n ```" operationId: gitpod.v1.OrganizationService.GetOIDCConfig parameters: [] requestBody: content: application/json: examples: get_oidc_config: description: 'organizationId: "b0e12f6c-4c67-429d-a4a6-d9838b5da047" ' value: organizationId: b0e12f6c-4c67-429d-a4a6-d9838b5da047 schema: $ref: '#/components/schemas/gitpod.v1.GetOIDCConfigRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.GetOIDCConfigResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: GetOIDCConfig tags: - gitpod.v1.OrganizationService servers: [] /gitpod.v1.OrganizationService/GetOrganization: post: description: "Gets details about a specific organization.\n\n Use this method to:\n - Retrieve organization settings\ \ and configuration\n - Check organization membership status\n - View domain verification settings\n\n ### Examples\n\ \n - Get organization details:\n\n Retrieves information about a specific organization.\n\n ```yaml\n organizationId:\ \ \"b0e12f6c-4c67-429d-a4a6-d9838b5da047\"\n ```" operationId: gitpod.v1.OrganizationService.GetOrganization parameters: [] requestBody: content: application/json: examples: get_organization_details: description: Retrieves information about a specific organization. value: organizationId: b0e12f6c-4c67-429d-a4a6-d9838b5da047 schema: $ref: '#/components/schemas/gitpod.v1.GetOrganizationRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.GetOrganizationResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: GetOrganization tags: - gitpod.v1.OrganizationService servers: [] /gitpod.v1.OrganizationService/GetOrganizationInvite: post: operationId: gitpod.v1.OrganizationService.GetOrganizationInvite parameters: [] requestBody: content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.GetOrganizationInviteRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.GetOrganizationInviteResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: GetOrganizationInvite tags: - gitpod.v1.OrganizationService servers: [] /gitpod.v1.OrganizationService/GetOrganizationInviteSummary: post: description: "Retrieves organization details and membership info based on an invite link.\n\n Use this method to:\n\ \ - Preview organization details before joining\n - Validate invite link authenticity\n - Check organization size\ \ and activity\n - View team information before accepting\n\n ### Examples\n\n - Get invite summary:\n\n Retrieves\ \ organization information from an invite.\n\n ```yaml\n inviteId: \"d2c94c27-3b76-4a42-b88c-95a85e392c68\"\n\ \ ```" operationId: gitpod.v1.OrganizationService.GetOrganizationInviteSummary parameters: [] requestBody: content: application/json: examples: get_invite_summary: description: Retrieves organization information from an invite. value: inviteId: d2c94c27-3b76-4a42-b88c-95a85e392c68 schema: $ref: '#/components/schemas/gitpod.v1.GetOrganizationInviteSummaryRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.GetOrganizationInviteSummaryResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: GetOrganizationInviteSummary tags: - gitpod.v1.OrganizationService servers: [] /gitpod.v1.OrganizationService/GetOrganizationPolicies: post: description: "Gets organization policy settings by organization ID.\n\n Use this method to:\n - Retrieve current policy\ \ settings for an organization\n - View resource limits and restrictions\n - Check allowed editors and other configurations\n\ \n ### Examples\n\n - Get organization policies:\n\n Retrieves policy settings for a specific organization.\n\n\ \ ```yaml\n organizationId: \"b0e12f6c-4c67-429d-a4a6-d9838b5da047\"\n ```" operationId: gitpod.v1.OrganizationService.GetOrganizationPolicies parameters: [] requestBody: content: application/json: examples: get_organization_policies: description: Retrieves policy settings for a specific organization. value: organizationId: b0e12f6c-4c67-429d-a4a6-d9838b5da047 schema: $ref: '#/components/schemas/gitpod.v1.GetOrganizationPoliciesRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.GetOrganizationPoliciesResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: GetOrganizationPolicies tags: - gitpod.v1.OrganizationService servers: [] /gitpod.v1.OrganizationService/GetSCIMConfiguration: post: description: "Retrieves a specific SCIM configuration.\n\n Use this method to:\n - View SCIM configuration details\n\ \ - Check if SCIM is enabled\n - Verify SSO linkage\n\n ### Examples\n\n - Get SCIM configuration:\n\n Retrieves\ \ details of a specific SCIM configuration.\n\n ```yaml\n scimConfigurationId: \"d2c94c27-3b76-4a42-b88c-95a85e392c68\"\ \n ```" operationId: gitpod.v1.OrganizationService.GetSCIMConfiguration parameters: [] requestBody: content: application/json: examples: get_scim_configuration: description: Retrieves details of a specific SCIM configuration. value: scimConfigurationId: d2c94c27-3b76-4a42-b88c-95a85e392c68 schema: $ref: '#/components/schemas/gitpod.v1.GetSCIMConfigurationRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.GetSCIMConfigurationResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: GetSCIMConfiguration tags: - gitpod.v1.OrganizationService servers: [] /gitpod.v1.OrganizationService/GetSSOConfiguration: post: description: "Retrieves a specific SSO configuration.\n\n Use this method to:\n - View SSO provider details\n - Check\ \ configuration status\n - Verify SSO settings\n\n ### Examples\n\n - Get SSO configuration:\n\n Retrieves details\ \ of a specific SSO configuration.\n\n ```yaml\n ssoConfigurationId: \"d2c94c27-3b76-4a42-b88c-95a85e392c68\"\n\ \ ```" operationId: gitpod.v1.OrganizationService.GetSSOConfiguration parameters: [] requestBody: content: application/json: examples: get_sso_configuration: description: Retrieves details of a specific SSO configuration. value: ssoConfigurationId: d2c94c27-3b76-4a42-b88c-95a85e392c68 schema: $ref: '#/components/schemas/gitpod.v1.GetSSOConfigurationRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.GetSSOConfigurationResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: GetSSOConfiguration tags: - gitpod.v1.OrganizationService servers: [] /gitpod.v1.OrganizationService/JoinOrganization: post: description: "Allows users to join an organization through direct ID, invite link, or domain-based auto-join.\n\n Use\ \ this method to:\n - Join an organization via direct ID or invite\n - Join automatically based on email domain\n\ \ - Accept organization invitations\n\n ### Examples\n\n - Join via organization ID:\n\n Joins an organization directly\ \ when you have the ID.\n\n ```yaml\n organizationId: \"b0e12f6c-4c67-429d-a4a6-d9838b5da047\"\n ```\n\n - Join\ \ via invite:\n\n Accepts an organization invitation link.\n\n ```yaml\n inviteId: \"d2c94c27-3b76-4a42-b88c-95a85e392c68\"\ \n ```" operationId: gitpod.v1.OrganizationService.JoinOrganization parameters: [] requestBody: content: application/json: examples: join_via_invite: description: Accepts an organization invitation link. value: inviteId: d2c94c27-3b76-4a42-b88c-95a85e392c68 join_via_organization_id: description: Joins an organization directly when you have the ID. value: organizationId: b0e12f6c-4c67-429d-a4a6-d9838b5da047 schema: $ref: '#/components/schemas/gitpod.v1.JoinOrganizationRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.JoinOrganizationResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: JoinOrganization tags: - gitpod.v1.OrganizationService servers: [] /gitpod.v1.OrganizationService/LeaveOrganization: post: description: "Removes a user from an organization while preserving organization data.\n\n Use this method to:\n - Remove\ \ yourself from an organization\n - Clean up inactive memberships\n - Transfer project ownership before leaving\n\ \ - Manage team transitions\n\n ### Examples\n\n - Leave organization:\n\n Removes user from organization membership.\n\ \n ```yaml\n userId: \"f53d2330-3795-4c5d-a1f3-453121af9c60\"\n ```\n\n Note: Ensure all projects and resources\ \ are transferred before leaving." operationId: gitpod.v1.OrganizationService.LeaveOrganization parameters: [] requestBody: content: application/json: examples: leave_organization: description: Removes user from organization membership. value: userId: f53d2330-3795-4c5d-a1f3-453121af9c60 schema: $ref: '#/components/schemas/gitpod.v1.LeaveOrganizationRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.LeaveOrganizationResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: LeaveOrganization tags: - gitpod.v1.OrganizationService servers: [] /gitpod.v1.OrganizationService/ListDomainVerifications: post: description: "Lists and monitors domain verification status across an organization.\n\n Use this method to:\n - Track\ \ verification progress\n - View all verified domains\n - Monitor pending verifications\n - Audit domain settings\n\ \n ### Examples\n\n - List all verifications:\n\n Shows all domain verifications regardless of status.\n\n ```yaml\n\ \ organizationId: \"b0e12f6c-4c67-429d-a4a6-d9838b5da047\"\n pagination:\n pageSize: 20\n ```\n\n - List\ \ with pagination:\n\n Retrieves next page of verifications.\n\n ```yaml\n organizationId: \"b0e12f6c-4c67-429d-a4a6-d9838b5da047\"\ \n pagination:\n pageSize: 20\n token: \"next-page-token-from-previous-response\"\n ```" operationId: gitpod.v1.OrganizationService.ListDomainVerifications 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_all_verifications: description: Shows all domain verifications regardless of status. value: organizationId: b0e12f6c-4c67-429d-a4a6-d9838b5da047 pagination: pageSize: 20 list_with_pagination: description: Retrieves next page of verifications. value: organizationId: b0e12f6c-4c67-429d-a4a6-d9838b5da047 pagination: pageSize: 20 token: next-page-token-from-previous-response schema: $ref: '#/components/schemas/gitpod.v1.ListDomainVerificationsRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.ListDomainVerificationsResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: ListDomainVerifications tags: - gitpod.v1.OrganizationService servers: [] /gitpod.v1.OrganizationService/ListMembers: post: description: "Lists and filters organization members with optional pagination.\n\n Use this method to:\n - View all\ \ organization members\n - Monitor member activity\n - Manage team membership\n\n ### Examples\n\n - List active members:\n\ \n Retrieves active members with pagination.\n\n ```yaml\n organizationId: \"b0e12f6c-4c67-429d-a4a6-d9838b5da047\"\ \n pagination:\n pageSize: 20\n ```\n\n - List with pagination:\n\n Retrieves next page of members.\n\n\ \ ```yaml\n organizationId: \"b0e12f6c-4c67-429d-a4a6-d9838b5da047\"\n pagination:\n pageSize: 50\n \ \ token: \"next-page-token-from-previous-response\"\n ```" operationId: gitpod.v1.OrganizationService.ListMembers 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_active_members: description: Retrieves active members with pagination. value: organizationId: b0e12f6c-4c67-429d-a4a6-d9838b5da047 pagination: pageSize: 20 list_with_pagination: description: Retrieves next page of members. value: organizationId: b0e12f6c-4c67-429d-a4a6-d9838b5da047 pagination: pageSize: 50 token: next-page-token-from-previous-response schema: $ref: '#/components/schemas/gitpod.v1.ListMembersRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.ListMembersResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: ListMembers tags: - gitpod.v1.OrganizationService servers: [] /gitpod.v1.OrganizationService/ListSCIMConfigurations: post: description: "Lists SCIM configurations for an organization.\n\n Use this method to:\n - View all SCIM configurations\n\ \ - Monitor provisioning status\n - Audit SCIM settings\n\n ### Examples\n\n - List SCIM configurations:\n\n Shows\ \ all SCIM configurations for an organization.\n\n ```yaml\n pagination:\n pageSize: 20\n ```" operationId: gitpod.v1.OrganizationService.ListSCIMConfigurations 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_scim_configurations: description: Shows all SCIM configurations for an organization. value: pagination: pageSize: 20 schema: $ref: '#/components/schemas/gitpod.v1.ListSCIMConfigurationsRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.ListSCIMConfigurationsResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: ListSCIMConfigurations tags: - gitpod.v1.OrganizationService servers: [] /gitpod.v1.OrganizationService/ListSSOConfigurations: post: description: "Lists and filters SSO configurations for an organization.\n\n Use this method to:\n - View all SSO providers\n\ \ - Monitor authentication status\n - Audit security settings\n - Manage provider configurations\n\n ### Examples\n\ \n - List active configurations:\n\n Shows all active SSO providers.\n\n ```yaml\n organizationId: \"b0e12f6c-4c67-429d-a4a6-d9838b5da047\"\ \n pagination:\n pageSize: 20\n ```\n\n - List by provider type:\n\n Shows custom SSO configurations.\n\n\ \ ```yaml\n organizationId: \"b0e12f6c-4c67-429d-a4a6-d9838b5da047\"\n pagination:\n pageSize: 20\n \ \ token: \"next-page-token-from-previous-response\"\n ```" operationId: gitpod.v1.OrganizationService.ListSSOConfigurations 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_active_configurations: description: Shows all active SSO providers. value: organizationId: b0e12f6c-4c67-429d-a4a6-d9838b5da047 pagination: pageSize: 20 list_by_provider_type: description: Shows custom SSO configurations. value: organizationId: b0e12f6c-4c67-429d-a4a6-d9838b5da047 pagination: pageSize: 20 token: next-page-token-from-previous-response schema: $ref: '#/components/schemas/gitpod.v1.ListSSOConfigurationsRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.ListSSOConfigurationsResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: ListSSOConfigurations tags: - gitpod.v1.OrganizationService servers: [] /gitpod.v1.OrganizationService/RegenerateSCIMToken: post: description: "Regenerates the bearer token for a SCIM configuration.\n\n Use this method to:\n - Rotate SCIM credentials\n\ \ - Recover from token compromise\n - Update IdP configuration\n\n ### Examples\n\n - Regenerate token:\n\n Creates\ \ a new bearer token with the same expiration duration as the previous token.\n\n ```yaml\n scimConfigurationId:\ \ \"d2c94c27-3b76-4a42-b88c-95a85e392c68\"\n ```\n\n - Regenerate token with new expiration:\n\n Creates a new\ \ bearer token with a custom 180-day expiration.\n\n ```yaml\n scimConfigurationId: \"d2c94c27-3b76-4a42-b88c-95a85e392c68\"\ \n tokenExpiresIn: \"15552000s\"\n ```" operationId: gitpod.v1.OrganizationService.RegenerateSCIMToken parameters: [] requestBody: content: application/json: examples: regenerate_token: description: Creates a new bearer token with the same expiration duration as the previous token. value: scimConfigurationId: d2c94c27-3b76-4a42-b88c-95a85e392c68 regenerate_token_with_new_expiration: description: Creates a new bearer token with a custom 180-day expiration. value: scimConfigurationId: d2c94c27-3b76-4a42-b88c-95a85e392c68 tokenExpiresIn: 15552000s schema: $ref: '#/components/schemas/gitpod.v1.RegenerateSCIMTokenRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.RegenerateSCIMTokenResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: RegenerateSCIMToken tags: - gitpod.v1.OrganizationService servers: [] /gitpod.v1.OrganizationService/SetRole: post: description: "Manages organization membership and roles by setting a user's role within the organization.\n\n Use this\ \ method to:\n - Promote members to admin role\n - Change member permissions\n - Demote admins to regular members\n\ \n ### Examples\n\n - Promote to admin:\n\n Makes a user an organization administrator.\n\n ```yaml\n organizationId:\ \ \"b0e12f6c-4c67-429d-a4a6-d9838b5da047\"\n userId: \"f53d2330-3795-4c5d-a1f3-453121af9c60\"\n role: ORGANIZATION_ROLE_ADMIN\n\ \ ```\n\n - Change to member:\n\n Changes a user's role to regular member.\n\n ```yaml\n organizationId: \"\ b0e12f6c-4c67-429d-a4a6-d9838b5da047\"\n userId: \"f53d2330-3795-4c5d-a1f3-453121af9c60\"\n role: ORGANIZATION_ROLE_MEMBER\n\ \ ```" operationId: gitpod.v1.OrganizationService.SetRole parameters: [] requestBody: content: application/json: examples: change_to_member: description: Changes a user's role to regular member. value: organizationId: b0e12f6c-4c67-429d-a4a6-d9838b5da047 role: ORGANIZATION_ROLE_MEMBER userId: f53d2330-3795-4c5d-a1f3-453121af9c60 promote_to_admin: description: Makes a user an organization administrator. value: organizationId: b0e12f6c-4c67-429d-a4a6-d9838b5da047 role: ORGANIZATION_ROLE_ADMIN userId: f53d2330-3795-4c5d-a1f3-453121af9c60 schema: $ref: '#/components/schemas/gitpod.v1.SetRoleRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.SetRoleResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: SetRole tags: - gitpod.v1.OrganizationService servers: [] /gitpod.v1.OrganizationService/SetStripeCustomerID: post: deprecated: true description: "Sets the Stripe customer ID for an organization's billing configuration.\n\n Use this method to associate\ \ an existing Stripe customer with an organization\n during enterprise customer onboarding.\n\n ### Examples\n\n Deprecated:\ \ Use BillingService.SetupEnterpriseBilling instead.\n This method is no longer functional and will return an Unimplemented\ \ error.\n\n - Set Stripe customer ID:\n\n Associates a Stripe customer with an organization.\n\n ```yaml\n \ \ organizationId: \"b0e12f6c-4c67-429d-a4a6-d9838b5da047\"\n stripeCustomerId: \"cus_ABC123\"\n ```" operationId: gitpod.v1.OrganizationService.SetStripeCustomerID parameters: [] requestBody: content: application/json: examples: set_stripe_customer_id: description: Associates a Stripe customer with an organization. value: organizationId: b0e12f6c-4c67-429d-a4a6-d9838b5da047 stripeCustomerId: cus_ABC123 schema: $ref: '#/components/schemas/gitpod.v1.SetStripeCustomerIDRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.SetStripeCustomerIDResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: SetStripeCustomerID tags: - gitpod.v1.OrganizationService servers: [] /gitpod.v1.OrganizationService/SetTier: post: description: "Sets the tier of an organization.\n\n Use this method to:\n - Change an organization's tier between free,\ \ core, and enterprise\n\n ### Examples\n\n - Set organization tier:\n\n Changes organization tier to enterprise.\n\ \n ```yaml\n organizationId: \"b0e12f6c-4c67-429d-a4a6-d9838b5da047\"\n tier: ORGANIZATION_TIER_ENTERPRISE\n\ \ ```" operationId: gitpod.v1.OrganizationService.SetTier parameters: [] requestBody: content: application/json: examples: set_organization_tier: description: Changes organization tier to enterprise. value: organizationId: b0e12f6c-4c67-429d-a4a6-d9838b5da047 tier: ORGANIZATION_TIER_ENTERPRISE schema: $ref: '#/components/schemas/gitpod.v1.SetTierRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.SetTierResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: SetTier tags: - gitpod.v1.OrganizationService servers: [] /gitpod.v1.OrganizationService/UpdateAnnouncementBanner: post: description: "Updates the announcement banner configuration for an organization.\n\n Use this method to configure the\ \ announcement banner displayed to all users.\n Only organization admins can update the banner. Requires Enterprise\ \ tier.\n\n ### Examples\n\n - Enable announcement banner:\n\n ```yaml\n organizationId: \"b0e12f6c-4c67-429d-a4a6-d9838b5da047\"\ \n message: \"Scheduled maintenance on Saturday 10pm-2am UTC\"\n enabled: true\n ```\n\n - Disable announcement\ \ banner:\n\n ```yaml\n organizationId: \"b0e12f6c-4c67-429d-a4a6-d9838b5da047\"\n enabled: false\n ```" operationId: gitpod.v1.OrganizationService.UpdateAnnouncementBanner parameters: [] requestBody: content: application/json: examples: disable_announcement_banner: description: 'organizationId: "b0e12f6c-4c67-429d-a4a6-d9838b5da047" enabled: false ' value: enabled: false organizationId: b0e12f6c-4c67-429d-a4a6-d9838b5da047 enable_announcement_banner: description: 'organizationId: "b0e12f6c-4c67-429d-a4a6-d9838b5da047" message: "Scheduled maintenance on Saturday 10pm-2am UTC" enabled: true ' value: enabled: true message: Scheduled maintenance on Saturday 10pm-2am UTC organizationId: b0e12f6c-4c67-429d-a4a6-d9838b5da047 schema: $ref: '#/components/schemas/gitpod.v1.UpdateAnnouncementBannerRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.UpdateAnnouncementBannerResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: UpdateAnnouncementBanner tags: - gitpod.v1.OrganizationService servers: [] /gitpod.v1.OrganizationService/UpdateCustomDomain: post: description: "Updates custom domain configuration settings.\n\n Use this method to:\n - Update cloud provider settings\n\ \ - Change AWS account ID\n - Modify domain configuration\n\n ### Examples\n\n - Update AWS account ID:\n\n Changes\ \ the AWS account ID for the custom domain.\n\n ```yaml\n organizationId: \"b0e12f6c-4c67-429d-a4a6-d9838b5da047\"\ \n domainName: \"workspaces.acme-corp.com\"\n awsAccountId: \"987654321098\"\n ```" operationId: gitpod.v1.OrganizationService.UpdateCustomDomain parameters: [] requestBody: content: application/json: examples: update_aws_account_id: description: Changes the AWS account ID for the custom domain. value: awsAccountId: '987654321098' domainName: workspaces.acme-corp.com organizationId: b0e12f6c-4c67-429d-a4a6-d9838b5da047 schema: $ref: '#/components/schemas/gitpod.v1.UpdateCustomDomainRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.UpdateCustomDomainResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: UpdateCustomDomain tags: - gitpod.v1.OrganizationService servers: [] /gitpod.v1.OrganizationService/UpdateOIDCConfig: post: description: "Updates the OIDC token configuration for an organization.\n\n Use this method to:\n - Switch between OIDC\ \ token versions (V2 or V3)\n - Configure extra sub claim fields (V3 only)\n\n ### Examples\n\n - Enable V3 tokens\ \ with extra sub fields:\n\n ```yaml\n organizationId: \"b0e12f6c-4c67-429d-a4a6-d9838b5da047\"\n oidcConfig:\n\ \ v3:\n extraSubFields:\n - \"environment_id\"\n - \"creator_email\"\n ```\n\n - Switch\ \ back to V2 tokens:\n\n ```yaml\n organizationId: \"b0e12f6c-4c67-429d-a4a6-d9838b5da047\"\n oidcConfig:\n\ \ v2: {}\n ```" operationId: gitpod.v1.OrganizationService.UpdateOIDCConfig parameters: [] requestBody: content: application/json: examples: enable_v3_tokens_with_extra_sub_fields: description: "organizationId: \"b0e12f6c-4c67-429d-a4a6-d9838b5da047\"\noidcConfig:\n v3:\n extraSubFields:\n\ \ - \"environment_id\"\n - \"creator_email\"\n" value: oidcConfig: v3: extraSubFields: - environment_id - creator_email organizationId: b0e12f6c-4c67-429d-a4a6-d9838b5da047 switch_back_to_v2_tokens: description: "organizationId: \"b0e12f6c-4c67-429d-a4a6-d9838b5da047\"\noidcConfig:\n v2: {}\n" value: oidcConfig: v2: {} organizationId: b0e12f6c-4c67-429d-a4a6-d9838b5da047 schema: $ref: '#/components/schemas/gitpod.v1.UpdateOIDCConfigRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.UpdateOIDCConfigResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: UpdateOIDCConfig tags: - gitpod.v1.OrganizationService servers: [] /gitpod.v1.OrganizationService/UpdateOrganization: post: description: "Updates an organization's settings including name, invite domains, and member policies.\n\n Use this method\ \ to:\n - Modify organization display name\n - Configure email domain restrictions\n - Update organization-wide settings\n\ \ - Manage member access policies\n\n ### Examples\n\n - Update basic settings:\n\n Changes organization name and\ \ invite domains.\n\n ```yaml\n organizationId: \"b0e12f6c-4c67-429d-a4a6-d9838b5da047\"\n name: \"New Company\ \ Name\"\n inviteDomains:\n domains:\n - \"company.com\"\n - \"subsidiary.com\"\n ```\n\n - Remove\ \ domain restrictions:\n\n Clears all domain-based invite restrictions.\n\n ```yaml\n organizationId: \"b0e12f6c-4c67-429d-a4a6-d9838b5da047\"\ \n inviteDomains:\n domains: []\n ```" operationId: gitpod.v1.OrganizationService.UpdateOrganization parameters: [] requestBody: content: application/json: examples: remove_domain_restrictions: description: Clears all domain-based invite restrictions. value: inviteDomains: domains: [] organizationId: b0e12f6c-4c67-429d-a4a6-d9838b5da047 update_basic_settings: description: Changes organization name and invite domains. value: inviteDomains: domains: - company.com - subsidiary.com name: New Company Name organizationId: b0e12f6c-4c67-429d-a4a6-d9838b5da047 schema: $ref: '#/components/schemas/gitpod.v1.UpdateOrganizationRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.UpdateOrganizationResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: UpdateOrganization tags: - gitpod.v1.OrganizationService servers: [] /gitpod.v1.OrganizationService/UpdateOrganizationPolicies: post: description: "Updates organization policy settings.\n\n Use this method to:\n - Configure editor restrictions\n - Set\ \ environment resource limits\n - Define project creation permissions\n - Customize default configurations\n\n ###\ \ Examples\n\n - Update editor policies:\n\n Restricts available editors and sets a default.\n\n ```yaml\n organizationId:\ \ \"b0e12f6c-4c67-429d-a4a6-d9838b5da047\"\n allowedEditorIds:\n - \"vscode\"\n - \"jetbrains\"\n defaultEditorId:\ \ \"vscode\"\n ```\n\n - Set environment limits:\n\n Configures limits for environment usage.\n\n ```yaml\n\ \ organizationId: \"b0e12f6c-4c67-429d-a4a6-d9838b5da047\"\n maximumEnvironmentTimeout: \"3600s\"\n maximumRunningEnvironmentsPerUser:\ \ \"5\"\n maximumEnvironmentsPerUser: \"20\"\n ```" operationId: gitpod.v1.OrganizationService.UpdateOrganizationPolicies parameters: [] requestBody: content: application/json: examples: set_environment_limits: description: Configures limits for environment usage. value: maximumEnvironmentTimeout: 3600s maximumEnvironmentsPerUser: '20' maximumRunningEnvironmentsPerUser: '5' organizationId: b0e12f6c-4c67-429d-a4a6-d9838b5da047 update_editor_policies: description: Restricts available editors and sets a default. value: allowedEditorIds: - vscode - jetbrains defaultEditorId: vscode organizationId: b0e12f6c-4c67-429d-a4a6-d9838b5da047 schema: $ref: '#/components/schemas/gitpod.v1.UpdateOrganizationPoliciesRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.UpdateOrganizationPoliciesResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: UpdateOrganizationPolicies tags: - gitpod.v1.OrganizationService servers: [] /gitpod.v1.OrganizationService/UpdateSCIMConfiguration: post: description: "Updates a SCIM configuration.\n\n Use this method to:\n - Enable or disable SCIM provisioning\n - Link\ \ or unlink SSO configuration\n - Update configuration name\n\n ### Examples\n\n - Disable SCIM:\n\n Disables SCIM\ \ provisioning.\n\n ```yaml\n scimConfigurationId: \"d2c94c27-3b76-4a42-b88c-95a85e392c68\"\n enabled: false\n\ \ ```\n\n - Link to SSO:\n\n Links SCIM configuration to an SSO provider.\n\n ```yaml\n scimConfigurationId:\ \ \"d2c94c27-3b76-4a42-b88c-95a85e392c68\"\n ssoConfigurationId: \"f53d2330-3795-4c5d-a1f3-453121af9c60\"\n ```" operationId: gitpod.v1.OrganizationService.UpdateSCIMConfiguration parameters: [] requestBody: content: application/json: examples: disable_scim: description: Disables SCIM provisioning. value: enabled: false scimConfigurationId: d2c94c27-3b76-4a42-b88c-95a85e392c68 link_to_sso: description: Links SCIM configuration to an SSO provider. value: scimConfigurationId: d2c94c27-3b76-4a42-b88c-95a85e392c68 ssoConfigurationId: f53d2330-3795-4c5d-a1f3-453121af9c60 schema: $ref: '#/components/schemas/gitpod.v1.UpdateSCIMConfigurationRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.UpdateSCIMConfigurationResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: UpdateSCIMConfiguration tags: - gitpod.v1.OrganizationService servers: [] /gitpod.v1.OrganizationService/UpdateSSOConfiguration: post: description: "Updates SSO provider settings and authentication rules.\n\n Use this method to:\n - Rotate client credentials\n\ \ - Update provider endpoints\n - Modify claim mappings\n - Change authentication policies\n - Toggle SSO enforcement\n\ \n ### Examples\n\n - Update credentials:\n\n Rotates client ID and secret.\n\n ```yaml\n ssoConfigurationId:\ \ \"d2c94c27-3b76-4a42-b88c-95a85e392c68\"\n clientId: \"new-client-id\"\n clientSecret: \"new-client-secret\"\ \n ```\n\n - Update provider status:\n\n Activates or deactivates SSO provider.\n\n ```yaml\n ssoConfigurationId:\ \ \"d2c94c27-3b76-4a42-b88c-95a85e392c68\"\n state: SSO_CONFIGURATION_STATE_ACTIVE\n ```" operationId: gitpod.v1.OrganizationService.UpdateSSOConfiguration parameters: [] requestBody: content: application/json: examples: update_credentials: description: Rotates client ID and secret. value: clientId: new-client-id clientSecret: new-client-secret ssoConfigurationId: d2c94c27-3b76-4a42-b88c-95a85e392c68 update_provider_status: description: Activates or deactivates SSO provider. value: ssoConfigurationId: d2c94c27-3b76-4a42-b88c-95a85e392c68 state: SSO_CONFIGURATION_STATE_ACTIVE schema: $ref: '#/components/schemas/gitpod.v1.UpdateSSOConfigurationRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.UpdateSSOConfigurationResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: UpdateSSOConfiguration tags: - gitpod.v1.OrganizationService servers: [] /gitpod.v1.OrganizationService/VerifyDomain: post: description: "Verifies domain ownership for an organization.\n\n Use this method to:\n - Complete domain verification\ \ process\n - Enable domain-based features\n - Validate DNS configuration\n\n ### Examples\n\n - Verify domain ownership:\n\ \n Verifies ownership after DNS records are configured.\n\n ```yaml\n domainVerificationId: \"d2c94c27-3b76-4a42-b88c-95a85e392c68\"\ \n ```" operationId: gitpod.v1.OrganizationService.VerifyDomain parameters: [] requestBody: content: application/json: examples: verify_domain_ownership: description: Verifies ownership after DNS records are configured. value: domainVerificationId: d2c94c27-3b76-4a42-b88c-95a85e392c68 schema: $ref: '#/components/schemas/gitpod.v1.VerifyDomainRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.VerifyDomainResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: VerifyDomain tags: - gitpod.v1.OrganizationService servers: [] /gitpod.v1.PrebuildService/CancelPrebuild: post: description: "Cancels a running prebuild.\n\n Use this method to:\n - Stop prebuilds that are no longer needed\n - Free\ \ up resources for other operations\n\n ### Examples\n\n - Cancel prebuild:\n\n Stops a running prebuild and cleans\ \ up resources.\n\n ```yaml\n prebuildId: \"07e03a28-65a5-4d98-b532-8ea67b188048\"\n ```" operationId: gitpod.v1.PrebuildService.CancelPrebuild parameters: [] requestBody: content: application/json: examples: cancel_prebuild: description: Stops a running prebuild and cleans up resources. value: prebuildId: 07e03a28-65a5-4d98-b532-8ea67b188048 schema: $ref: '#/components/schemas/gitpod.v1.CancelPrebuildRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.CancelPrebuildResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: CancelPrebuild tags: - gitpod.v1.PrebuildService servers: [] /gitpod.v1.PrebuildService/CreatePrebuild: post: description: "Creates a prebuild for a project.\n\n Use this method to:\n - Create on-demand prebuilds for faster environment\ \ startup\n - Trigger prebuilds after repository changes\n - Generate prebuilds for specific environment classes\n\ \n The prebuild process creates an environment, runs the devcontainer prebuild lifecycle,\n and creates a snapshot\ \ for future environment provisioning.\n\n ### Examples\n\n - Create basic prebuild:\n\n Creates a prebuild for\ \ a project using default settings.\n\n ```yaml\n projectId: \"b0e12f6c-4c67-429d-a4a6-d9838b5da047\"\n spec:\n\ \ timeout: \"3600s\" # 60 minutes default\n ```\n\n - Create prebuild with custom environment class:\n\n \ \ Creates a prebuild with a specific environment class and timeout.\n\n ```yaml\n projectId: \"b0e12f6c-4c67-429d-a4a6-d9838b5da047\"\ \n environmentClassId: \"d2c94c27-3b76-4a42-b88c-95a85e392c68\"\n spec:\n timeout: \"3600s\" # 1 hour\n \ \ ```" operationId: gitpod.v1.PrebuildService.CreatePrebuild parameters: [] requestBody: content: application/json: examples: create_basic_prebuild: description: Creates a prebuild for a project using default settings. value: projectId: b0e12f6c-4c67-429d-a4a6-d9838b5da047 spec: timeout: 3600s create_prebuild_with_custom_environment_class: description: Creates a prebuild with a specific environment class and timeout. value: environmentClassId: d2c94c27-3b76-4a42-b88c-95a85e392c68 projectId: b0e12f6c-4c67-429d-a4a6-d9838b5da047 spec: timeout: 3600s schema: $ref: '#/components/schemas/gitpod.v1.CreatePrebuildRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.CreatePrebuildResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: CreatePrebuild tags: - gitpod.v1.PrebuildService servers: [] /gitpod.v1.PrebuildService/CreatePrebuildLogsToken: post: description: "Creates a logs access token for a prebuild.\n\n Use this method to:\n - Stream logs from a running prebuild\n\ \ - Access archived logs from completed prebuilds\n\n Generated tokens are valid for one hour.\n\n ### Examples\n\n\ \ - Create prebuild logs token:\n\n Generates a token for accessing prebuild logs.\n\n ```yaml\n prebuildId:\ \ \"07e03a28-65a5-4d98-b532-8ea67b188048\"\n ```" operationId: gitpod.v1.PrebuildService.CreatePrebuildLogsToken parameters: [] requestBody: content: application/json: examples: create_prebuild_logs_token: description: Generates a token for accessing prebuild logs. value: prebuildId: 07e03a28-65a5-4d98-b532-8ea67b188048 schema: $ref: '#/components/schemas/gitpod.v1.CreatePrebuildLogsTokenRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.CreatePrebuildLogsTokenResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: CreatePrebuildLogsToken tags: - gitpod.v1.PrebuildService servers: [] /gitpod.v1.PrebuildService/CreateWarmPool: post: description: "Creates a warm pool for a project and environment class.\n\n A warm pool maintains pre-created environment\ \ instances from a prebuild snapshot\n so that new environments can start near-instantly.\n\n Only one warm pool is\ \ allowed per pair.\n The environment class must have prebuilds enabled on the project.\n\ \n The pool's snapshot is managed automatically: when a new prebuild completes\n for the same project and environment\ \ class, the pool's snapshot is updated\n and the runner rotates instances.\n\n ### Examples\n\n - Create warm pool:\n\ \n Creates a warm pool with 2 instances for a project and environment class.\n\n ```yaml\n projectId: \"b0e12f6c-4c67-429d-a4a6-d9838b5da047\"\ \n environmentClassId: \"d2c94c27-3b76-4a42-b88c-95a85e392c68\"\n desiredSize: 2\n ```" operationId: gitpod.v1.PrebuildService.CreateWarmPool parameters: [] requestBody: content: application/json: examples: create_warm_pool: description: Creates a warm pool with 2 instances for a project and environment class. value: desiredSize: 2 environmentClassId: d2c94c27-3b76-4a42-b88c-95a85e392c68 projectId: b0e12f6c-4c67-429d-a4a6-d9838b5da047 schema: $ref: '#/components/schemas/gitpod.v1.CreateWarmPoolRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.CreateWarmPoolResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: CreateWarmPool tags: - gitpod.v1.PrebuildService servers: [] /gitpod.v1.PrebuildService/DeletePrebuild: post: description: "Deletes a prebuild.\n\n Prebuilds are automatically deleted after some time. Use this method to\n manually\ \ delete a prebuild before automatic cleanup, for example to remove\n a prebuild that should no longer be used.\n\n\ \ Deletion is processed asynchronously. The prebuild will be marked for deletion\n and removed from the system in\ \ the background.\n\n ### Examples\n\n - Delete prebuild:\n\n Marks a prebuild for deletion and removes it from\ \ the system.\n\n ```yaml\n prebuildId: \"07e03a28-65a5-4d98-b532-8ea67b188048\"\n ```" operationId: gitpod.v1.PrebuildService.DeletePrebuild parameters: [] requestBody: content: application/json: examples: delete_prebuild: description: Marks a prebuild for deletion and removes it from the system. value: prebuildId: 07e03a28-65a5-4d98-b532-8ea67b188048 schema: $ref: '#/components/schemas/gitpod.v1.DeletePrebuildRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.DeletePrebuildResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: DeletePrebuild tags: - gitpod.v1.PrebuildService servers: [] /gitpod.v1.PrebuildService/DeleteWarmPool: post: description: "Deletes a warm pool.\n\n Deletion is processed asynchronously. The pool is marked for deletion\n and the\ \ runner drains instances in the background.\n\n Warm pools are also automatically deleted when prebuilds are disabled\n\ \ on the project or the environment class is removed from the prebuild\n configuration.\n\n ### Examples\n\n - Delete\ \ warm pool:\n\n ```yaml\n warmPoolId: \"a1b2c3d4-5678-9abc-def0-1234567890ab\"\n ```" operationId: gitpod.v1.PrebuildService.DeleteWarmPool parameters: [] requestBody: content: application/json: examples: delete_warm_pool: description: 'warmPoolId: "a1b2c3d4-5678-9abc-def0-1234567890ab" ' value: warmPoolId: a1b2c3d4-5678-9abc-def0-1234567890ab schema: $ref: '#/components/schemas/gitpod.v1.DeleteWarmPoolRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.DeleteWarmPoolResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: DeleteWarmPool tags: - gitpod.v1.PrebuildService servers: [] /gitpod.v1.PrebuildService/GetPrebuild: post: description: "Gets details about a specific prebuild.\n\n Use this method to:\n - Check prebuild status and progress\n\ \ - Access prebuild logs for debugging\n\n ### Examples\n\n - Get prebuild details:\n\n Retrieves comprehensive\ \ information about a prebuild.\n\n ```yaml\n prebuildId: \"07e03a28-65a5-4d98-b532-8ea67b188048\"\n ```" operationId: gitpod.v1.PrebuildService.GetPrebuild parameters: [] requestBody: content: application/json: examples: get_prebuild_details: description: Retrieves comprehensive information about a prebuild. value: prebuildId: 07e03a28-65a5-4d98-b532-8ea67b188048 schema: $ref: '#/components/schemas/gitpod.v1.GetPrebuildRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.GetPrebuildResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: GetPrebuild tags: - gitpod.v1.PrebuildService servers: [] /gitpod.v1.PrebuildService/GetWarmPool: post: description: "Gets details about a specific warm pool.\n\n Use this method to:\n - Check warm pool status and phase\n\ \ - View the current snapshot being warmed\n - Monitor pool health\n\n ### Examples\n\n - Get warm pool:\n\n ```yaml\n\ \ warmPoolId: \"a1b2c3d4-5678-9abc-def0-1234567890ab\"\n ```" operationId: gitpod.v1.PrebuildService.GetWarmPool parameters: [] requestBody: content: application/json: examples: get_warm_pool: description: 'warmPoolId: "a1b2c3d4-5678-9abc-def0-1234567890ab" ' value: warmPoolId: a1b2c3d4-5678-9abc-def0-1234567890ab schema: $ref: '#/components/schemas/gitpod.v1.GetWarmPoolRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.GetWarmPoolResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: GetWarmPool tags: - gitpod.v1.PrebuildService servers: [] /gitpod.v1.PrebuildService/ListPrebuilds: post: operationId: gitpod.v1.PrebuildService.ListPrebuilds 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.ListPrebuildsRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.ListPrebuildsResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: ListPrebuilds tags: - gitpod.v1.PrebuildService servers: [] /gitpod.v1.PrebuildService/ListWarmPools: post: description: "Lists warm pools with optional filtering.\n\n Use this method to:\n - View all warm pools for a project\n\ \ - Monitor warm pool status across environment classes\n\n ### Examples\n\n - List warm pools for a project:\n\n\ \ ```yaml\n filter:\n projectIds: [\"b0e12f6c-4c67-429d-a4a6-d9838b5da047\"]\n ```" operationId: gitpod.v1.PrebuildService.ListWarmPools 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_warm_pools_for_a_project: description: "filter:\n projectIds: [\"b0e12f6c-4c67-429d-a4a6-d9838b5da047\"]\n" value: filter: projectIds: - b0e12f6c-4c67-429d-a4a6-d9838b5da047 schema: $ref: '#/components/schemas/gitpod.v1.ListWarmPoolsRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.ListWarmPoolsResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: ListWarmPools tags: - gitpod.v1.PrebuildService servers: [] /gitpod.v1.PrebuildService/UpdateWarmPool: post: description: "Updates a warm pool's configuration.\n\n Use this method to change the desired pool size.\n\n ### Examples\n\ \n - Update pool size:\n\n ```yaml\n warmPoolId: \"a1b2c3d4-5678-9abc-def0-1234567890ab\"\n desiredSize: 5\n\ \ ```" operationId: gitpod.v1.PrebuildService.UpdateWarmPool parameters: [] requestBody: content: application/json: examples: update_pool_size: description: 'warmPoolId: "a1b2c3d4-5678-9abc-def0-1234567890ab" desiredSize: 5 ' value: desiredSize: 5 warmPoolId: a1b2c3d4-5678-9abc-def0-1234567890ab schema: $ref: '#/components/schemas/gitpod.v1.UpdateWarmPoolRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.UpdateWarmPoolResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: UpdateWarmPool tags: - gitpod.v1.PrebuildService servers: [] /gitpod.v1.ProjectService/CreateProject: post: description: "Creates a new project with specified configuration.\n\n Use this method to:\n - Set up development projects\n\ \ - Configure project environments\n - Define project settings\n - Initialize project content\n\n ### Examples\n\n\ \ - Create basic project:\n\n Creates a project with minimal configuration.\n\n ```yaml\n name: \"Web Application\"\ \n initializer:\n specs:\n - git:\n remoteUri: \"https://github.com/org/repo\"\n ```\n\n -\ \ Create project with devcontainer:\n\n Creates a project with custom development container.\n\n ```yaml\n name:\ \ \"Backend Service\"\n initializer:\n specs:\n - git:\n remoteUri: \"https://github.com/org/backend\"\ \n devcontainerFilePath: \".devcontainer/devcontainer.json\"\n automationsFilePath: \".gitpod/automations.yaml\"\ \n ```" operationId: gitpod.v1.ProjectService.CreateProject parameters: [] requestBody: content: application/json: examples: create_basic_project: description: Creates a project with minimal configuration. value: initializer: specs: - git: remoteUri: https://github.com/org/repo name: Web Application create_project_with_devcontainer: description: Creates a project with custom development container. value: automationsFilePath: .gitpod/automations.yaml devcontainerFilePath: .devcontainer/devcontainer.json initializer: specs: - git: remoteUri: https://github.com/org/backend name: Backend Service schema: $ref: '#/components/schemas/gitpod.v1.CreateProjectRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.CreateProjectResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: CreateProject tags: - gitpod.v1.ProjectService servers: [] /gitpod.v1.ProjectService/CreateProjectFromEnvironment: post: description: "Creates a new project using an existing environment as a template.\n\n Use this method to:\n - Clone environment\ \ configurations\n - Create projects from templates\n - Share environment setups\n\n ### Examples\n\n - Create from\ \ environment:\n\n Creates a project based on existing environment.\n\n ```yaml\n name: \"Frontend Project\"\ \n environmentId: \"07e03a28-65a5-4d98-b532-8ea67b188048\"\n ```" operationId: gitpod.v1.ProjectService.CreateProjectFromEnvironment parameters: [] requestBody: content: application/json: examples: create_from_environment: description: Creates a project based on existing environment. value: environmentId: 07e03a28-65a5-4d98-b532-8ea67b188048 name: Frontend Project schema: $ref: '#/components/schemas/gitpod.v1.CreateProjectFromEnvironmentRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.CreateProjectFromEnvironmentResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: CreateProjectFromEnvironment tags: - gitpod.v1.ProjectService servers: [] /gitpod.v1.ProjectService/CreateProjectPolicy: post: description: "Creates a new policy for a project.\n\n Use this method to:\n - Set up access controls\n - Define group\ \ permissions\n - Configure role-based access\n\n ### Examples\n\n - Create admin policy:\n\n Grants admin access\ \ to a group.\n\n ```yaml\n projectId: \"b0e12f6c-4c67-429d-a4a6-d9838b5da047\"\n groupId: \"f53d2330-3795-4c5d-a1f3-453121af9c60\"\ \n role: PROJECT_ROLE_ADMIN\n ```" operationId: gitpod.v1.ProjectService.CreateProjectPolicy parameters: [] requestBody: content: application/json: examples: create_admin_policy: description: Grants admin access to a group. value: groupId: f53d2330-3795-4c5d-a1f3-453121af9c60 projectId: b0e12f6c-4c67-429d-a4a6-d9838b5da047 role: PROJECT_ROLE_ADMIN schema: $ref: '#/components/schemas/gitpod.v1.CreateProjectPolicyRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.CreateProjectPolicyResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: CreateProjectPolicy tags: - gitpod.v1.ProjectService servers: [] /gitpod.v1.ProjectService/CreateProjects: post: description: "Creates multiple projects in a single request.\n\n Use this method to:\n - Onboard multiple repositories\ \ at once\n - Import a batch of projects during initial setup\n\n Returns successfully created projects and details\ \ about any failures.\n Each project in the request is processed independently — partial success\n is possible.\n\n\ \ ### Examples\n\n - Create multiple projects:\n\n Creates several projects in one request.\n\n ```yaml\n projects:\n\ \ - name: \"Frontend\"\n initializer:\n specs:\n - git:\n remoteUri: \"\ https://github.com/org/frontend\"\n - name: \"Backend\"\n initializer:\n specs:\n - git:\n\ \ remoteUri: \"https://github.com/org/backend\"\n ```" operationId: gitpod.v1.ProjectService.CreateProjects parameters: [] requestBody: content: application/json: examples: create_multiple_projects: description: Creates several projects in one request. value: projects: - initializer: specs: - git: remoteUri: https://github.com/org/frontend name: Frontend - initializer: specs: - git: remoteUri: https://github.com/org/backend name: Backend schema: $ref: '#/components/schemas/gitpod.v1.CreateProjectsRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.CreateProjectsResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: CreateProjects tags: - gitpod.v1.ProjectService servers: [] /gitpod.v1.ProjectService/DeleteProject: post: description: "Deletes a project permanently.\n\n Use this method to:\n - Remove unused projects\n - Clean up test projects\n\ \ - Delete obsolete configurations\n\n ### Examples\n\n - Delete project:\n\n Permanently removes a project.\n\n\ \ ```yaml\n projectId: \"b0e12f6c-4c67-429d-a4a6-d9838b5da047\"\n ```" operationId: gitpod.v1.ProjectService.DeleteProject parameters: [] requestBody: content: application/json: examples: delete_project: description: Permanently removes a project. value: projectId: b0e12f6c-4c67-429d-a4a6-d9838b5da047 schema: $ref: '#/components/schemas/gitpod.v1.DeleteProjectRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.DeleteProjectResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: DeleteProject tags: - gitpod.v1.ProjectService servers: [] /gitpod.v1.ProjectService/DeleteProjectPolicy: post: description: "Deletes a project policy.\n\n Use this method to:\n - Remove access controls\n - Revoke permissions\n\ \ - Clean up policies\n\n ### Examples\n\n - Delete policy:\n\n Removes a group's access policy.\n\n ```yaml\n\ \ projectId: \"b0e12f6c-4c67-429d-a4a6-d9838b5da047\"\n groupId: \"f53d2330-3795-4c5d-a1f3-453121af9c60\"\n \ \ ```" operationId: gitpod.v1.ProjectService.DeleteProjectPolicy parameters: [] requestBody: content: application/json: examples: delete_policy: description: Removes a group's access policy. value: groupId: f53d2330-3795-4c5d-a1f3-453121af9c60 projectId: b0e12f6c-4c67-429d-a4a6-d9838b5da047 schema: $ref: '#/components/schemas/gitpod.v1.DeleteProjectPolicyRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.DeleteProjectPolicyResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: DeleteProjectPolicy tags: - gitpod.v1.ProjectService servers: [] /gitpod.v1.ProjectService/DeleteProjects: post: description: "Deletes multiple projects in a single request.\n\n Use this method to:\n - Remove multiple unused projects\ \ at once\n - Clean up projects in batch\n\n Returns successfully deleted project IDs and details about any failures.\n\ \ Each project in the request is processed independently — partial success\n is possible.\n\n ### Examples\n\n - Delete\ \ multiple projects:\n\n Permanently removes several projects in one request.\n\n ```yaml\n projectIds:\n \ \ - \"b0e12f6c-4c67-429d-a4a6-d9838b5da047\"\n - \"c1f23g7d-5d78-430e-b5b7-e0949c6eb158\"\n ```" operationId: gitpod.v1.ProjectService.DeleteProjects parameters: [] requestBody: content: application/json: examples: delete_multiple_projects: description: Permanently removes several projects in one request. value: projectIds: - b0e12f6c-4c67-429d-a4a6-d9838b5da047 - c1f23g7d-5d78-430e-b5b7-e0949c6eb158 schema: $ref: '#/components/schemas/gitpod.v1.DeleteProjectsRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.DeleteProjectsResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: DeleteProjects tags: - gitpod.v1.ProjectService servers: [] /gitpod.v1.ProjectService/GetProject: post: description: "Gets details about a specific project.\n\n Use this method to:\n - View project configuration\n - Check\ \ project status\n - Get project metadata\n\n ### Examples\n\n - Get project details:\n\n Retrieves information\ \ about a specific project.\n\n ```yaml\n projectId: \"b0e12f6c-4c67-429d-a4a6-d9838b5da047\"\n ```" operationId: gitpod.v1.ProjectService.GetProject parameters: [] requestBody: content: application/json: examples: get_project_details: description: Retrieves information about a specific project. value: projectId: b0e12f6c-4c67-429d-a4a6-d9838b5da047 schema: $ref: '#/components/schemas/gitpod.v1.GetProjectRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.GetProjectResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: GetProject tags: - gitpod.v1.ProjectService servers: [] /gitpod.v1.ProjectService/ListProjectEnvironmentClasses: post: description: "Lists environment classes of a project.\n\n Use this method to:\n - View all environment classes of a\ \ project\n\n ### Examples\n\n - List project environment classes:\n\n Shows all environment classes of a project.\n\ \n ```yaml\n projectId: \"b0e12f6c-4c67-429d-a4a6-d9838b5da047\"\n pagination:\n pageSize: 20\n ```" operationId: gitpod.v1.ProjectService.ListProjectEnvironmentClasses 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_project_environment_classes: description: Shows all environment classes of a project. value: pagination: pageSize: 20 projectId: b0e12f6c-4c67-429d-a4a6-d9838b5da047 schema: $ref: '#/components/schemas/gitpod.v1.ListProjectEnvironmentClassesRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.ListProjectEnvironmentClassesResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: ListProjectEnvironmentClasses tags: - gitpod.v1.ProjectService servers: [] /gitpod.v1.ProjectService/ListProjectPolicies: post: description: "Lists policies for a project.\n\n Use this method to:\n - View access controls\n - Check policy configurations\n\ \ - Audit permissions\n\n ### Examples\n\n - List policies:\n\n Shows all policies for a project.\n\n ```yaml\n\ \ projectId: \"b0e12f6c-4c67-429d-a4a6-d9838b5da047\"\n pagination:\n pageSize: 20\n ```" operationId: gitpod.v1.ProjectService.ListProjectPolicies 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_policies: description: Shows all policies for a project. value: pagination: pageSize: 20 projectId: b0e12f6c-4c67-429d-a4a6-d9838b5da047 schema: $ref: '#/components/schemas/gitpod.v1.ListProjectPoliciesRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.ListProjectPoliciesResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: ListProjectPolicies tags: - gitpod.v1.ProjectService servers: [] /gitpod.v1.ProjectService/ListProjects: post: description: "Lists projects with optional filtering.\n\n Use this method to:\n - View all accessible projects\n - Browse\ \ project configurations\n - Monitor project status\n\n ### Examples\n\n - List projects:\n\n Shows all projects\ \ with pagination.\n\n ```yaml\n pagination:\n pageSize: 20\n ```" operationId: gitpod.v1.ProjectService.ListProjects 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_projects: description: Shows all projects with pagination. value: pagination: pageSize: 20 schema: $ref: '#/components/schemas/gitpod.v1.ListProjectsRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.ListProjectsResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: ListProjects tags: - gitpod.v1.ProjectService servers: [] /gitpod.v1.ProjectService/UpdateProject: post: description: "Updates a project's configuration.\n\n Use this method to:\n - Modify project settings\n - Update environment\ \ class\n - Change project name\n - Configure initializers\n - Configure prebuild settings\n\n ### Examples\n\n -\ \ Update project name:\n\n Changes the project's display name.\n\n ```yaml\n projectId: \"b0e12f6c-4c67-429d-a4a6-d9838b5da047\"\ \n name: \"New Project Name\"\n ```\n\n - Enable prebuilds with daily schedule:\n\n Configures prebuilds to\ \ run daily at 2 AM UTC.\n\n ```yaml\n projectId: \"b0e12f6c-4c67-429d-a4a6-d9838b5da047\"\n prebuildConfiguration:\n\ \ enabled: true\n environmentClassIds:\n - \"b0e12f6c-4c67-429d-a4a6-d9838b5da041\"\n timeout: \"\ 3600s\"\n trigger:\n dailySchedule:\n hourUtc: 2\n ```" operationId: gitpod.v1.ProjectService.UpdateProject parameters: [] requestBody: content: application/json: examples: enable_prebuilds_with_daily_schedule: description: Configures prebuilds to run daily at 2 AM UTC. value: prebuildConfiguration: enabled: true environmentClassIds: - b0e12f6c-4c67-429d-a4a6-d9838b5da041 timeout: 3600s trigger: dailySchedule: hourUtc: 2 projectId: b0e12f6c-4c67-429d-a4a6-d9838b5da047 update_project_name: description: Changes the project's display name. value: name: New Project Name projectId: b0e12f6c-4c67-429d-a4a6-d9838b5da047 schema: $ref: '#/components/schemas/gitpod.v1.UpdateProjectRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.UpdateProjectResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: UpdateProject tags: - gitpod.v1.ProjectService servers: [] /gitpod.v1.ProjectService/UpdateProjectEnvironmentClasses: post: description: "Updates all environment classes of a project.\n\n Use this method to:\n - Modify all environment classea\ \ of a project\n\n ### Examples\n\n - Update project environment classes:\n\n Updates all environment classes for\ \ a project.\n\n ```yaml\n projectId: \"b0e12f6c-4c67-429d-a4a6-d9838b5da047\"\n projectEnvironmentClasses:\n\ \ - environmentClassId: \"b0e12f6c-4c67-429d-a4a6-d9838b5da041\"\n order: 0\n - localRunner: true\n\ \ order: 1\n ```" operationId: gitpod.v1.ProjectService.UpdateProjectEnvironmentClasses parameters: [] requestBody: content: application/json: examples: update_project_environment_classes: description: Updates all environment classes for a project. value: projectEnvironmentClasses: - environmentClassId: b0e12f6c-4c67-429d-a4a6-d9838b5da041 order: 0 - localRunner: true order: 1 projectId: b0e12f6c-4c67-429d-a4a6-d9838b5da047 schema: $ref: '#/components/schemas/gitpod.v1.UpdateProjectEnvironmentClassesRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.UpdateProjectEnvironmentClassesResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: UpdateProjectEnvironmentClasses tags: - gitpod.v1.ProjectService servers: [] /gitpod.v1.ProjectService/UpdateProjectPolicy: post: description: "Updates an existing project policy.\n\n Use this method to:\n - Modify access levels\n - Change group\ \ roles\n - Update permissions\n\n ### Examples\n\n - Update policy role:\n\n Changes a group's access level.\n\n\ \ ```yaml\n projectId: \"b0e12f6c-4c67-429d-a4a6-d9838b5da047\"\n groupId: \"f53d2330-3795-4c5d-a1f3-453121af9c60\"\ \n role: PROJECT_ROLE_EDITOR\n ```" operationId: gitpod.v1.ProjectService.UpdateProjectPolicy parameters: [] requestBody: content: application/json: examples: update_policy_role: description: Changes a group's access level. value: groupId: f53d2330-3795-4c5d-a1f3-453121af9c60 projectId: b0e12f6c-4c67-429d-a4a6-d9838b5da047 role: PROJECT_ROLE_EDITOR schema: $ref: '#/components/schemas/gitpod.v1.UpdateProjectPolicyRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.UpdateProjectPolicyResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: UpdateProjectPolicy tags: - gitpod.v1.ProjectService servers: [] /gitpod.v1.ProjectService/UpdateProjects: post: description: "Updates multiple projects in a single request.\n\n Use this method to:\n - Modify settings across multiple\ \ projects at once\n - Apply configuration changes in batch\n\n Returns successfully updated projects and details\ \ about any failures.\n Each project in the request is processed independently — partial success\n is possible.\n\n\ \ ### Examples\n\n - Update multiple projects:\n\n Updates several projects in one request.\n\n ```yaml\n projects:\n\ \ - projectId: \"b0e12f6c-4c67-429d-a4a6-d9838b5da047\"\n name: \"Updated Frontend\"\n - projectId:\ \ \"c1f23g7d-5d78-430e-b5b7-e0949c6eb158\"\n name: \"Updated Backend\"\n ```" operationId: gitpod.v1.ProjectService.UpdateProjects parameters: [] requestBody: content: application/json: examples: update_multiple_projects: description: Updates several projects in one request. value: projects: - name: Updated Frontend projectId: b0e12f6c-4c67-429d-a4a6-d9838b5da047 - name: Updated Backend projectId: c1f23g7d-5d78-430e-b5b7-e0949c6eb158 schema: $ref: '#/components/schemas/gitpod.v1.UpdateProjectsRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.UpdateProjectsResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: UpdateProjects tags: - gitpod.v1.ProjectService servers: [] /gitpod.v1.RunnerConfigurationService/CreateEnvironmentClass: post: description: "Creates a new environment class for a runner.\n\n Use this method to:\n - Define compute resources\n -\ \ Configure environment settings\n - Set up runtime options\n\n ### Examples\n\n - Create environment class:\n\n \ \ Creates a new environment configuration.\n\n ```yaml\n runnerId: \"d2c94c27-3b76-4a42-b88c-95a85e392c68\"\n\ \ displayName: \"Large Instance\"\n description: \"8 CPU, 16GB RAM\"\n configuration:\n - key: \"cpu\"\n\ \ value: \"8\"\n - key: \"memory\"\n value: \"16384\"\n ```" operationId: gitpod.v1.RunnerConfigurationService.CreateEnvironmentClass parameters: [] requestBody: content: application/json: examples: create_environment_class: description: Creates a new environment configuration. value: configuration: - key: cpu value: '8' - key: memory value: '16384' description: 8 CPU, 16GB RAM displayName: Large Instance runnerId: d2c94c27-3b76-4a42-b88c-95a85e392c68 schema: $ref: '#/components/schemas/gitpod.v1.CreateEnvironmentClassRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.CreateEnvironmentClassResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: CreateEnvironmentClass tags: - gitpod.v1.RunnerConfigurationService servers: [] /gitpod.v1.RunnerConfigurationService/CreateHostAuthenticationToken: post: description: "Creates a new authentication token for accessing remote hosts.\n\n Use this method to:\n - Set up SCM\ \ authentication\n - Configure OAuth credentials\n - Manage PAT tokens\n\n ### Examples\n\n - Create OAuth token:\n\ \n Creates a new OAuth-based authentication token.\n\n ```yaml\n runnerId: \"d2c94c27-3b76-4a42-b88c-95a85e392c68\"\ \n userId: \"f53d2330-3795-4c5d-a1f3-453121af9c60\"\n host: \"github.com\"\n token: \"gho_xxxxxxxxxxxx\"\n \ \ source: HOST_AUTHENTICATION_TOKEN_SOURCE_OAUTH\n expiresAt: \"2024-12-31T23:59:59Z\"\n refreshToken: \"ghr_xxxxxxxxxxxx\"\ \n ```" operationId: gitpod.v1.RunnerConfigurationService.CreateHostAuthenticationToken parameters: [] requestBody: content: application/json: examples: create_o_auth_token: description: Creates a new OAuth-based authentication token. value: expiresAt: '2024-12-31T23:59:59Z' host: github.com refreshToken: ghr_xxxxxxxxxxxx runnerId: d2c94c27-3b76-4a42-b88c-95a85e392c68 source: HOST_AUTHENTICATION_TOKEN_SOURCE_OAUTH token: gho_xxxxxxxxxxxx userId: f53d2330-3795-4c5d-a1f3-453121af9c60 schema: $ref: '#/components/schemas/gitpod.v1.CreateHostAuthenticationTokenRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.CreateHostAuthenticationTokenResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: CreateHostAuthenticationToken tags: - gitpod.v1.RunnerConfigurationService servers: [] /gitpod.v1.RunnerConfigurationService/CreateLLMIntegration: post: description: "Creates a new LLM integration for a runner.\n\n Use this method to:\n - Configure LLM access\n - Set up\ \ LLM integrations\n - Enable LLM usage" operationId: gitpod.v1.RunnerConfigurationService.CreateLLMIntegration parameters: [] requestBody: content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.CreateLLMIntegrationRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.CreateLLMIntegrationResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: CreateLLMIntegration tags: - gitpod.v1.RunnerConfigurationService servers: [] /gitpod.v1.RunnerConfigurationService/CreateSCMIntegration: post: description: "Creates a new SCM integration for a runner.\n\n Use this method to:\n - Configure source control access\n\ \ - Set up repository integrations\n - Enable code synchronization\n\n ### Examples\n\n - Create GitHub integration:\n\ \n Sets up GitHub SCM integration.\n\n ```yaml\n runnerId: \"d2c94c27-3b76-4a42-b88c-95a85e392c68\"\n scmId:\ \ \"github\"\n host: \"github.com\"\n oauthClientId: \"client_id\"\n oauthPlaintextClientSecret: \"client_secret\"\ \n ```" operationId: gitpod.v1.RunnerConfigurationService.CreateSCMIntegration parameters: [] requestBody: content: application/json: examples: create_git_hub_integration: description: Sets up GitHub SCM integration. value: host: github.com oauthClientId: client_id oauthPlaintextClientSecret: client_secret runnerId: d2c94c27-3b76-4a42-b88c-95a85e392c68 scmId: github schema: $ref: '#/components/schemas/gitpod.v1.CreateSCMIntegrationRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.CreateSCMIntegrationResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: CreateSCMIntegration tags: - gitpod.v1.RunnerConfigurationService servers: [] /gitpod.v1.RunnerConfigurationService/DeleteHostAuthenticationToken: post: description: "Deletes a host authentication token.\n\n Use this method to:\n - Remove unused tokens\n - Revoke access\n\ \ - Clean up expired tokens\n\n ### Examples\n\n - Delete token:\n\n Permanently removes a token.\n\n ```yaml\n\ \ id: \"d2c94c27-3b76-4a42-b88c-95a85e392c68\"\n ```" operationId: gitpod.v1.RunnerConfigurationService.DeleteHostAuthenticationToken parameters: [] requestBody: content: application/json: examples: delete_token: description: Permanently removes a token. value: id: d2c94c27-3b76-4a42-b88c-95a85e392c68 schema: $ref: '#/components/schemas/gitpod.v1.DeleteHostAuthenticationTokenRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.DeleteHostAuthenticationTokenResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: DeleteHostAuthenticationToken tags: - gitpod.v1.RunnerConfigurationService servers: [] /gitpod.v1.RunnerConfigurationService/DeleteLLMIntegration: post: description: "Deletes an LLM integration.\n\n Use this method to:\n - Remove unused integrations\n - Clean up configurations\n\ \ - Revoke LLM access\n\n ### Examples\n\n - Delete integration:\n\n Removes an LLM integration.\n\n ```yaml\n\ \ id: \"d2c94c27-3b76-4a42-b88c-95a85e392c68\"\n ```" operationId: gitpod.v1.RunnerConfigurationService.DeleteLLMIntegration parameters: [] requestBody: content: application/json: examples: delete_integration: description: Removes an LLM integration. value: id: d2c94c27-3b76-4a42-b88c-95a85e392c68 schema: $ref: '#/components/schemas/gitpod.v1.DeleteLLMIntegrationRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.DeleteLLMIntegrationResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: DeleteLLMIntegration tags: - gitpod.v1.RunnerConfigurationService servers: [] /gitpod.v1.RunnerConfigurationService/DeleteSCMIntegration: post: description: "Deletes an SCM integration.\n\n Use this method to:\n - Remove unused integrations\n - Clean up configurations\n\ \ - Revoke SCM access\n\n ### Examples\n\n - Delete integration:\n\n Removes an SCM integration.\n\n ```yaml\n\ \ id: \"d2c94c27-3b76-4a42-b88c-95a85e392c68\"\n ```" operationId: gitpod.v1.RunnerConfigurationService.DeleteSCMIntegration parameters: [] requestBody: content: application/json: examples: delete_integration: description: Removes an SCM integration. value: id: d2c94c27-3b76-4a42-b88c-95a85e392c68 schema: $ref: '#/components/schemas/gitpod.v1.DeleteSCMIntegrationRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.DeleteSCMIntegrationResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: DeleteSCMIntegration tags: - gitpod.v1.RunnerConfigurationService servers: [] /gitpod.v1.RunnerConfigurationService/GetEnvironmentClass: post: description: "Gets details about a specific environment class.\n\n Use this method to:\n - View class configuration\n\ \ - Check resource settings\n - Verify availability\n\n ### Examples\n\n - Get class details:\n\n Retrieves information\ \ about a specific class.\n\n ```yaml\n environmentClassId: \"d2c94c27-3b76-4a42-b88c-95a85e392c68\"\n ```" operationId: gitpod.v1.RunnerConfigurationService.GetEnvironmentClass parameters: [] requestBody: content: application/json: examples: get_class_details: description: Retrieves information about a specific class. value: environmentClassId: d2c94c27-3b76-4a42-b88c-95a85e392c68 schema: $ref: '#/components/schemas/gitpod.v1.GetEnvironmentClassRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.GetEnvironmentClassResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: GetEnvironmentClass tags: - gitpod.v1.RunnerConfigurationService servers: [] /gitpod.v1.RunnerConfigurationService/GetHostAuthenticationToken: post: description: "Gets details about a specific host authentication token.\n\n Use this method to:\n - View token information\n\ \ - Check token expiration\n - Verify token validity\n\n ### Examples\n\n - Get token details:\n\n Retrieves information\ \ about a specific token.\n\n ```yaml\n id: \"d2c94c27-3b76-4a42-b88c-95a85e392c68\"\n ```" operationId: gitpod.v1.RunnerConfigurationService.GetHostAuthenticationToken parameters: [] requestBody: content: application/json: examples: get_token_details: description: Retrieves information about a specific token. value: id: d2c94c27-3b76-4a42-b88c-95a85e392c68 schema: $ref: '#/components/schemas/gitpod.v1.GetHostAuthenticationTokenRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.GetHostAuthenticationTokenResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: GetHostAuthenticationToken tags: - gitpod.v1.RunnerConfigurationService servers: [] /gitpod.v1.RunnerConfigurationService/GetLLMIntegration: post: description: "Gets details about a specific LLM integration.\n\n Use this method to:\n - View integration settings\n\ \ - Check integration status\n - Verify configuration\n\n ### Examples\n\n - Get integration details:\n\n Retrieves\ \ information about a specific integration.\n\n ```yaml\n id: \"d2c94c27-3b76-4a42-b88c-95a85e392c68\"\n ```" operationId: gitpod.v1.RunnerConfigurationService.GetLLMIntegration parameters: [] requestBody: content: application/json: examples: get_integration_details: description: Retrieves information about a specific integration. value: id: d2c94c27-3b76-4a42-b88c-95a85e392c68 schema: $ref: '#/components/schemas/gitpod.v1.GetLLMIntegrationRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.GetLLMIntegrationResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: GetLLMIntegration tags: - gitpod.v1.RunnerConfigurationService servers: [] /gitpod.v1.RunnerConfigurationService/GetRunnerConfigurationSchema: post: description: "Gets the latest runner configuration schema.\n\n Use this method to:\n - View available settings\n - Check\ \ configuration options\n - Validate configurations\n\n ### Examples\n\n - Get schema:\n\n Retrieves configuration\ \ schema for a runner.\n\n ```yaml\n runnerId: \"d2c94c27-3b76-4a42-b88c-95a85e392c68\"\n ```" operationId: gitpod.v1.RunnerConfigurationService.GetRunnerConfigurationSchema parameters: [] requestBody: content: application/json: examples: get_schema: description: Retrieves configuration schema for a runner. value: runnerId: d2c94c27-3b76-4a42-b88c-95a85e392c68 schema: $ref: '#/components/schemas/gitpod.v1.GetRunnerConfigurationSchemaRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.GetRunnerConfigurationSchemaResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: GetRunnerConfigurationSchema tags: - gitpod.v1.RunnerConfigurationService servers: [] /gitpod.v1.RunnerConfigurationService/GetSCMIntegration: post: description: "Gets details about a specific SCM integration.\n\n Use this method to:\n - View integration settings\n\ \ - Check integration status\n - Verify configuration\n\n ### Examples\n\n - Get integration details:\n\n Retrieves\ \ information about a specific integration.\n\n ```yaml\n id: \"d2c94c27-3b76-4a42-b88c-95a85e392c68\"\n ```" operationId: gitpod.v1.RunnerConfigurationService.GetSCMIntegration parameters: [] requestBody: content: application/json: examples: get_integration_details: description: Retrieves information about a specific integration. value: id: d2c94c27-3b76-4a42-b88c-95a85e392c68 schema: $ref: '#/components/schemas/gitpod.v1.GetSCMIntegrationRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.GetSCMIntegrationResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: GetSCMIntegration tags: - gitpod.v1.RunnerConfigurationService servers: [] /gitpod.v1.RunnerConfigurationService/ListEnvironmentClasses: post: description: "Lists environment classes with optional filtering.\n\n Use this method to:\n - View available classes\n\ \ - Filter by capability\n - Check enabled status\n\n ### Examples\n\n - List all classes:\n\n Shows all environment\ \ classes.\n\n ```yaml\n pagination:\n pageSize: 20\n ```\n\n - Filter enabled classes:\n\n Lists only\ \ enabled environment classes.\n\n ```yaml\n filter:\n enabled: true\n pagination:\n pageSize: 20\n\ \ ```\n buf:lint:ignore RPC_REQUEST_RESPONSE_UNIQUE" operationId: gitpod.v1.RunnerConfigurationService.ListEnvironmentClasses 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: filter_enabled_classes: description: Lists only enabled environment classes. value: filter: enabled: true pagination: pageSize: 20 list_all_classes: description: Shows all environment classes. value: pagination: pageSize: 20 schema: $ref: '#/components/schemas/gitpod.v1.ListEnvironmentClassesRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.ListEnvironmentClassesResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: ListEnvironmentClasses tags: - gitpod.v1.RunnerConfigurationService servers: [] /gitpod.v1.RunnerConfigurationService/ListHostAuthenticationTokens: post: description: "Lists host authentication tokens with optional filtering.\n\n Use this method to:\n - View all tokens\n\ \ - Filter by runner or user\n - Monitor token status\n\n ### Examples\n\n - List all tokens:\n\n Shows all tokens\ \ with pagination.\n\n ```yaml\n pagination:\n pageSize: 20\n ```\n\n - Filter by runner:\n\n Lists tokens\ \ for a specific runner.\n\n ```yaml\n filter:\n runnerId: \"d2c94c27-3b76-4a42-b88c-95a85e392c68\"\n pagination:\n\ \ pageSize: 20\n ```" operationId: gitpod.v1.RunnerConfigurationService.ListHostAuthenticationTokens 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: filter_by_runner: description: Lists tokens for a specific runner. value: filter: runnerId: d2c94c27-3b76-4a42-b88c-95a85e392c68 pagination: pageSize: 20 list_all_tokens: description: Shows all tokens with pagination. value: pagination: pageSize: 20 schema: $ref: '#/components/schemas/gitpod.v1.ListHostAuthenticationTokensRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.ListHostAuthenticationTokensResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: ListHostAuthenticationTokens tags: - gitpod.v1.RunnerConfigurationService servers: [] /gitpod.v1.RunnerConfigurationService/ListLLMIntegrations: post: description: "Lists LLM integrations for a runner.\n\n Use this method to:\n - View all integrations\n - Monitor integration\ \ status\n - Check available LLMs\n\n ### Examples\n\n - List integrations:\n\n Shows all LLM integrations.\n\n\ \ ```yaml\n filter:\n runnerIds: [\"d2c94c27-3b76-4a42-b88c-95a85e392c68\"]\n pagination:\n pageSize:\ \ 20\n ```" operationId: gitpod.v1.RunnerConfigurationService.ListLLMIntegrations 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_integrations: description: Shows all LLM integrations. value: filter: runnerIds: - d2c94c27-3b76-4a42-b88c-95a85e392c68 pagination: pageSize: 20 schema: $ref: '#/components/schemas/gitpod.v1.ListLLMIntegrationsRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.ListLLMIntegrationsResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: ListLLMIntegrations tags: - gitpod.v1.RunnerConfigurationService servers: [] /gitpod.v1.RunnerConfigurationService/ListSCMIntegrations: post: description: "Lists SCM integrations for a runner.\n\n Use this method to:\n - View all integrations\n - Monitor integration\ \ status\n - Check available SCMs\n\n ### Examples\n\n - List integrations:\n\n Shows all SCM integrations.\n\n\ \ ```yaml\n filter:\n runnerIds: [\"d2c94c27-3b76-4a42-b88c-95a85e392c68\"]\n pagination:\n pageSize:\ \ 20\n ```" operationId: gitpod.v1.RunnerConfigurationService.ListSCMIntegrations 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_integrations: description: Shows all SCM integrations. value: filter: runnerIds: - d2c94c27-3b76-4a42-b88c-95a85e392c68 pagination: pageSize: 20 schema: $ref: '#/components/schemas/gitpod.v1.ListSCMIntegrationsRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.ListSCMIntegrationsResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: ListSCMIntegrations tags: - gitpod.v1.RunnerConfigurationService servers: [] /gitpod.v1.RunnerConfigurationService/UpdateEnvironmentClass: post: description: "Updates an environment class.\n\n Use this method to:\n - Modify class settings\n - Update resource limits\n\ \ - Change availability\n\n ### Examples\n\n - Update class:\n\n Changes class configuration.\n\n ```yaml\n \ \ environmentClassId: \"d2c94c27-3b76-4a42-b88c-95a85e392c68\"\n displayName: \"Updated Large Instance\"\n description:\ \ \"16 CPU, 32GB RAM\"\n enabled: true\n ```" operationId: gitpod.v1.RunnerConfigurationService.UpdateEnvironmentClass parameters: [] requestBody: content: application/json: examples: update_class: description: Changes class configuration. value: description: 16 CPU, 32GB RAM displayName: Updated Large Instance enabled: true environmentClassId: d2c94c27-3b76-4a42-b88c-95a85e392c68 schema: $ref: '#/components/schemas/gitpod.v1.UpdateEnvironmentClassRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.UpdateEnvironmentClassResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: UpdateEnvironmentClass tags: - gitpod.v1.RunnerConfigurationService servers: [] /gitpod.v1.RunnerConfigurationService/UpdateHostAuthenticationToken: post: description: "Updates an existing host authentication token.\n\n Use this method to:\n - Refresh token values\n - Update\ \ expiration\n - Modify token settings\n\n ### Examples\n\n - Update token:\n\n Updates token value and expiration.\n\ \n ```yaml\n id: \"d2c94c27-3b76-4a42-b88c-95a85e392c68\"\n token: \"gho_xxxxxxxxxxxx\"\n expiresAt: \"2024-12-31T23:59:59Z\"\ \n refreshToken: \"ghr_xxxxxxxxxxxx\"\n ```" operationId: gitpod.v1.RunnerConfigurationService.UpdateHostAuthenticationToken parameters: [] requestBody: content: application/json: examples: update_token: description: Updates token value and expiration. value: expiresAt: '2024-12-31T23:59:59Z' id: d2c94c27-3b76-4a42-b88c-95a85e392c68 refreshToken: ghr_xxxxxxxxxxxx token: gho_xxxxxxxxxxxx schema: $ref: '#/components/schemas/gitpod.v1.UpdateHostAuthenticationTokenRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.UpdateHostAuthenticationTokenResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: UpdateHostAuthenticationToken tags: - gitpod.v1.RunnerConfigurationService servers: [] /gitpod.v1.RunnerConfigurationService/UpdateLLMIntegration: post: description: "Updates an existing LLM integration.\n\n Use this method to:\n - Modify integration settings\n - Update\ \ credentials\n - Change configuration\n\n ### Examples\n\n - Update integration:\n\n Updates OAuth credentials.\n\ \n ```yaml\n id: \"d2c94c27-3b76-4a42-b88c-95a85e392c68\"\n apiKey: \"sk-...\"\n ```" operationId: gitpod.v1.RunnerConfigurationService.UpdateLLMIntegration parameters: [] requestBody: content: application/json: examples: update_integration: description: Updates OAuth credentials. value: apiKey: sk-... id: d2c94c27-3b76-4a42-b88c-95a85e392c68 schema: $ref: '#/components/schemas/gitpod.v1.UpdateLLMIntegrationRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.UpdateLLMIntegrationResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: UpdateLLMIntegration tags: - gitpod.v1.RunnerConfigurationService servers: [] /gitpod.v1.RunnerConfigurationService/UpdateSCMIntegration: post: description: "Updates an existing SCM integration.\n\n Use this method to:\n - Modify integration settings\n - Update\ \ credentials\n - Change configuration\n\n ### Examples\n\n - Update integration:\n\n Updates OAuth credentials.\n\ \n ```yaml\n id: \"d2c94c27-3b76-4a42-b88c-95a85e392c68\"\n oauthClientId: \"new_client_id\"\n oauthPlaintextClientSecret:\ \ \"new_client_secret\"\n ```" operationId: gitpod.v1.RunnerConfigurationService.UpdateSCMIntegration parameters: [] requestBody: content: application/json: examples: update_integration: description: Updates OAuth credentials. value: id: d2c94c27-3b76-4a42-b88c-95a85e392c68 oauthClientId: new_client_id oauthPlaintextClientSecret: new_client_secret schema: $ref: '#/components/schemas/gitpod.v1.UpdateSCMIntegrationRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.UpdateSCMIntegrationResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: UpdateSCMIntegration tags: - gitpod.v1.RunnerConfigurationService servers: [] /gitpod.v1.RunnerConfigurationService/ValidateRunnerConfiguration: post: description: "Validates a runner configuration.\n\n Use this method to:\n - Check configuration validity\n - Verify\ \ integration settings\n - Validate environment classes\n\n ### Examples\n\n - Validate SCM integration:\n\n Checks\ \ if an SCM integration is valid.\n\n ```yaml\n runnerId: \"d2c94c27-3b76-4a42-b88c-95a85e392c68\"\n scmIntegration:\n\ \ id: \"integration-id\"\n scmId: \"github\"\n host: \"github.com\"\n oauthClientId: \"client_id\"\ \n oauthPlaintextClientSecret: \"client_secret\"\n ```" operationId: gitpod.v1.RunnerConfigurationService.ValidateRunnerConfiguration parameters: [] requestBody: content: application/json: examples: validate_scm_integration: description: Checks if an SCM integration is valid. value: runnerId: d2c94c27-3b76-4a42-b88c-95a85e392c68 scmIntegration: host: github.com id: integration-id oauthClientId: client_id oauthPlaintextClientSecret: client_secret scmId: github schema: $ref: '#/components/schemas/gitpod.v1.ValidateRunnerConfigurationRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.ValidateRunnerConfigurationResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: ValidateRunnerConfiguration tags: - gitpod.v1.RunnerConfigurationService servers: [] /gitpod.v1.RunnerInteractionService/GetHostAuthenticationTokenValue: post: description: "Retrieves authentication token for accessing remote hosts.\n\n Use this method to:\n - Get host credentials\n\ \ - Access SCM tokens\n - Verify authentication\n\n ### Examples\n\n - Get token:\n\n Retrieves authentication token\ \ for a host.\n\n ```yaml\n runnerId: \"d2c94c27-3b76-4a42-b88c-95a85e392c68\"\n principalId: \"f53d2330-3795-4c5d-a1f3-453121af9c60\"\ \n host: \"github.com\"\n ```" operationId: gitpod.v1.RunnerInteractionService.GetHostAuthenticationTokenValue parameters: [] requestBody: content: application/json: examples: get_token: description: Retrieves authentication token for a host. value: host: github.com principalId: f53d2330-3795-4c5d-a1f3-453121af9c60 runnerId: d2c94c27-3b76-4a42-b88c-95a85e392c68 schema: $ref: '#/components/schemas/gitpod.v1.GetHostAuthenticationTokenValueRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.GetHostAuthenticationTokenValueResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: GetHostAuthenticationTokenValue tags: - gitpod.v1.RunnerInteractionService servers: [] /gitpod.v1.RunnerInteractionService/GetLatestVersion: post: description: "Gets the latest version information for a runner.\n\n Use this method to:\n - Check for updates\n - Get\ \ version details\n - Verify compatibility\n\n ### Examples\n\n - Get version:\n\n Retrieves latest version info.\n\ \n ```yaml\n runnerId: \"d2c94c27-3b76-4a42-b88c-95a85e392c68\"\n currentVersion: \"1.2.3\"\n infrastructureVersion:\ \ \"4.5.6\"\n ```" operationId: gitpod.v1.RunnerInteractionService.GetLatestVersion parameters: [] requestBody: content: application/json: examples: get_version: description: Retrieves latest version info. value: currentVersion: 1.2.3 infrastructureVersion: 4.5.6 runnerId: d2c94c27-3b76-4a42-b88c-95a85e392c68 schema: $ref: '#/components/schemas/gitpod.v1.GetLatestVersionRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.GetLatestVersionResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: GetLatestVersion tags: - gitpod.v1.RunnerInteractionService servers: [] /gitpod.v1.RunnerInteractionService/GetManagedRunner: post: operationId: gitpod.v1.RunnerInteractionService.GetManagedRunner parameters: [] requestBody: content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.GetManagedRunnerRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.GetManagedRunnerResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: GetManagedRunner tags: - gitpod.v1.RunnerInteractionService servers: [] /gitpod.v1.RunnerInteractionService/GetRunnerAgentExecution: post: operationId: gitpod.v1.RunnerInteractionService.GetRunnerAgentExecution parameters: [] requestBody: content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.GetRunnerAgentExecutionRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.GetRunnerAgentExecutionResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: GetRunnerAgentExecution tags: - gitpod.v1.RunnerInteractionService servers: [] /gitpod.v1.RunnerInteractionService/GetRunnerConfiguration: post: operationId: gitpod.v1.RunnerInteractionService.GetRunnerConfiguration parameters: [] requestBody: content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.GetRunnerConfigurationRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.GetRunnerConfigurationResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: GetRunnerConfiguration tags: - gitpod.v1.RunnerInteractionService servers: [] /gitpod.v1.RunnerInteractionService/GetRunnerEnvironment: post: description: "Retrieves environment details for a specific runner.\n\n Use this method to:\n - Get environment configuration\n\ \ - Check environment status\n - Verify environment ownership\n\n ### Examples\n\n - Get environment:\n\n Retrieves\ \ environment details.\n\n ```yaml\n runnerId: \"d2c94c27-3b76-4a42-b88c-95a85e392c68\"\n environmentId: \"\ 07e03a28-65a5-4d98-b532-8ea67b188048\"\n ```" operationId: gitpod.v1.RunnerInteractionService.GetRunnerEnvironment parameters: [] requestBody: content: application/json: examples: get_environment: description: Retrieves environment details. value: environmentId: 07e03a28-65a5-4d98-b532-8ea67b188048 runnerId: d2c94c27-3b76-4a42-b88c-95a85e392c68 schema: $ref: '#/components/schemas/gitpod.v1.GetRunnerEnvironmentRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.GetRunnerEnvironmentResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: GetRunnerEnvironment tags: - gitpod.v1.RunnerInteractionService servers: [] /gitpod.v1.RunnerInteractionService/GetRunnerEnvironmentSnapshot: post: description: "Gets details about a specific snapshot including its status, size, and metadata.\n\n Use this method to:\n\ \ - Check if a snapshot is ready for use\n - Monitor snapshot creation progress\n - Get snapshot size and creation\ \ details\n - Retrieve provider-specific snapshot information" operationId: gitpod.v1.RunnerInteractionService.GetRunnerEnvironmentSnapshot parameters: [] requestBody: content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.GetRunnerEnvironmentSnapshotRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.GetRunnerEnvironmentSnapshotResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: GetRunnerEnvironmentSnapshot tags: - gitpod.v1.RunnerInteractionService servers: [] /gitpod.v1.RunnerInteractionService/GetRunnerLLMIntegration: post: operationId: gitpod.v1.RunnerInteractionService.GetRunnerLLMIntegration parameters: [] requestBody: content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.GetRunnerLLMIntegrationRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.GetRunnerLLMIntegrationResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: GetRunnerLLMIntegration tags: - gitpod.v1.RunnerInteractionService servers: [] /gitpod.v1.RunnerInteractionService/GetRunnerWarmPool: post: description: "Gets details about a specific warm pool assigned to this runner.\n\n Use this method to read the full\ \ warm pool spec after receiving\n an EventWarmPoolSpecChange event." operationId: gitpod.v1.RunnerInteractionService.GetRunnerWarmPool parameters: [] requestBody: content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.GetRunnerWarmPoolRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.GetRunnerWarmPoolResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: GetRunnerWarmPool tags: - gitpod.v1.RunnerInteractionService servers: [] /gitpod.v1.RunnerInteractionService/ListManagedRunners: post: description: Lists all runners managed by this runner manager. operationId: gitpod.v1.RunnerInteractionService.ListManagedRunners 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.ListManagedRunnersRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.ListManagedRunnersResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: ListManagedRunners tags: - gitpod.v1.RunnerInteractionService servers: [] /gitpod.v1.RunnerInteractionService/ListRunnerAgentExecutions: post: operationId: gitpod.v1.RunnerInteractionService.ListRunnerAgentExecutions 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.ListRunnerAgentExecutionsRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.ListRunnerAgentExecutionsResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: ListRunnerAgentExecutions tags: - gitpod.v1.RunnerInteractionService servers: [] /gitpod.v1.RunnerInteractionService/ListRunnerEnvironmentClasses: post: description: "Lists environment classes configured for a runner.\n\n Use this method to:\n - View available classes\n\ \ - Check class configurations\n - Monitor class status\n\n ### Examples\n\n - List classes:\n\n Shows environment\ \ classes for a runner.\n\n ```yaml\n runnerId: \"d2c94c27-3b76-4a42-b88c-95a85e392c68\"\n pagination:\n \ \ pageSize: 20\n ```" operationId: gitpod.v1.RunnerInteractionService.ListRunnerEnvironmentClasses 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_classes: description: Shows environment classes for a runner. value: pagination: pageSize: 20 runnerId: d2c94c27-3b76-4a42-b88c-95a85e392c68 schema: $ref: '#/components/schemas/gitpod.v1.ListRunnerEnvironmentClassesRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.ListRunnerEnvironmentClassesResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: ListRunnerEnvironmentClasses tags: - gitpod.v1.RunnerInteractionService servers: [] /gitpod.v1.RunnerInteractionService/ListRunnerEnvironmentSnapshots: post: description: "Lists all snapshots matching the specified criteria.\n\n Use this method to find and monitor snapshots\ \ across your organization.\n Results are ordered by creation time with newest snapshots first." operationId: gitpod.v1.RunnerInteractionService.ListRunnerEnvironmentSnapshots 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.ListRunnerEnvironmentSnapshotsRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.ListRunnerEnvironmentSnapshotsResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: ListRunnerEnvironmentSnapshots tags: - gitpod.v1.RunnerInteractionService servers: [] /gitpod.v1.RunnerInteractionService/ListRunnerEnvironments: post: description: "Lists all environments managed by a runner.\n\n Use this method to:\n - View assigned environments\n -\ \ Monitor environment status\n - Check environment assignments\n\n ### Examples\n\n - List environments:\n\n Shows\ \ all environments for a runner.\n\n ```yaml\n runnerId: \"d2c94c27-3b76-4a42-b88c-95a85e392c68\"\n pagination:\n\ \ pageSize: 20\n ```\n\n - List specific environments:\n\n Shows details for specific environment IDs.\n\n\ \ ```yaml\n runnerId: \"d2c94c27-3b76-4a42-b88c-95a85e392c68\"\n environmentIds: [\"07e03a28-65a5-4d98-b532-8ea67b188048\"\ ]\n pagination:\n pageSize: 20\n ```" operationId: gitpod.v1.RunnerInteractionService.ListRunnerEnvironments 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_environments: description: Shows all environments for a runner. value: pagination: pageSize: 20 runnerId: d2c94c27-3b76-4a42-b88c-95a85e392c68 list_specific_environments: description: Shows details for specific environment IDs. value: environmentIds: - 07e03a28-65a5-4d98-b532-8ea67b188048 pagination: pageSize: 20 runnerId: d2c94c27-3b76-4a42-b88c-95a85e392c68 schema: $ref: '#/components/schemas/gitpod.v1.ListRunnerEnvironmentsRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.ListRunnerEnvironmentsResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: ListRunnerEnvironments tags: - gitpod.v1.RunnerInteractionService servers: [] /gitpod.v1.RunnerInteractionService/ListRunnerIntegrations: post: description: "Lists integrations configured for a runner.\n\n Use this method to:\n - View available integrations\n\ \ - Check integration configurations\n - Monitor integration status\n\n ### Examples\n\n - List integrations:\n\n\ \ Shows integrations for a runner.\n\n ```yaml\n runnerId: \"d2c94c27-3b76-4a42-b88c-95a85e392c68\"\n pagination:\n\ \ pageSize: 20\n ```" operationId: gitpod.v1.RunnerInteractionService.ListRunnerIntegrations 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_integrations: description: Shows integrations for a runner. value: pagination: pageSize: 20 runnerId: d2c94c27-3b76-4a42-b88c-95a85e392c68 schema: $ref: '#/components/schemas/gitpod.v1.ListRunnerIntegrationsRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.ListRunnerIntegrationsResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: ListRunnerIntegrations tags: - gitpod.v1.RunnerInteractionService servers: [] /gitpod.v1.RunnerInteractionService/ListRunnerLLMIntegrations: post: operationId: gitpod.v1.RunnerInteractionService.ListRunnerLLMIntegrations 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.ListRunnerLLMIntegrationsRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.ListRunnerLLMIntegrationsResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: ListRunnerLLMIntegrations tags: - gitpod.v1.RunnerInteractionService servers: [] /gitpod.v1.RunnerInteractionService/ListRunnerSCMIntegrations: post: description: "Lists SCM integrations configured for a runner.\n\n Use this method to:\n - View SCM configurations\n\ \ - Check integration status\n - Monitor available SCMs\n\n ### Examples\n\n - List integrations:\n\n Shows SCM\ \ integrations for a runner.\n\n ```yaml\n runnerId: \"d2c94c27-3b76-4a42-b88c-95a85e392c68\"\n pagination:\n\ \ pageSize: 20\n ```" operationId: gitpod.v1.RunnerInteractionService.ListRunnerSCMIntegrations 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_integrations: description: Shows SCM integrations for a runner. value: pagination: pageSize: 20 runnerId: d2c94c27-3b76-4a42-b88c-95a85e392c68 schema: $ref: '#/components/schemas/gitpod.v1.ListRunnerSCMIntegrationsRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.ListRunnerSCMIntegrationsResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: ListRunnerSCMIntegrations tags: - gitpod.v1.RunnerInteractionService servers: [] /gitpod.v1.RunnerInteractionService/ListRunnerWarmPools: post: description: "Lists all warm pools assigned to this runner.\n\n Use this method on startup to discover all warm pools\ \ the runner\n should be managing." operationId: gitpod.v1.RunnerInteractionService.ListRunnerWarmPools 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.ListRunnerWarmPoolsRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.ListRunnerWarmPoolsResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: ListRunnerWarmPools tags: - gitpod.v1.RunnerInteractionService servers: [] /gitpod.v1.RunnerInteractionService/MarkRunnerActive: post: description: "Maintains the active status of a runner through periodic heartbeat signals. The runner must\n call this\ \ method every 30 seconds to indicate it's healthy and ready to accept workloads.\n\n Use this method to:\n - Keep\ \ runners marked as available in the system\n - Maintain health check status\n - Prevent automatic deregistration\n\ \ - Signal readiness for new workloads\n\n ### Examples\n\n - Send heartbeat:\n\n Marks a runner as active and healthy.\n\ \n ```yaml\n runnerId: \"d2c94c27-3b76-4a42-b88c-95a85e392c68\"\n ```" operationId: gitpod.v1.RunnerInteractionService.MarkRunnerActive parameters: [] requestBody: content: application/json: examples: send_heartbeat: description: Marks a runner as active and healthy. value: runnerId: d2c94c27-3b76-4a42-b88c-95a85e392c68 schema: $ref: '#/components/schemas/gitpod.v1.MarkRunnerActiveRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.MarkRunnerActiveResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: MarkRunnerActive tags: - gitpod.v1.RunnerInteractionService servers: [] /gitpod.v1.RunnerInteractionService/ReportLLMUsage: post: operationId: gitpod.v1.RunnerInteractionService.ReportLLMUsage parameters: [] requestBody: content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.ReportLLMUsageRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.ReportLLMUsageResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: ReportLLMUsage tags: - gitpod.v1.RunnerInteractionService servers: [] /gitpod.v1.RunnerInteractionService/ReportRunnerMetrics: post: description: "Reports runner operational metrics to the management plane for forwarding\n to Grafana Cloud. The runner\ \ gathers metrics from its local Prometheus\n registry, encodes them as a Prometheus WriteRequest protobuf, and\n\ \ Snappy-compresses the payload." operationId: gitpod.v1.RunnerInteractionService.ReportRunnerMetrics parameters: [] requestBody: content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.ReportRunnerMetricsRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.ReportRunnerMetricsResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: ReportRunnerMetrics tags: - gitpod.v1.RunnerInteractionService servers: [] /gitpod.v1.RunnerInteractionService/SendResponse: post: description: "Sends a response to a previously received request.\n\n Use this method to:\n - Respond to requests\n -\ \ Report operation results\n - Handle errors\n\n ### Examples\n\n - Send response:\n\n Responds to a request.\n\n\ \ ```yaml\n runnerId: \"d2c94c27-3b76-4a42-b88c-95a85e392c68\"\n requestId: \"d2c94c27-3b76-4a42-b88c-95a85e392c68\"\ \n callParseContext:\n resp:\n originalContextUrl: \"https://github.com/org/repo\"\n git:\n \ \ host: \"github.com\"\n owner: \"org\"\n repo: \"repo\"\n branch: \"main\"\n \ \ cloneUrl: \"https://github.com/org/repo.git\"\n ```" operationId: gitpod.v1.RunnerInteractionService.SendResponse parameters: [] requestBody: content: application/json: examples: send_response: description: Responds to a request. value: callParseContext: resp: git: branch: main cloneUrl: https://github.com/org/repo.git host: github.com owner: org repo: repo originalContextUrl: https://github.com/org/repo requestId: d2c94c27-3b76-4a42-b88c-95a85e392c68 runnerId: d2c94c27-3b76-4a42-b88c-95a85e392c68 schema: $ref: '#/components/schemas/gitpod.v1.SendResponseRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.SendResponseResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: SendResponse tags: - gitpod.v1.RunnerInteractionService servers: [] /gitpod.v1.RunnerInteractionService/Signup: post: description: "Establishes initial connection between a runner and the Gitpod backend. This is the first\n call a runner\ \ makes to register itself and establish its identity.\n\n Use this method to:\n - Register new runners with the platform\n\ \ - Exchange cryptographic keys for secure communication\n - Declare supported environment classes and capabilities\n\ \ - Initialize runner configuration\n\n ### Examples\n\n - Register runner:\n\n Registers a new runner with its\ \ public key and supported environment classes.\n\n ```yaml\n publicKey: \"AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA\"\ \ # 32 bytes of zeros, base64 encoded\n environmentClasses:\n - id: \"d2c94c27-3b76-4a42-b88c-95a85e392c68\"\ \n runnerId: \"f53d2330-3795-4c5d-a1f3-453121af9c60\"\n displayName: \"Large Instance\"\n description:\ \ \"8 CPU, 16GB RAM\"\n enabled: true\n configuration:\n - key: \"cpu\"\n value: \"\ 8\"\n - key: \"memory\"\n value: \"16384\"\n ```" operationId: gitpod.v1.RunnerInteractionService.Signup parameters: [] requestBody: content: application/json: examples: register_runner: description: Registers a new runner with its public key and supported environment classes. value: environmentClasses: - configuration: - key: cpu value: '8' - key: memory value: '16384' description: 8 CPU, 16GB RAM displayName: Large Instance enabled: true id: d2c94c27-3b76-4a42-b88c-95a85e392c68 runnerId: f53d2330-3795-4c5d-a1f3-453121af9c60 publicKey: AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA schema: $ref: '#/components/schemas/gitpod.v1.SignupRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.SignupResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: Signup tags: - gitpod.v1.RunnerInteractionService servers: [] /gitpod.v1.RunnerInteractionService/UpdateRunnerAgentExecution: post: operationId: gitpod.v1.RunnerInteractionService.UpdateRunnerAgentExecution parameters: [] requestBody: content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.UpdateRunnerAgentExecutionRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.UpdateRunnerAgentExecutionResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: UpdateRunnerAgentExecution tags: - gitpod.v1.RunnerInteractionService servers: [] /gitpod.v1.RunnerInteractionService/UpdateRunnerConfigurationSchema: post: description: "Updates the configuration schema for a runner.\n\n Use this method to:\n - Define configuration options\n\ \ - Update schema definitions\n - Set validation rules\n\n ### Examples\n\n - Update schema:\n\n Updates runner\ \ configuration schema.\n\n ```yaml\n runnerId: \"d2c94c27-3b76-4a42-b88c-95a85e392c68\"\n configSchema:\n \ \ version: \"1.0\"\n runnerConfig:\n - id: \"region\"\n name: \"Region\"\n description:\ \ \"Deployment region\"\n required: true\n string:\n default: \"us-west\"\n pattern:\ \ \"^[a-z]+-[a-z]+-[0-9]+$\"\n - id: \"autoUpdate\"\n name: \"Auto Update\"\n description: \"\ Enable automatic updates\"\n required: true\n bool:\n default: true\n ```" operationId: gitpod.v1.RunnerInteractionService.UpdateRunnerConfigurationSchema parameters: [] requestBody: content: application/json: examples: update_schema: description: Updates runner configuration schema. value: configSchema: runnerConfig: - description: Deployment region id: region name: Region required: true string: default: us-west pattern: ^[a-z]+-[a-z]+-[0-9]+$ - bool: default: true description: Enable automatic updates id: autoUpdate name: Auto Update required: true version: '1.0' runnerId: d2c94c27-3b76-4a42-b88c-95a85e392c68 schema: $ref: '#/components/schemas/gitpod.v1.UpdateRunnerConfigurationSchemaRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.UpdateRunnerConfigurationSchemaResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: UpdateRunnerConfigurationSchema tags: - gitpod.v1.RunnerInteractionService servers: [] /gitpod.v1.RunnerInteractionService/UpdateRunnerEnvironmentSnapshotStatus: post: description: "Updates the status of a snapshot during its lifecycle.\n\n Use this method to:\n - Report snapshot creation\ \ progress\n - Update completion percentage\n - Set snapshot phase (pending, creating, available, failed)\n - Provide\ \ provider-specific snapshot details\n - Report failure messages when snapshot creation fails" operationId: gitpod.v1.RunnerInteractionService.UpdateRunnerEnvironmentSnapshotStatus parameters: [] requestBody: content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.UpdateRunnerEnvironmentSnapshotStatusRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.UpdateRunnerEnvironmentSnapshotStatusResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: UpdateRunnerEnvironmentSnapshotStatus tags: - gitpod.v1.RunnerInteractionService servers: [] /gitpod.v1.RunnerInteractionService/UpdateRunnerEnvironmentStatus: post: description: "Provides comprehensive status updates about a managed environment. This method allows\n runners to report\ \ detailed state information about environments they're managing.\n\n Use this method to:\n - Report current environment\ \ phase and health status\n - Update machine and container states\n - Signal content and devcontainer readiness\n\ \ - Provide access URLs and endpoints\n - Report warnings or failure conditions\n\n ### Examples\n\n - Update status:\n\ \n Provides a detailed status update for an environment.\n\n ```yaml\n runnerId: \"d2c94c27-3b76-4a42-b88c-95a85e392c68\"\ \n environmentId: \"07e03a28-65a5-4d98-b532-8ea67b188048\"\n status:\n phase: ENVIRONMENT_PHASE_RUNNING\n\ \ statusVersion: \"1\"\n failureMessage: []\n warningMessage: []\n machine:\n phase: PHASE_RUNNING\n\ \ content:\n phase: CONTENT_PHASE_READY\n devcontainer:\n phase: PHASE_RUNNING\n environmentUrls:\n\ \ logs: \"https://logs.gitpod.io/environment\"\n ports: []\n ssh:\n url: \"ssh://ssh.gitpod.io:22\"\ \n ```" operationId: gitpod.v1.RunnerInteractionService.UpdateRunnerEnvironmentStatus parameters: [] requestBody: content: application/json: examples: update_status: description: Provides a detailed status update for an environment. value: environmentId: 07e03a28-65a5-4d98-b532-8ea67b188048 runnerId: d2c94c27-3b76-4a42-b88c-95a85e392c68 status: content: phase: CONTENT_PHASE_READY devcontainer: phase: PHASE_RUNNING environmentUrls: logs: https://logs.gitpod.io/environment ports: [] ssh: url: ssh://ssh.gitpod.io:22 failureMessage: [] machine: phase: PHASE_RUNNING phase: ENVIRONMENT_PHASE_RUNNING statusVersion: '1' warningMessage: [] schema: $ref: '#/components/schemas/gitpod.v1.UpdateRunnerEnvironmentStatusRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.UpdateRunnerEnvironmentStatusResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: UpdateRunnerEnvironmentStatus tags: - gitpod.v1.RunnerInteractionService servers: [] /gitpod.v1.RunnerInteractionService/UpdateRunnerStatus: post: description: "Updates the runner's status and capabilities.\n\n Use this method to:\n - Report runner health\n - Update\ \ version information\n - Signal system changes\n - Configure capabilities\n\n ### Examples\n\n - Update status:\n\ \n Updates runner status and details.\n\n ```yaml\n runnerId: \"d2c94c27-3b76-4a42-b88c-95a85e392c68\"\n version:\ \ \"1.2.3\"\n systemDetails: \"Linux x86_64\"\n logUrl: \"https://logs.example.com/runner\"\n region: \"us-west\"\ \n capabilities: [\"RUNNER_CAPABILITY_SECRET_CONTAINER_REGISTRY\"]\n ```" operationId: gitpod.v1.RunnerInteractionService.UpdateRunnerStatus parameters: [] requestBody: content: application/json: examples: update_status: description: Updates runner status and details. value: capabilities: - RUNNER_CAPABILITY_SECRET_CONTAINER_REGISTRY logUrl: https://logs.example.com/runner region: us-west runnerId: d2c94c27-3b76-4a42-b88c-95a85e392c68 systemDetails: Linux x86_64 version: 1.2.3 schema: $ref: '#/components/schemas/gitpod.v1.UpdateRunnerStatusRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.UpdateRunnerStatusResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: UpdateRunnerStatus tags: - gitpod.v1.RunnerInteractionService servers: [] /gitpod.v1.RunnerInteractionService/UpdateRunnerWarmPoolStatus: post: description: "Updates the status of a warm pool.\n\n Use this method to:\n - Report warm pool phase transitions (ready,\ \ degraded)\n - Report failure messages when pool instances cannot be created" operationId: gitpod.v1.RunnerInteractionService.UpdateRunnerWarmPoolStatus parameters: [] requestBody: content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.UpdateRunnerWarmPoolStatusRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.UpdateRunnerWarmPoolStatusResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: UpdateRunnerWarmPoolStatus tags: - gitpod.v1.RunnerInteractionService servers: [] /gitpod.v1.RunnerInteractionService/WatchManagedRunners: post: description: Watches for changes to managed runners. operationId: gitpod.v1.RunnerInteractionService.WatchManagedRunners parameters: [] requestBody: content: application/connect+json: schema: $ref: '#/components/schemas/gitpod.v1.WatchManagedRunnersRequest' application/connect+proto: schema: $ref: '#/components/schemas/gitpod.v1.WatchManagedRunnersRequest' application/grpc: schema: $ref: '#/components/schemas/gitpod.v1.WatchManagedRunnersRequest' application/grpc+json: schema: $ref: '#/components/schemas/gitpod.v1.WatchManagedRunnersRequest' application/grpc+proto: schema: $ref: '#/components/schemas/gitpod.v1.WatchManagedRunnersRequest' application/grpc-web: schema: $ref: '#/components/schemas/gitpod.v1.WatchManagedRunnersRequest' application/grpc-web+json: schema: $ref: '#/components/schemas/gitpod.v1.WatchManagedRunnersRequest' application/grpc-web+proto: schema: $ref: '#/components/schemas/gitpod.v1.WatchManagedRunnersRequest' required: true responses: '200': content: application/connect+json: schema: $ref: '#/components/schemas/gitpod.v1.WatchManagedRunnersResponse' application/connect+proto: schema: $ref: '#/components/schemas/gitpod.v1.WatchManagedRunnersResponse' application/grpc: schema: $ref: '#/components/schemas/gitpod.v1.WatchManagedRunnersResponse' application/grpc+json: schema: $ref: '#/components/schemas/gitpod.v1.WatchManagedRunnersResponse' application/grpc+proto: schema: $ref: '#/components/schemas/gitpod.v1.WatchManagedRunnersResponse' application/grpc-web: schema: $ref: '#/components/schemas/gitpod.v1.WatchManagedRunnersResponse' application/grpc-web+json: schema: $ref: '#/components/schemas/gitpod.v1.WatchManagedRunnersResponse' application/grpc-web+proto: schema: $ref: '#/components/schemas/gitpod.v1.WatchManagedRunnersResponse' description: Success default: content: application/connect+json: schema: $ref: '#/components/schemas/connect.error' application/connect+proto: schema: $ref: '#/components/schemas/connect.error' application/grpc: schema: $ref: '#/components/schemas/connect.error' application/grpc+json: schema: $ref: '#/components/schemas/connect.error' application/grpc+proto: schema: $ref: '#/components/schemas/connect.error' application/grpc-web: schema: $ref: '#/components/schemas/connect.error' application/grpc-web+json: schema: $ref: '#/components/schemas/connect.error' application/grpc-web+proto: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: WatchManagedRunners tags: - gitpod.v1.RunnerInteractionService servers: [] /gitpod.v1.RunnerInteractionService/WatchRequests: post: description: "Streams requests that need to be handled by the runner.\n\n Use this method to:\n - Receive configuration\ \ changes\n - Handle environment updates\n - Process integration events\n - Monitor real-time events" operationId: gitpod.v1.RunnerInteractionService.WatchRequests parameters: [] requestBody: content: application/connect+json: schema: $ref: '#/components/schemas/gitpod.v1.WatchRequestsRequest' application/connect+proto: schema: $ref: '#/components/schemas/gitpod.v1.WatchRequestsRequest' application/grpc: schema: $ref: '#/components/schemas/gitpod.v1.WatchRequestsRequest' application/grpc+json: schema: $ref: '#/components/schemas/gitpod.v1.WatchRequestsRequest' application/grpc+proto: schema: $ref: '#/components/schemas/gitpod.v1.WatchRequestsRequest' application/grpc-web: schema: $ref: '#/components/schemas/gitpod.v1.WatchRequestsRequest' application/grpc-web+json: schema: $ref: '#/components/schemas/gitpod.v1.WatchRequestsRequest' application/grpc-web+proto: schema: $ref: '#/components/schemas/gitpod.v1.WatchRequestsRequest' required: true responses: '200': content: application/connect+json: schema: $ref: '#/components/schemas/gitpod.v1.WatchRequestsResponse' application/connect+proto: schema: $ref: '#/components/schemas/gitpod.v1.WatchRequestsResponse' application/grpc: schema: $ref: '#/components/schemas/gitpod.v1.WatchRequestsResponse' application/grpc+json: schema: $ref: '#/components/schemas/gitpod.v1.WatchRequestsResponse' application/grpc+proto: schema: $ref: '#/components/schemas/gitpod.v1.WatchRequestsResponse' application/grpc-web: schema: $ref: '#/components/schemas/gitpod.v1.WatchRequestsResponse' application/grpc-web+json: schema: $ref: '#/components/schemas/gitpod.v1.WatchRequestsResponse' application/grpc-web+proto: schema: $ref: '#/components/schemas/gitpod.v1.WatchRequestsResponse' description: Success default: content: application/connect+json: schema: $ref: '#/components/schemas/connect.error' application/connect+proto: schema: $ref: '#/components/schemas/connect.error' application/grpc: schema: $ref: '#/components/schemas/connect.error' application/grpc+json: schema: $ref: '#/components/schemas/connect.error' application/grpc+proto: schema: $ref: '#/components/schemas/connect.error' application/grpc-web: schema: $ref: '#/components/schemas/connect.error' application/grpc-web+json: schema: $ref: '#/components/schemas/connect.error' application/grpc-web+proto: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: WatchRequests tags: - gitpod.v1.RunnerInteractionService servers: [] /gitpod.v1.RunnerManagerService/CreateRunnerManager: post: operationId: gitpod.v1.RunnerManagerService.CreateRunnerManager parameters: [] requestBody: content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.CreateRunnerManagerRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.CreateRunnerManagerResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: CreateRunnerManager tags: - gitpod.v1.RunnerManagerService servers: [] /gitpod.v1.RunnerManagerService/DeleteRunnerManager: post: operationId: gitpod.v1.RunnerManagerService.DeleteRunnerManager parameters: [] requestBody: content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.DeleteRunnerManagerRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.DeleteRunnerManagerResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: DeleteRunnerManager tags: - gitpod.v1.RunnerManagerService servers: [] /gitpod.v1.RunnerManagerService/GetRunnerManager: post: operationId: gitpod.v1.RunnerManagerService.GetRunnerManager parameters: [] requestBody: content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.GetRunnerManagerRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.GetRunnerManagerResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: GetRunnerManager tags: - gitpod.v1.RunnerManagerService servers: [] /gitpod.v1.RunnerManagerService/ListAvailableRunnerManagers: post: description: Lists available runner managers with minimal details. Used by users to select managed runners for their organization. operationId: gitpod.v1.RunnerManagerService.ListAvailableRunnerManagers 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.ListAvailableRunnerManagersRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.ListAvailableRunnerManagersResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: ListAvailableRunnerManagers tags: - gitpod.v1.RunnerManagerService servers: [] /gitpod.v1.RunnerManagerService/ListRunnerManagers: post: description: Lists all runner managers with full details. Used by account principals for administration. operationId: gitpod.v1.RunnerManagerService.ListRunnerManagers 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.ListRunnerManagersRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.ListRunnerManagersResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: ListRunnerManagers tags: - gitpod.v1.RunnerManagerService servers: [] /gitpod.v1.RunnerManagerService/UpdateRunnerManager: post: operationId: gitpod.v1.RunnerManagerService.UpdateRunnerManager parameters: [] requestBody: content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.UpdateRunnerManagerRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.UpdateRunnerManagerResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: UpdateRunnerManager tags: - gitpod.v1.RunnerManagerService servers: [] /gitpod.v1.RunnerService/CheckAuthenticationForHost: post: description: "Checks if a user is authenticated for a specific host.\n\n Use this method to:\n - Verify authentication\ \ status\n - Get authentication URLs\n - Check PAT support\n\n ### Examples\n\n - Check authentication:\n\n Verifies\ \ authentication for a host.\n\n ```yaml\n host: \"github.com\"\n ```" operationId: gitpod.v1.RunnerService.CheckAuthenticationForHost parameters: [] requestBody: content: application/json: examples: check_authentication: description: Verifies authentication for a host. value: host: github.com schema: $ref: '#/components/schemas/gitpod.v1.CheckAuthenticationForHostRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.CheckAuthenticationForHostResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: CheckAuthenticationForHost tags: - gitpod.v1.RunnerService servers: [] /gitpod.v1.RunnerService/CheckRepositoryAccess: post: description: "Checks if a principal has read access to a repository.\n\n Use this method to:\n - Validate repository\ \ access before workflow execution\n - Verify executor credentials for automation bindings\n\n Returns:\n - has_access:\ \ true if the principal can read the repository\n - FAILED_PRECONDITION if authentication is required\n - INVALID_ARGUMENT\ \ if the repository URL is invalid\n\n ### Examples\n\n - Check access:\n\n Verifies read access to a repository.\n\ \n ```yaml\n runnerId: \"d2c94c27-3b76-4a42-b88c-95a85e392c68\"\n repositoryUrl: \"https://github.com/org/repo\"\ \n ```" operationId: gitpod.v1.RunnerService.CheckRepositoryAccess parameters: [] requestBody: content: application/json: examples: check_access: description: Verifies read access to a repository. value: repositoryUrl: https://github.com/org/repo runnerId: d2c94c27-3b76-4a42-b88c-95a85e392c68 schema: $ref: '#/components/schemas/gitpod.v1.CheckRepositoryAccessRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.CheckRepositoryAccessResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: CheckRepositoryAccess tags: - gitpod.v1.RunnerService servers: [] /gitpod.v1.RunnerService/CreateRunner: post: description: "Creates a new runner registration with the server. Registrations are very short-lived and must be renewed\ \ every 30 seconds.\n\n Use this method to:\n - Register organization runners\n - Set up runner configurations\n -\ \ Initialize runner credentials\n - Configure auto-updates\n\n ### Examples\n\n - Create cloud runner:\n\n Creates\ \ a new runner in AWS EC2.\n\n ```yaml\n name: \"Production Runner\"\n provider: RUNNER_PROVIDER_AWS_EC2\n \ \ spec:\n desiredPhase: RUNNER_PHASE_ACTIVE\n configuration:\n region: \"us-west\"\n releaseChannel:\ \ RUNNER_RELEASE_CHANNEL_STABLE\n autoUpdate: true\n ```\n\n - Create local runner:\n\n Creates a new local\ \ runner on Linux.\n\n ```yaml\n name: \"Local Development Runner\"\n provider: RUNNER_PROVIDER_LINUX_HOST\n\ \ spec:\n desiredPhase: RUNNER_PHASE_ACTIVE\n configuration:\n releaseChannel: RUNNER_RELEASE_CHANNEL_LATEST\n\ \ autoUpdate: true\n ```" operationId: gitpod.v1.RunnerService.CreateRunner parameters: [] requestBody: content: application/json: examples: create_cloud_runner: description: Creates a new runner in AWS EC2. value: name: Production Runner provider: RUNNER_PROVIDER_AWS_EC2 spec: configuration: autoUpdate: true region: us-west releaseChannel: RUNNER_RELEASE_CHANNEL_STABLE desiredPhase: RUNNER_PHASE_ACTIVE create_local_runner: description: Creates a new local runner on Linux. value: name: Local Development Runner provider: RUNNER_PROVIDER_LINUX_HOST spec: configuration: autoUpdate: true releaseChannel: RUNNER_RELEASE_CHANNEL_LATEST desiredPhase: RUNNER_PHASE_ACTIVE schema: $ref: '#/components/schemas/gitpod.v1.CreateRunnerRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.CreateRunnerResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: CreateRunner tags: - gitpod.v1.RunnerService servers: [] /gitpod.v1.RunnerService/CreateRunnerLogsToken: post: description: "Creates an access token for runner logs and debug information.\n\n Generated tokens are valid for one\ \ hour and provide runner-specific access permissions.\n The token is scoped to a specific runner and can be used\ \ to access support bundles.\n\n ### Examples\n\n - Generate runner logs token:\n\n ```yaml\n runnerId: \"d2c94c27-3b76-4a42-b88c-95a85e392c68\"\ \n ```" operationId: gitpod.v1.RunnerService.CreateRunnerLogsToken parameters: [] requestBody: content: application/json: examples: generate_runner_logs_token: description: 'runnerId: "d2c94c27-3b76-4a42-b88c-95a85e392c68" ' value: runnerId: d2c94c27-3b76-4a42-b88c-95a85e392c68 schema: $ref: '#/components/schemas/gitpod.v1.CreateRunnerLogsTokenRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.CreateRunnerLogsTokenResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: CreateRunnerLogsToken tags: - gitpod.v1.RunnerService servers: [] /gitpod.v1.RunnerService/CreateRunnerPolicy: post: description: "Creates a new policy for a runner.\n\n Use this method to:\n - Set up access controls\n - Define group\ \ permissions\n - Configure role-based access\n\n ### Examples\n\n - Create admin policy:\n\n Grants admin access\ \ to a group.\n\n ```yaml\n runnerId: \"d2c94c27-3b76-4a42-b88c-95a85e392c68\"\n groupId: \"f53d2330-3795-4c5d-a1f3-453121af9c60\"\ \n role: RUNNER_ROLE_ADMIN\n ```" operationId: gitpod.v1.RunnerService.CreateRunnerPolicy parameters: [] requestBody: content: application/json: examples: create_admin_policy: description: Grants admin access to a group. value: groupId: f53d2330-3795-4c5d-a1f3-453121af9c60 role: RUNNER_ROLE_ADMIN runnerId: d2c94c27-3b76-4a42-b88c-95a85e392c68 schema: $ref: '#/components/schemas/gitpod.v1.CreateRunnerPolicyRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.CreateRunnerPolicyResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: CreateRunnerPolicy tags: - gitpod.v1.RunnerService servers: [] /gitpod.v1.RunnerService/CreateRunnerToken: post: description: "Creates a new authentication token for a runner.\n\n Use this method to:\n - Generate runner credentials\n\ \ - Renew expired tokens\n - Set up runner authentication\n\n Note: This does not expire previously issued tokens.\n\ \n ### Examples\n\n - Create token:\n\n Creates a new token for runner authentication.\n\n ```yaml\n runnerId:\ \ \"d2c94c27-3b76-4a42-b88c-95a85e392c68\"\n ```" operationId: gitpod.v1.RunnerService.CreateRunnerToken parameters: [] requestBody: content: application/json: examples: create_token: description: Creates a new token for runner authentication. value: runnerId: d2c94c27-3b76-4a42-b88c-95a85e392c68 schema: $ref: '#/components/schemas/gitpod.v1.CreateRunnerTokenRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.CreateRunnerTokenResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: CreateRunnerToken tags: - gitpod.v1.RunnerService servers: [] /gitpod.v1.RunnerService/DeleteRunner: post: description: "Deletes a runner permanently.\n\n Use this method to:\n - Remove unused runners\n - Clean up runner registrations\n\ \ - Delete obsolete runners\n\n ### Examples\n\n - Delete runner:\n\n Permanently removes a runner.\n\n ```yaml\n\ \ runnerId: \"d2c94c27-3b76-4a42-b88c-95a85e392c68\"\n ```" operationId: gitpod.v1.RunnerService.DeleteRunner parameters: [] requestBody: content: application/json: examples: delete_runner: description: Permanently removes a runner. value: runnerId: d2c94c27-3b76-4a42-b88c-95a85e392c68 schema: $ref: '#/components/schemas/gitpod.v1.DeleteRunnerRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.DeleteRunnerResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: DeleteRunner tags: - gitpod.v1.RunnerService servers: [] /gitpod.v1.RunnerService/DeleteRunnerPolicy: post: description: "Deletes a runner policy.\n\n Use this method to:\n - Remove access controls\n - Revoke permissions\n -\ \ Clean up policies\n\n ### Examples\n\n - Delete policy:\n\n Removes a group's access policy.\n\n ```yaml\n \ \ runnerId: \"d2c94c27-3b76-4a42-b88c-95a85e392c68\"\n groupId: \"f53d2330-3795-4c5d-a1f3-453121af9c60\"\n ```" operationId: gitpod.v1.RunnerService.DeleteRunnerPolicy parameters: [] requestBody: content: application/json: examples: delete_policy: description: Removes a group's access policy. value: groupId: f53d2330-3795-4c5d-a1f3-453121af9c60 runnerId: d2c94c27-3b76-4a42-b88c-95a85e392c68 schema: $ref: '#/components/schemas/gitpod.v1.DeleteRunnerPolicyRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.DeleteRunnerPolicyResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: DeleteRunnerPolicy tags: - gitpod.v1.RunnerService servers: [] /gitpod.v1.RunnerService/GetRunner: post: description: "Gets details about a specific runner.\n\n Use this method to:\n - Check runner status\n - View runner\ \ configuration\n - Monitor runner health\n - Verify runner capabilities\n\n ### Examples\n\n - Get runner details:\n\ \n Retrieves information about a specific runner.\n\n ```yaml\n runnerId: \"d2c94c27-3b76-4a42-b88c-95a85e392c68\"\ \n ```" operationId: gitpod.v1.RunnerService.GetRunner parameters: [] requestBody: content: application/json: examples: get_runner_details: description: Retrieves information about a specific runner. value: runnerId: d2c94c27-3b76-4a42-b88c-95a85e392c68 schema: $ref: '#/components/schemas/gitpod.v1.GetRunnerRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.GetRunnerResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: GetRunner tags: - gitpod.v1.RunnerService servers: [] /gitpod.v1.RunnerService/ListRunnerPolicies: post: description: "Lists policies for a runner.\n\n Use this method to:\n - View access controls\n - Check policy configurations\n\ \ - Audit permissions\n\n ### Examples\n\n - List policies:\n\n Shows all policies for a runner.\n\n ```yaml\n\ \ runnerId: \"d2c94c27-3b76-4a42-b88c-95a85e392c68\"\n pagination:\n pageSize: 20\n ```" operationId: gitpod.v1.RunnerService.ListRunnerPolicies 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_policies: description: Shows all policies for a runner. value: pagination: pageSize: 20 runnerId: d2c94c27-3b76-4a42-b88c-95a85e392c68 schema: $ref: '#/components/schemas/gitpod.v1.ListRunnerPoliciesRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.ListRunnerPoliciesResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: ListRunnerPolicies tags: - gitpod.v1.RunnerService servers: [] /gitpod.v1.RunnerService/ListRunners: post: description: "Lists all registered runners with optional filtering.\n\n Use this method to:\n - View all available runners\n\ \ - Filter by runner type\n - Monitor runner status\n - Check runner availability\n\n ### Examples\n\n - List all\ \ runners:\n\n Shows all runners with pagination.\n\n ```yaml\n pagination:\n pageSize: 20\n ```\n\n -\ \ Filter by provider:\n\n Lists only AWS EC2 runners.\n\n ```yaml\n filter:\n providers: [\"RUNNER_PROVIDER_AWS_EC2\"\ ]\n pagination:\n pageSize: 20\n ```" operationId: gitpod.v1.RunnerService.ListRunners 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: filter_by_provider: description: Lists only AWS EC2 runners. value: filter: providers: - RUNNER_PROVIDER_AWS_EC2 pagination: pageSize: 20 list_all_runners: description: Shows all runners with pagination. value: pagination: pageSize: 20 schema: $ref: '#/components/schemas/gitpod.v1.ListRunnersRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.ListRunnersResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: ListRunners tags: - gitpod.v1.RunnerService servers: [] /gitpod.v1.RunnerService/ListSCMOrganizations: post: description: "Lists SCM organizations the user belongs to.\n\n Use this method to:\n - Get all organizations for a user\ \ on a specific SCM host\n - Check organization admin permissions for webhook creation\n\n ### Examples\n\n - List\ \ GitHub organizations:\n\n Lists all organizations the user belongs to on GitHub.\n\n ```yaml\n runnerId: \"\ d2c94c27-3b76-4a42-b88c-95a85e392c68\"\n scmHost: \"github.com\"\n ```" operationId: gitpod.v1.RunnerService.ListSCMOrganizations 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_git_hub_organizations: description: Lists all organizations the user belongs to on GitHub. value: runnerId: d2c94c27-3b76-4a42-b88c-95a85e392c68 scmHost: github.com schema: $ref: '#/components/schemas/gitpod.v1.ListSCMOrganizationsRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.ListSCMOrganizationsResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: ListSCMOrganizations tags: - gitpod.v1.RunnerService servers: [] /gitpod.v1.RunnerService/ParseContextURL: post: description: "Parses a context URL and returns the parsed result.\n\n Use this method to:\n - Validate context URLs\n\ \ - Check repository access\n - Verify branch existence\n\n Returns:\n - FAILED_PRECONDITION if authentication is\ \ required\n - PERMISSION_DENIED if access is not allowed\n - INVALID_ARGUMENT if URL is invalid\n - NOT_FOUND if\ \ repository/branch doesn't exist\n\n ### Examples\n\n - Parse URL:\n\n Parses and validates a context URL.\n\n\ \ ```yaml\n contextUrl: \"https://github.com/org/repo/tree/main\"\n ```" operationId: gitpod.v1.RunnerService.ParseContextURL parameters: [] requestBody: content: application/json: examples: parse_url: description: Parses and validates a context URL. value: contextUrl: https://github.com/org/repo/tree/main schema: $ref: '#/components/schemas/gitpod.v1.ParseContextURLRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.ParseContextURLResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: ParseContextURL tags: - gitpod.v1.RunnerService servers: [] /gitpod.v1.RunnerService/SearchRepositories: post: description: "Searches for repositories across all authenticated SCM hosts.\n\n Use this method to:\n - List available\ \ repositories\n - Search repositories by name or content\n - Discover repositories for environment creation\n\n Returns\ \ repositories from all authenticated SCM hosts in natural sort order.\n If no repositories are found, returns an\ \ empty list.\n\n ### Examples\n\n - List all repositories:\n\n Returns up to 25 repositories from all authenticated\ \ hosts.\n\n ```yaml\n runnerId: \"d2c94c27-3b76-4a42-b88c-95a85e392c68\"\n ```\n\n - Search repositories:\n\ \n Searches for repositories matching the query across all hosts.\n\n ```yaml\n runnerId: \"d2c94c27-3b76-4a42-b88c-95a85e392c68\"\ \n searchString: \"my-project\"\n limit: 10\n ```" operationId: gitpod.v1.RunnerService.SearchRepositories parameters: [] requestBody: content: application/json: examples: list_all_repositories: description: Returns up to 25 repositories from all authenticated hosts. value: runnerId: d2c94c27-3b76-4a42-b88c-95a85e392c68 search_repositories: description: Searches for repositories matching the query across all hosts. value: limit: 10 runnerId: d2c94c27-3b76-4a42-b88c-95a85e392c68 searchString: my-project schema: $ref: '#/components/schemas/gitpod.v1.SearchRepositoriesRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.SearchRepositoriesResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: SearchRepositories tags: - gitpod.v1.RunnerService servers: [] /gitpod.v1.RunnerService/UpdateRunner: post: description: "Updates a runner's configuration.\n\n Use this method to:\n - Modify runner settings\n - Update release\ \ channels\n - Change runner status\n - Configure auto-update settings\n\n ### Examples\n\n - Update configuration:\n\ \n Changes runner settings.\n\n ```yaml\n runnerId: \"d2c94c27-3b76-4a42-b88c-95a85e392c68\"\n name: \"Updated\ \ Runner Name\"\n spec:\n configuration:\n releaseChannel: RUNNER_RELEASE_CHANNEL_LATEST\n autoUpdate:\ \ true\n ```" operationId: gitpod.v1.RunnerService.UpdateRunner parameters: [] requestBody: content: application/json: examples: update_configuration: description: Changes runner settings. value: name: Updated Runner Name runnerId: d2c94c27-3b76-4a42-b88c-95a85e392c68 spec: configuration: autoUpdate: true releaseChannel: RUNNER_RELEASE_CHANNEL_LATEST schema: $ref: '#/components/schemas/gitpod.v1.UpdateRunnerRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.UpdateRunnerResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: UpdateRunner tags: - gitpod.v1.RunnerService servers: [] /gitpod.v1.RunnerService/UpdateRunnerPolicy: post: description: "Updates an existing runner policy.\n\n Use this method to:\n - Modify access levels\n - Change group roles\n\ \ - Update permissions\n\n ### Examples\n\n - Update policy role:\n\n Changes a group's access level.\n\n ```yaml\n\ \ runnerId: \"d2c94c27-3b76-4a42-b88c-95a85e392c68\"\n groupId: \"f53d2330-3795-4c5d-a1f3-453121af9c60\"\n role:\ \ RUNNER_ROLE_USER\n ```" operationId: gitpod.v1.RunnerService.UpdateRunnerPolicy parameters: [] requestBody: content: application/json: examples: update_policy_role: description: Changes a group's access level. value: groupId: f53d2330-3795-4c5d-a1f3-453121af9c60 role: RUNNER_ROLE_USER runnerId: d2c94c27-3b76-4a42-b88c-95a85e392c68 schema: $ref: '#/components/schemas/gitpod.v1.UpdateRunnerPolicyRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.UpdateRunnerPolicyResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: UpdateRunnerPolicy tags: - gitpod.v1.RunnerService servers: [] /gitpod.v1.SecretService/CreateSecret: post: description: "Creates a new secret for a project.\n\n Use this method to:\n - Store sensitive configuration values\n\ \ - Set up environment variables\n - Configure registry authentication\n - Add file-based secrets\n\n ### Examples\n\ \n - Create environment variable:\n\n Creates a secret that will be available as an environment variable.\n\n \ \ ```yaml\n name: \"DATABASE_URL\"\n projectId: \"b0e12f6c-4c67-429d-a4a6-d9838b5da047\"\n value: \"postgresql://user:pass@localhost:5432/db\"\ \n environmentVariable: true\n ```\n\n - Create file secret:\n\n Creates a secret that will be mounted as a\ \ file.\n\n ```yaml\n name: \"SSH_KEY\"\n projectId: \"b0e12f6c-4c67-429d-a4a6-d9838b5da047\"\n value: \"\ -----BEGIN RSA PRIVATE KEY-----\\n...\"\n filePath: \"/home/gitpod/.ssh/id_rsa\"\n ```\n\n - Create registry auth:\n\ \n Creates credentials for private container registry.\n\n ```yaml\n name: \"DOCKER_AUTH\"\n projectId: \"\ b0e12f6c-4c67-429d-a4a6-d9838b5da047\"\n value: \"username:password\"\n containerRegistryBasicAuthHost: \"https://registry.example.com\"\ \n ```" operationId: gitpod.v1.SecretService.CreateSecret parameters: [] requestBody: content: application/json: examples: create_environment_variable: description: Creates a secret that will be available as an environment variable. value: environmentVariable: true name: DATABASE_URL projectId: b0e12f6c-4c67-429d-a4a6-d9838b5da047 value: postgresql://user:pass@localhost:5432/db create_file_secret: description: Creates a secret that will be mounted as a file. value: filePath: /home/gitpod/.ssh/id_rsa name: SSH_KEY projectId: b0e12f6c-4c67-429d-a4a6-d9838b5da047 value: '-----BEGIN RSA PRIVATE KEY----- ...' create_registry_auth: description: Creates credentials for private container registry. value: containerRegistryBasicAuthHost: https://registry.example.com name: DOCKER_AUTH projectId: b0e12f6c-4c67-429d-a4a6-d9838b5da047 value: username:password schema: $ref: '#/components/schemas/gitpod.v1.CreateSecretRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.CreateSecretResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: CreateSecret tags: - gitpod.v1.SecretService servers: [] /gitpod.v1.SecretService/DeleteSecret: post: description: "Deletes a secret permanently.\n\n Use this method to:\n - Remove unused secrets\n - Clean up old credentials\n\ \n ### Examples\n\n - Delete secret:\n\n Permanently removes a secret.\n\n ```yaml\n secretId: \"d2c94c27-3b76-4a42-b88c-95a85e392c68\"\ \n ```" operationId: gitpod.v1.SecretService.DeleteSecret parameters: [] requestBody: content: application/json: examples: delete_secret: description: Permanently removes a secret. value: secretId: d2c94c27-3b76-4a42-b88c-95a85e392c68 schema: $ref: '#/components/schemas/gitpod.v1.DeleteSecretRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.DeleteSecretResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: DeleteSecret tags: - gitpod.v1.SecretService servers: [] /gitpod.v1.SecretService/GetSecretValue: post: description: "Gets the value of a secret. Only available to environments that are authorized to access the secret.\n\ \n Use this method to:\n - Retrieve secret values\n - Access credentials\n\n ### Examples\n\n - Get secret value:\n\ \n Retrieves the value of a specific secret.\n\n ```yaml\n secretId: \"d2c94c27-3b76-4a42-b88c-95a85e392c68\"\ \n ```" operationId: gitpod.v1.SecretService.GetSecretValue parameters: [] requestBody: content: application/json: examples: get_secret_value: description: Retrieves the value of a specific secret. value: secretId: d2c94c27-3b76-4a42-b88c-95a85e392c68 schema: $ref: '#/components/schemas/gitpod.v1.GetSecretValueRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.GetSecretValueResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: GetSecretValue tags: - gitpod.v1.SecretService servers: [] /gitpod.v1.SecretService/ListSecrets: post: description: "Lists secrets\n\n Use this method to:\n - View all project secrets\n - View all user secrets\n\n ### Examples\n\ \n - List project secrets:\n\n Shows all secrets for a project.\n\n ```yaml\n filter:\n scope:\n projectId:\ \ \"b0e12f6c-4c67-429d-a4a6-d9838b5da047\"\n pagination:\n pageSize: 20\n ```\n\n - List user secrets:\n\n\ \ Shows all secrets for a user.\n\n ```yaml\n filter:\n scope:\n userId: \"123e4567-e89b-12d3-a456-426614174000\"\ \n pagination:\n pageSize: 20\n ```" operationId: gitpod.v1.SecretService.ListSecrets 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_project_secrets: description: Shows all secrets for a project. value: filter: scope: projectId: b0e12f6c-4c67-429d-a4a6-d9838b5da047 pagination: pageSize: 20 list_user_secrets: description: Shows all secrets for a user. value: filter: scope: userId: 123e4567-e89b-12d3-a456-426614174000 pagination: pageSize: 20 schema: $ref: '#/components/schemas/gitpod.v1.ListSecretsRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.ListSecretsResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: ListSecrets tags: - gitpod.v1.SecretService servers: [] /gitpod.v1.SecretService/UpdateSecretValue: post: description: "Updates the value of an existing secret.\n\n Use this method to:\n - Rotate secret values\n - Update credentials\n\ \n ### Examples\n\n - Update secret value:\n\n Changes the value of an existing secret.\n\n ```yaml\n secretId:\ \ \"d2c94c27-3b76-4a42-b88c-95a85e392c68\"\n value: \"new-secret-value\"\n ```" operationId: gitpod.v1.SecretService.UpdateSecretValue parameters: [] requestBody: content: application/json: examples: update_secret_value: description: Changes the value of an existing secret. value: secretId: d2c94c27-3b76-4a42-b88c-95a85e392c68 value: new-secret-value schema: $ref: '#/components/schemas/gitpod.v1.UpdateSecretValueRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.UpdateSecretValueResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: UpdateSecretValue tags: - gitpod.v1.SecretService servers: [] /gitpod.v1.ServiceAccountService/CreateServiceAccount: post: description: "Creates a new service account in an organization.\n\n Use this method to:\n - Create service accounts\ \ for automation\n - Set up CI/CD credentials\n - Configure programmatic access\n\n ### Examples\n\n - Create service\ \ account:\n\n Creates a service account for automation.\n\n ```yaml\n name: \"ci-pipeline\"\n description:\ \ \"CI/CD Pipeline\"\n validUntil: \"2025-12-31T23:59:59Z\"\n ```" operationId: gitpod.v1.ServiceAccountService.CreateServiceAccount parameters: [] requestBody: content: application/json: examples: create_service_account: description: Creates a service account for automation. value: description: CI/CD Pipeline name: ci-pipeline validUntil: '2025-12-31T23:59:59Z' schema: $ref: '#/components/schemas/gitpod.v1.CreateServiceAccountRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.CreateServiceAccountResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: CreateServiceAccount tags: - gitpod.v1.ServiceAccountService servers: [] /gitpod.v1.ServiceAccountService/CreateServiceAccountAccessToken: post: description: "Creates a short-lived access token for configuring a service account.\n\n The token expires after 30 minutes\ \ and can be used as a Bearer token\n in the Authorization header to perform operations on behalf of the\n service\ \ account, such as configuring OAuth.\n\n ### Examples\n\n - Create access token:\n\n ```yaml\n serviceAccountId:\ \ \"d2c94c27-3b76-4a42-b88c-95a85e392c68\"\n ```" operationId: gitpod.v1.ServiceAccountService.CreateServiceAccountAccessToken parameters: [] requestBody: content: application/json: examples: create_access_token: description: 'serviceAccountId: "d2c94c27-3b76-4a42-b88c-95a85e392c68" ' value: serviceAccountId: d2c94c27-3b76-4a42-b88c-95a85e392c68 schema: $ref: '#/components/schemas/gitpod.v1.CreateServiceAccountAccessTokenRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.CreateServiceAccountAccessTokenResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: CreateServiceAccountAccessToken tags: - gitpod.v1.ServiceAccountService servers: [] /gitpod.v1.ServiceAccountService/CreateServiceAccountToken: post: description: "Creates a long-lived token for a service account.\n\n Use this method to:\n - Create tokens for CI/CD\ \ pipelines\n - Set up automation credentials\n - Generate API access tokens\n\n The token is returned only once and\ \ cannot be retrieved later.\n Token validity is capped to the service account's expiry.\n\n Requires impersonation:\ \ First obtain a short-lived access token via\n CreateServiceAccountAccessToken, then use it to call this method.\n\ \ The service account ID is derived from the caller's identity.\n\n ### Examples\n\n - Create token with 90-day validity:\n\ \n ```yaml\n description: \"GitHub Actions\"\n validFor: \"7776000s\"\n ```" operationId: gitpod.v1.ServiceAccountService.CreateServiceAccountToken parameters: [] requestBody: content: application/json: examples: create_token_with_90_day_validity: description: 'description: "GitHub Actions" validFor: "7776000s" ' value: description: GitHub Actions validFor: 7776000s schema: $ref: '#/components/schemas/gitpod.v1.CreateServiceAccountTokenRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.CreateServiceAccountTokenResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: CreateServiceAccountToken tags: - gitpod.v1.ServiceAccountService servers: [] /gitpod.v1.ServiceAccountService/DeleteServiceAccount: post: description: "Deletes a service account.\n\n Use this method to:\n - Remove unused service accounts\n - Revoke service\ \ account access\n - Clean up expired accounts\n\n ### Examples\n\n - Delete service account:\n\n Permanently removes\ \ a service account.\n\n ```yaml\n serviceAccountId: \"d2c94c27-3b76-4a42-b88c-95a85e392c68\"\n ```" operationId: gitpod.v1.ServiceAccountService.DeleteServiceAccount parameters: [] requestBody: content: application/json: examples: delete_service_account: description: Permanently removes a service account. value: serviceAccountId: d2c94c27-3b76-4a42-b88c-95a85e392c68 schema: $ref: '#/components/schemas/gitpod.v1.DeleteServiceAccountRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.DeleteServiceAccountResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: DeleteServiceAccount tags: - gitpod.v1.ServiceAccountService servers: [] /gitpod.v1.ServiceAccountService/DeleteServiceAccountToken: post: description: "Deletes a service account token.\n\n Use this method to:\n - Revoke token access\n - Remove compromised\ \ tokens\n - Rotate credentials\n\n ### Examples\n\n - Delete token:\n\n ```yaml\n serviceAccountTokenId: \"d2c94c27-3b76-4a42-b88c-95a85e392c68\"\ \n ```" operationId: gitpod.v1.ServiceAccountService.DeleteServiceAccountToken parameters: [] requestBody: content: application/json: examples: delete_token: description: 'serviceAccountTokenId: "d2c94c27-3b76-4a42-b88c-95a85e392c68" ' value: serviceAccountTokenId: d2c94c27-3b76-4a42-b88c-95a85e392c68 schema: $ref: '#/components/schemas/gitpod.v1.DeleteServiceAccountTokenRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.DeleteServiceAccountTokenResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: DeleteServiceAccountToken tags: - gitpod.v1.ServiceAccountService servers: [] /gitpod.v1.ServiceAccountService/GetServiceAccount: post: description: "Gets details about a specific service account.\n\n Use this method to:\n - View service account details\n\ \ - Check service account status\n - Retrieve service account metadata\n\n ### Examples\n\n - Get service account:\n\ \n Retrieves details about a specific service account.\n\n ```yaml\n serviceAccountId: \"d2c94c27-3b76-4a42-b88c-95a85e392c68\"\ \n ```" operationId: gitpod.v1.ServiceAccountService.GetServiceAccount parameters: [] requestBody: content: application/json: examples: get_service_account: description: Retrieves details about a specific service account. value: serviceAccountId: d2c94c27-3b76-4a42-b88c-95a85e392c68 schema: $ref: '#/components/schemas/gitpod.v1.GetServiceAccountRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.GetServiceAccountResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: GetServiceAccount tags: - gitpod.v1.ServiceAccountService servers: [] /gitpod.v1.ServiceAccountService/GetServiceAccountToken: post: description: "Gets details about a specific service account token.\n\n Use this method to:\n - View token metadata\n\ \ - Check token expiration\n - Monitor token usage\n\n ### Examples\n\n - Get token details:\n\n ```yaml\n serviceAccountTokenId:\ \ \"d2c94c27-3b76-4a42-b88c-95a85e392c68\"\n ```" operationId: gitpod.v1.ServiceAccountService.GetServiceAccountToken parameters: [] requestBody: content: application/json: examples: get_token_details: description: 'serviceAccountTokenId: "d2c94c27-3b76-4a42-b88c-95a85e392c68" ' value: serviceAccountTokenId: d2c94c27-3b76-4a42-b88c-95a85e392c68 schema: $ref: '#/components/schemas/gitpod.v1.GetServiceAccountTokenRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.GetServiceAccountTokenResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: GetServiceAccountToken tags: - gitpod.v1.ServiceAccountService servers: [] /gitpod.v1.ServiceAccountService/ListServiceAccountTokens: post: description: "Lists tokens for a service account.\n\n Use this method to:\n - View all tokens for a service account\n\ \ - Audit token usage\n - Identify tokens to revoke\n\n Requires impersonation: First obtain a short-lived access\ \ token via\n CreateServiceAccountAccessToken, then use it to call this method.\n The service account ID is derived\ \ from the caller's identity.\n\n ### Examples\n\n - List tokens:\n\n ```yaml\n pagination:\n pageSize: 20\n\ \ ```" operationId: gitpod.v1.ServiceAccountService.ListServiceAccountTokens 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_tokens: description: "pagination:\n pageSize: 20\n" value: pagination: pageSize: 20 schema: $ref: '#/components/schemas/gitpod.v1.ListServiceAccountTokensRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.ListServiceAccountTokensResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: ListServiceAccountTokens tags: - gitpod.v1.ServiceAccountService servers: [] /gitpod.v1.ServiceAccountService/ListServiceAccounts: post: description: "Lists service accounts in an organization.\n\n Use this method to:\n - View all service accounts\n - Audit\ \ service account usage\n - Manage service account lifecycle\n\n ### Examples\n\n - List service accounts:\n\n Shows\ \ all service accounts in an organization.\n\n ```yaml\n pagination:\n pageSize: 20\n ```" operationId: gitpod.v1.ServiceAccountService.ListServiceAccounts 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_service_accounts: description: Shows all service accounts in an organization. value: pagination: pageSize: 20 schema: $ref: '#/components/schemas/gitpod.v1.ListServiceAccountsRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.ListServiceAccountsResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: ListServiceAccounts tags: - gitpod.v1.ServiceAccountService servers: [] /gitpod.v1.ServiceAccountService/UpdateServiceAccount: post: description: "Updates a service account.\n\n Use this method to:\n - Update service account name or description\n\n\ \ ### Examples\n\n - Update name and description:\n\n Updates the service account name and description.\n\n ```yaml\n\ \ serviceAccountId: \"d2c94c27-3b76-4a42-b88c-95a85e392c68\"\n name: \"updated-ci-pipeline\"\n description:\ \ \"Updated CI/CD Pipeline\"\n ```" operationId: gitpod.v1.ServiceAccountService.UpdateServiceAccount parameters: [] requestBody: content: application/json: examples: update_name_and_description: description: Updates the service account name and description. value: description: Updated CI/CD Pipeline name: updated-ci-pipeline serviceAccountId: d2c94c27-3b76-4a42-b88c-95a85e392c68 schema: $ref: '#/components/schemas/gitpod.v1.UpdateServiceAccountRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.UpdateServiceAccountResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: UpdateServiceAccount tags: - gitpod.v1.ServiceAccountService servers: [] /gitpod.v1.SessionService/AddSessionResource: post: operationId: gitpod.v1.SessionService.AddSessionResource parameters: [] requestBody: content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.AddSessionResourceRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.AddSessionResourceResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: AddSessionResource tags: - gitpod.v1.SessionService servers: [] /gitpod.v1.SessionService/CreateSession: post: operationId: gitpod.v1.SessionService.CreateSession parameters: [] requestBody: content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.CreateSessionRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.CreateSessionResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: CreateSession tags: - gitpod.v1.SessionService servers: [] /gitpod.v1.SessionService/DeleteSession: post: operationId: gitpod.v1.SessionService.DeleteSession parameters: [] requestBody: content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.DeleteSessionRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.DeleteSessionResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: DeleteSession tags: - gitpod.v1.SessionService servers: [] /gitpod.v1.SessionService/GetSession: post: operationId: gitpod.v1.SessionService.GetSession parameters: [] requestBody: content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.GetSessionRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.GetSessionResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: GetSession tags: - gitpod.v1.SessionService servers: [] /gitpod.v1.SessionService/ListSessionResources: post: operationId: gitpod.v1.SessionService.ListSessionResources 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.ListSessionResourcesRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.ListSessionResourcesResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: ListSessionResources tags: - gitpod.v1.SessionService servers: [] /gitpod.v1.SessionService/ListSessions: post: operationId: gitpod.v1.SessionService.ListSessions 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.ListSessionsRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.ListSessionsResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: ListSessions tags: - gitpod.v1.SessionService servers: [] /gitpod.v1.SessionService/RemoveSessionResource: post: operationId: gitpod.v1.SessionService.RemoveSessionResource parameters: [] requestBody: content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.RemoveSessionResourceRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.RemoveSessionResourceResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: RemoveSessionResource tags: - gitpod.v1.SessionService servers: [] /gitpod.v1.SessionService/UpdateSession: post: operationId: gitpod.v1.SessionService.UpdateSession parameters: [] requestBody: content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.UpdateSessionRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.UpdateSessionResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: UpdateSession tags: - gitpod.v1.SessionService servers: [] /gitpod.v1.SessionService/UpdateSessionResource: post: operationId: gitpod.v1.SessionService.UpdateSessionResource parameters: [] requestBody: content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.UpdateSessionResourceRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.UpdateSessionResourceResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: UpdateSessionResource tags: - gitpod.v1.SessionService servers: [] /gitpod.v1.TeamService/AddTeamMember: post: description: "Adds a user to a team.\n\n Each user can belong to at most one team per organization.\n\n Use this method\ \ to:\n - Assign users to teams\n\n ### Examples\n\n - Add a user to a team:\n\n ```yaml\n teamId: \"d2c94c27-3b76-4a42-b88c-95a85e392c68\"\ \n userId: \"f53d2330-3795-4c5d-a1f3-453121af9c60\"\n ```\n\n ### Authorization\n\n Requires `teammembership:create`\ \ permission on the team." operationId: gitpod.v1.TeamService.AddTeamMember parameters: [] requestBody: content: application/json: examples: add_a_user_to_a_team: description: 'teamId: "d2c94c27-3b76-4a42-b88c-95a85e392c68" userId: "f53d2330-3795-4c5d-a1f3-453121af9c60" ' value: teamId: d2c94c27-3b76-4a42-b88c-95a85e392c68 userId: f53d2330-3795-4c5d-a1f3-453121af9c60 schema: $ref: '#/components/schemas/gitpod.v1.AddTeamMemberRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.AddTeamMemberResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: AddTeamMember tags: - gitpod.v1.TeamService servers: [] /gitpod.v1.TeamService/CreateTeam: post: description: "Creates a new team within an organization.\n\n Use this method to:\n - Organize users into teams\n - Set\ \ up team-based workflows\n\n ### Examples\n\n - Create a team:\n\n ```yaml\n organizationId: \"b0e12f6c-4c67-429d-a4a6-d9838b5da047\"\ \n name: \"Backend Team\"\n ```\n\n ### Authorization\n\n Requires `team:create` permission on the organization." operationId: gitpod.v1.TeamService.CreateTeam parameters: [] requestBody: content: application/json: examples: create_a_team: description: 'organizationId: "b0e12f6c-4c67-429d-a4a6-d9838b5da047" name: "Backend Team" ' value: name: Backend Team organizationId: b0e12f6c-4c67-429d-a4a6-d9838b5da047 schema: $ref: '#/components/schemas/gitpod.v1.CreateTeamRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.CreateTeamResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: CreateTeam tags: - gitpod.v1.TeamService servers: [] /gitpod.v1.TeamService/DeleteTeam: post: description: "Deletes a team and all its memberships.\n\n Use this method to:\n - Remove unused teams\n - Clean up after\ \ team reorganization\n\n ### Examples\n\n - Delete a team:\n\n ```yaml\n teamId: \"d2c94c27-3b76-4a42-b88c-95a85e392c68\"\ \n ```\n\n ### Authorization\n\n Requires `team:delete` permission on the team." operationId: gitpod.v1.TeamService.DeleteTeam parameters: [] requestBody: content: application/json: examples: delete_a_team: description: 'teamId: "d2c94c27-3b76-4a42-b88c-95a85e392c68" ' value: teamId: d2c94c27-3b76-4a42-b88c-95a85e392c68 schema: $ref: '#/components/schemas/gitpod.v1.DeleteTeamRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.DeleteTeamResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: DeleteTeam tags: - gitpod.v1.TeamService servers: [] /gitpod.v1.TeamService/GetTeam: post: description: "Gets information about a specific team.\n\n Use this method to:\n - Retrieve team details and metadata\n\ \ - View member count\n\n ### Examples\n\n - Get team details:\n\n ```yaml\n teamId: \"d2c94c27-3b76-4a42-b88c-95a85e392c68\"\ \n ```\n\n ### Authorization\n\n Requires `team:read` permission on the team." operationId: gitpod.v1.TeamService.GetTeam parameters: [] requestBody: content: application/json: examples: get_team_details: description: 'teamId: "d2c94c27-3b76-4a42-b88c-95a85e392c68" ' value: teamId: d2c94c27-3b76-4a42-b88c-95a85e392c68 schema: $ref: '#/components/schemas/gitpod.v1.GetTeamRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.GetTeamResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: GetTeam tags: - gitpod.v1.TeamService servers: [] /gitpod.v1.TeamService/ListTeamMembers: post: description: "Lists members of a team with optional pagination.\n\n Use this method to:\n - View all members of a team\n\ \n ### Examples\n\n - List team members:\n\n ```yaml\n teamId: \"d2c94c27-3b76-4a42-b88c-95a85e392c68\"\n pagination:\n\ \ pageSize: 20\n ```\n\n ### Authorization\n\n Requires `teammembership:read` permission on the team." operationId: gitpod.v1.TeamService.ListTeamMembers 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_team_members: description: "teamId: \"d2c94c27-3b76-4a42-b88c-95a85e392c68\"\npagination:\n pageSize: 20\n" value: pagination: pageSize: 20 teamId: d2c94c27-3b76-4a42-b88c-95a85e392c68 schema: $ref: '#/components/schemas/gitpod.v1.ListTeamMembersRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.ListTeamMembersResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: ListTeamMembers tags: - gitpod.v1.TeamService servers: [] /gitpod.v1.TeamService/ListTeams: post: description: "Lists teams with optional pagination and filtering.\n\n Use this method to:\n - View all teams in an organization\n\ \ - Search for teams by name\n\n ### Examples\n\n - List all teams:\n\n ```yaml\n pagination:\n pageSize:\ \ 20\n ```\n\n - Search for teams by name:\n\n ```yaml\n pagination:\n pageSize: 20\n filter:\n search:\ \ \"backend\"\n ```\n\n ### Authorization\n\n Results are filtered by `team:read` permission." operationId: gitpod.v1.TeamService.ListTeams 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_all_teams: description: "pagination:\n pageSize: 20\n" value: pagination: pageSize: 20 search_for_teams_by_name: description: "pagination:\n pageSize: 20\nfilter:\n search: \"backend\"\n" value: filter: search: backend pagination: pageSize: 20 schema: $ref: '#/components/schemas/gitpod.v1.ListTeamsRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.ListTeamsResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: ListTeams tags: - gitpod.v1.TeamService servers: [] /gitpod.v1.TeamService/RemoveTeamMember: post: description: "Removes a user from a team.\n\n Use this method to:\n - Remove users from teams\n\n ### Examples\n\n -\ \ Remove a team member:\n\n ```yaml\n teamMemberId: \"a1b2c3d4-5678-90ab-cdef-1234567890ab\"\n ```\n\n ### Authorization\n\ \n Requires `teammembership:delete` permission on the team." operationId: gitpod.v1.TeamService.RemoveTeamMember parameters: [] requestBody: content: application/json: examples: remove_a_team_member: description: 'teamMemberId: "a1b2c3d4-5678-90ab-cdef-1234567890ab" ' value: teamMemberId: a1b2c3d4-5678-90ab-cdef-1234567890ab schema: $ref: '#/components/schemas/gitpod.v1.RemoveTeamMemberRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.RemoveTeamMemberResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: RemoveTeamMember tags: - gitpod.v1.TeamService servers: [] /gitpod.v1.TeamService/UpdateTeam: post: description: "Updates a team's properties.\n\n Use this method to:\n - Rename a team\n\n ### Examples\n\n - Update team\ \ name:\n\n ```yaml\n teamId: \"d2c94c27-3b76-4a42-b88c-95a85e392c68\"\n name: \"Platform Team\"\n ```\n\n\ \ ### Authorization\n\n Requires `team:update` permission on the team." operationId: gitpod.v1.TeamService.UpdateTeam parameters: [] requestBody: content: application/json: examples: update_team_name: description: 'teamId: "d2c94c27-3b76-4a42-b88c-95a85e392c68" name: "Platform Team" ' value: name: Platform Team teamId: d2c94c27-3b76-4a42-b88c-95a85e392c68 schema: $ref: '#/components/schemas/gitpod.v1.UpdateTeamRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.UpdateTeamResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: UpdateTeam tags: - gitpod.v1.TeamService servers: [] /gitpod.v1.UsageService/GetActiveEnvironmentsCount: post: description: Gets the count of active environments in the specified date range. operationId: gitpod.v1.UsageService.GetActiveEnvironmentsCount parameters: [] requestBody: content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.GetActiveEnvironmentsCountRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.GetActiveEnvironmentsCountResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: GetActiveEnvironmentsCount tags: - gitpod.v1.UsageService servers: [] /gitpod.v1.UsageService/GetActiveEnvironmentsTimeSeries: post: description: Gets the active environments time series in the specified date range, aggregated by the specified resolution. operationId: gitpod.v1.UsageService.GetActiveEnvironmentsTimeSeries parameters: [] requestBody: content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.GetActiveEnvironmentsTimeSeriesRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.GetActiveEnvironmentsTimeSeriesResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: GetActiveEnvironmentsTimeSeries tags: - gitpod.v1.UsageService servers: [] /gitpod.v1.UsageService/GetActiveUsersCount: post: description: "Gets the count of active users.\n\n Returns the count of unique users who were active within the specified\ \ date range." operationId: gitpod.v1.UsageService.GetActiveUsersCount parameters: [] requestBody: content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.GetActiveUsersCountRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.GetActiveUsersCountResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: GetActiveUsersCount tags: - gitpod.v1.UsageService servers: [] /gitpod.v1.UsageService/GetActiveUsersTimeSeries: post: description: "Gets active users time series in the specified date range, aggregated by the specified resolution.\n\n\ \ Returns a time series of active user counts within the specified date range, aggregated by the specified resolution.\n\ \ Each data point includes the timestamp and the count of unique users who were active at that time." operationId: gitpod.v1.UsageService.GetActiveUsersTimeSeries parameters: [] requestBody: content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.GetActiveUsersTimeSeriesRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.GetActiveUsersTimeSeriesResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: GetActiveUsersTimeSeries tags: - gitpod.v1.UsageService servers: [] /gitpod.v1.UsageService/GetAdoptionUsageSummary: post: description: "Gets a summary of adoption and usage metrics for the insight card.\n\n Returns all scalar values, trends,\ \ and a sparkline for the Adoption & Usage\n insight category. Designed for the Project Home page card and similar\ \ summary\n views. For full-resolution time series, use the individual time series RPCs." operationId: gitpod.v1.UsageService.GetAdoptionUsageSummary parameters: [] requestBody: content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.GetAdoptionUsageSummaryRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.GetAdoptionUsageSummaryResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: GetAdoptionUsageSummary tags: - gitpod.v1.UsageService servers: [] /gitpod.v1.UsageService/GetAgentTraceSummary: post: description: Gets aggregated agent trace summary for the organization or a specific project. operationId: gitpod.v1.UsageService.GetAgentTraceSummary parameters: [] requestBody: content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.GetAgentTraceSummaryRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.GetAgentTraceSummaryResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: GetAgentTraceSummary tags: - gitpod.v1.UsageService servers: [] /gitpod.v1.UsageService/GetAgentTraceTimeSeries: post: description: Gets agent trace data as a time series. operationId: gitpod.v1.UsageService.GetAgentTraceTimeSeries parameters: [] requestBody: content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.GetAgentTraceTimeSeriesRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.GetAgentTraceTimeSeriesResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: GetAgentTraceTimeSeries tags: - gitpod.v1.UsageService servers: [] /gitpod.v1.UsageService/GetCoAuthorSummary: post: description: Gets aggregated co-author summary for the organization or a specific project. operationId: gitpod.v1.UsageService.GetCoAuthorSummary parameters: [] requestBody: content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.GetCoAuthorSummaryRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.GetCoAuthorSummaryResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: GetCoAuthorSummary tags: - gitpod.v1.UsageService servers: [] /gitpod.v1.UsageService/GetCoAuthorTimeSeries: post: description: Gets co-author contribution data as a time series. operationId: gitpod.v1.UsageService.GetCoAuthorTimeSeries parameters: [] requestBody: content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.GetCoAuthorTimeSeriesRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.GetCoAuthorTimeSeriesResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: GetCoAuthorTimeSeries tags: - gitpod.v1.UsageService servers: [] /gitpod.v1.UsageService/GetEnvironmentRuntime: post: description: Gets the total runtime of all environments in the specified date range. operationId: gitpod.v1.UsageService.GetEnvironmentRuntime parameters: [] requestBody: content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.GetEnvironmentRuntimeRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.GetEnvironmentRuntimeResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: GetEnvironmentRuntime tags: - gitpod.v1.UsageService servers: [] /gitpod.v1.UsageService/GetEnvironmentRuntimeTimeSeries: post: description: Gets the total runtime time series in the specified date range, aggregated by the specified resolution. operationId: gitpod.v1.UsageService.GetEnvironmentRuntimeTimeSeries parameters: [] requestBody: content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.GetEnvironmentRuntimeTimeSeriesRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.GetEnvironmentRuntimeTimeSeriesResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: GetEnvironmentRuntimeTimeSeries tags: - gitpod.v1.UsageService servers: [] /gitpod.v1.UsageService/GetEnvironmentSessionsTimeSeries: post: description: "Gets the environment sessions time series in the specified date range, aggregated by the specified resolution.\n\ \n Environment sessions count total environment starts (environment.started events),\n as opposed to GetActiveEnvironmentsTimeSeries\ \ which counts distinct environment IDs." operationId: gitpod.v1.UsageService.GetEnvironmentSessionsTimeSeries parameters: [] requestBody: content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.GetEnvironmentSessionsTimeSeriesRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.GetEnvironmentSessionsTimeSeriesResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: GetEnvironmentSessionsTimeSeries tags: - gitpod.v1.UsageService servers: [] /gitpod.v1.UsageService/GetPrSummary: post: description: Gets aggregated PR speed summary for the organization or a specific project. operationId: gitpod.v1.UsageService.GetPrSummary parameters: [] requestBody: content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.GetPrSummaryRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.GetPrSummaryResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: GetPrSummary tags: - gitpod.v1.UsageService servers: [] /gitpod.v1.UsageService/GetPrTimeSeries: post: description: Gets PR speed metrics as a time series. operationId: gitpod.v1.UsageService.GetPrTimeSeries parameters: [] requestBody: content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.GetPrTimeSeriesRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.GetPrTimeSeriesResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: GetPrTimeSeries tags: - gitpod.v1.UsageService servers: [] /gitpod.v1.UsageService/GetTopActiveUsers: post: description: "Gets the top active users based on total runtime.\n\n Returns a list of users sorted by their total environment\ \ runtime within the specified date range.\n Each result includes the user ID, name (if available), and their total\ \ environment runtime in seconds." operationId: gitpod.v1.UsageService.GetTopActiveUsers parameters: [] requestBody: content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.GetTopActiveUsersRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.GetTopActiveUsersResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: GetTopActiveUsers tags: - gitpod.v1.UsageService servers: [] /gitpod.v1.UsageService/GetTopEnvironmentClasses: post: description: Gets the top environment classes by total runtime in the specified date range. operationId: gitpod.v1.UsageService.GetTopEnvironmentClasses parameters: [] requestBody: content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.GetTopEnvironmentClassesRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.GetTopEnvironmentClassesResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: GetTopEnvironmentClasses tags: - gitpod.v1.UsageService servers: [] /gitpod.v1.UsageService/GetTopProjects: post: description: Gets the top projects by total environment runtime in the specified date range. operationId: gitpod.v1.UsageService.GetTopProjects parameters: [] requestBody: content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.GetTopProjectsRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.GetTopProjectsResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: GetTopProjects tags: - gitpod.v1.UsageService servers: [] /gitpod.v1.UsageService/ListEnvironmentUsageRecords: post: description: "Lists completed environment runtime records within a specified date range.\n\n Returns a list of environment\ \ runtime records that were completed within the specified date range. Records of currently running environments are\ \ not included.\n\n Use this method to:\n - View environment runtime records\n - Filter by project\n - Create custom\ \ usage reports\n\n ### Example\n\n ```yaml\n filter:\n projectId: \"d2c94c27-3b76-4a42-b88c-95a85e392c68\"\n \ \ dateRange:\n startTime: \"2024-01-01T00:00:00Z\"\n endTime: \"2024-01-02T00:00:00Z\"\n pagination:\n pageSize:\ \ 100\n ```" operationId: gitpod.v1.UsageService.ListEnvironmentUsageRecords 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: create_custom_usage_reports: description: '' value: filter: dateRange: endTime: '2024-01-02T00:00:00Z' startTime: '2024-01-01T00:00:00Z' projectId: d2c94c27-3b76-4a42-b88c-95a85e392c68 pagination: pageSize: 100 schema: $ref: '#/components/schemas/gitpod.v1.ListEnvironmentUsageRecordsRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.ListEnvironmentUsageRecordsResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: ListEnvironmentUsageRecords tags: - gitpod.v1.UsageService servers: [] /gitpod.v1.UserService/CreatePersonalAccessToken: post: description: "Creates a new personal access token for API authentication.\n\n Use this method to:\n - Generate API access\ \ tokens\n - Create service account credentials\n - Set up automated access\n\n ### Examples\n\n - Create token:\n\ \n Creates a new access token valid for 30 days.\n\n ```yaml\n userId: \"f53d2330-3795-4c5d-a1f3-453121af9c60\"\ \n description: \"CI/CD Pipeline Token\"\n validFor: \"2592000s\" # 30 days\n ```" operationId: gitpod.v1.UserService.CreatePersonalAccessToken parameters: [] requestBody: content: application/json: examples: create_token: description: Creates a new access token valid for 30 days. value: description: CI/CD Pipeline Token userId: f53d2330-3795-4c5d-a1f3-453121af9c60 validFor: 2592000s schema: $ref: '#/components/schemas/gitpod.v1.CreatePersonalAccessTokenRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.CreatePersonalAccessTokenResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: CreatePersonalAccessToken tags: - gitpod.v1.UserService servers: [] /gitpod.v1.UserService/DeletePersonalAccessToken: post: description: "Deletes a personal access token.\n\n Use this method to:\n - Revoke token access\n - Remove unused tokens\n\ \ - Rotate credentials\n\n ### Examples\n\n - Delete token:\n\n Permanently revokes a token.\n\n ```yaml\n personalAccessTokenId:\ \ \"d2c94c27-3b76-4a42-b88c-95a85e392c68\"\n ```" operationId: gitpod.v1.UserService.DeletePersonalAccessToken parameters: [] requestBody: content: application/json: examples: delete_token: description: Permanently revokes a token. value: personalAccessTokenId: d2c94c27-3b76-4a42-b88c-95a85e392c68 schema: $ref: '#/components/schemas/gitpod.v1.DeletePersonalAccessTokenRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.DeletePersonalAccessTokenResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: DeletePersonalAccessToken tags: - gitpod.v1.UserService servers: [] /gitpod.v1.UserService/DeletePreference: post: description: "Deletes a user preference.\n\n Use this method to:\n - Remove settings\n - Reset preferences\n - Clean\ \ up configurations\n\n ### Examples\n\n - Delete preference:\n\n Removes a specific preference.\n\n ```yaml\n\ \ userPreferenceId: \"d2c94c27-3b76-4a42-b88c-95a85e392c68\"\n ```" operationId: gitpod.v1.UserService.DeletePreference parameters: [] requestBody: content: application/json: examples: delete_preference: description: Removes a specific preference. value: userPreferenceId: d2c94c27-3b76-4a42-b88c-95a85e392c68 schema: $ref: '#/components/schemas/gitpod.v1.DeletePreferenceRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.DeletePreferenceResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: DeletePreference tags: - gitpod.v1.UserService servers: [] /gitpod.v1.UserService/DeleteUser: post: description: Deletes a user. If the User comes from an organization's SSO provider, the Account will also be deleted. operationId: gitpod.v1.UserService.DeleteUser parameters: [] requestBody: content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.DeleteUserRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.DeleteUserResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: DeleteUser tags: - gitpod.v1.UserService servers: [] /gitpod.v1.UserService/GetAuthenticatedUser: post: description: "Gets information about the currently authenticated user.\n\n Use this method to:\n - Get user profile\ \ information\n - Check authentication status\n - Retrieve user settings\n - Verify account details\n\n ### Examples\n\ \n - Get current user:\n\n Retrieves details about the authenticated user.\n\n ```yaml\n {}\n ```" operationId: gitpod.v1.UserService.GetAuthenticatedUser parameters: [] requestBody: content: application/json: examples: get_current_user: description: Retrieves details about the authenticated user. value: {} schema: $ref: '#/components/schemas/gitpod.v1.GetAuthenticatedUserRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.GetAuthenticatedUserResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: GetAuthenticatedUser tags: - gitpod.v1.UserService servers: [] /gitpod.v1.UserService/GetDotfilesConfiguration: post: description: "Gets the dotfiles for a user.\n\n Use this method to:\n - Retrieve user dotfiles\n\n ### Examples\n\n\ \ - Get dotfiles:\n\n Retrieves the dotfiles for the current user.\n\n ```yaml\n {}\n ```" operationId: gitpod.v1.UserService.GetDotfilesConfiguration parameters: [] requestBody: content: application/json: examples: get_dotfiles: description: Retrieves the dotfiles for the current user. value: {} schema: $ref: '#/components/schemas/gitpod.v1.GetDotfilesConfigurationRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.GetDotfilesConfigurationResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: GetDotfilesConfiguration tags: - gitpod.v1.UserService servers: [] /gitpod.v1.UserService/GetPersonalAccessToken: post: description: "Gets details about a specific personal access token.\n\n Use this method to:\n - View token metadata\n\ \ - Check token expiration\n - Monitor token usage\n\n ### Examples\n\n - Get token details:\n\n Retrieves information\ \ about a specific token.\n\n ```yaml\n personalAccessTokenId: \"d2c94c27-3b76-4a42-b88c-95a85e392c68\"\n ```" operationId: gitpod.v1.UserService.GetPersonalAccessToken parameters: [] requestBody: content: application/json: examples: get_token_details: description: Retrieves information about a specific token. value: personalAccessTokenId: d2c94c27-3b76-4a42-b88c-95a85e392c68 schema: $ref: '#/components/schemas/gitpod.v1.GetPersonalAccessTokenRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.GetPersonalAccessTokenResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: GetPersonalAccessToken tags: - gitpod.v1.UserService servers: [] /gitpod.v1.UserService/GetPreference: post: description: "Gets a specific user preference value.\n\n Use this method to:\n - Retrieve user settings\n - Read preference\ \ values\n - Check configurations\n\n ### Examples\n\n - Get preference:\n\n Retrieves a specific preference value.\n\ \n ```yaml\n preferenceId: \"d2c94c27-3b76-4a42-b88c-95a85e392c68\"\n ```" operationId: gitpod.v1.UserService.GetPreference parameters: [] requestBody: content: application/json: examples: get_preference: description: Retrieves a specific preference value. value: preferenceId: d2c94c27-3b76-4a42-b88c-95a85e392c68 schema: $ref: '#/components/schemas/gitpod.v1.GetPreferenceRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.GetPreferenceResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: GetPreference tags: - gitpod.v1.UserService servers: [] /gitpod.v1.UserService/GetUser: post: description: "Gets basic information about a specific user by their ID.\n\n Use this method to:\n - Retrieve user profile\ \ information\n - Get user details for display purposes\n - Fetch user metadata for administrative tasks\n\n ### Examples\n\ \n - Get user by ID:\n\n Retrieves basic user information by user ID.\n\n ```yaml\n userId: \"f53d2330-3795-4c5d-a1f3-453121af9c60\"\ \n ```" operationId: gitpod.v1.UserService.GetUser parameters: [] requestBody: content: application/json: examples: get_user_by_id: description: Retrieves basic user information by user ID. value: userId: f53d2330-3795-4c5d-a1f3-453121af9c60 schema: $ref: '#/components/schemas/gitpod.v1.GetUserRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.GetUserResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: GetUser tags: - gitpod.v1.UserService servers: [] /gitpod.v1.UserService/ListPersonalAccessTokens: post: description: "Lists personal access tokens with optional filtering.\n\n Use this method to:\n - View all active tokens\n\ \ - Audit token usage\n - Manage token lifecycle\n\n ### Examples\n\n - List user tokens:\n\n Shows all tokens for\ \ specific users.\n\n ```yaml\n filter:\n userIds: [\"f53d2330-3795-4c5d-a1f3-453121af9c60\"]\n pagination:\n\ \ pageSize: 20\n ```" operationId: gitpod.v1.UserService.ListPersonalAccessTokens 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_user_tokens: description: Shows all tokens for specific users. value: filter: userIds: - f53d2330-3795-4c5d-a1f3-453121af9c60 pagination: pageSize: 20 schema: $ref: '#/components/schemas/gitpod.v1.ListPersonalAccessTokensRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.ListPersonalAccessTokensResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: ListPersonalAccessTokens tags: - gitpod.v1.UserService servers: [] /gitpod.v1.UserService/ListPreferences: post: description: "Lists all user preferences.\n\n Use this method to:\n - View all user settings\n - Export preferences\n\ \ - Audit configurations\n\n ### Examples\n\n - List preferences:\n\n Shows all preferences with pagination.\n\n\ \ ```yaml\n pagination:\n pageSize: 20\n ```" operationId: gitpod.v1.UserService.ListPreferences 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_preferences: description: Shows all preferences with pagination. value: pagination: pageSize: 20 schema: $ref: '#/components/schemas/gitpod.v1.ListPreferencesRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.ListPreferencesResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: ListPreferences tags: - gitpod.v1.UserService servers: [] /gitpod.v1.UserService/SetDotfilesConfiguration: post: description: "Sets the dotfiles configuration for a user.\n\n Use this method to:\n - Configure user dotfiles\n - Update\ \ dotfiles settings\n\n ### Examples\n\n - Set dotfiles configuration:\n\n Sets the dotfiles configuration for the\ \ current user.\n\n ```yaml\n {\n \"repository\": \"https://github.com/gitpod-io/dotfiles\",\n }\n ```\n\ \n - Remove dotfiles:\n\n Removes the dotfiles for the current user.\n\n ```yaml\n {}\n ```" operationId: gitpod.v1.UserService.SetDotfilesConfiguration parameters: [] requestBody: content: application/json: examples: remove_dotfiles: description: Removes the dotfiles for the current user. value: {} set_dotfiles_configuration: description: Sets the dotfiles configuration for the current user. value: repository: https://github.com/gitpod-io/dotfiles schema: $ref: '#/components/schemas/gitpod.v1.SetDotfilesConfigurationRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.SetDotfilesConfigurationResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: SetDotfilesConfiguration tags: - gitpod.v1.UserService servers: [] /gitpod.v1.UserService/SetPreference: post: description: "Sets a user preference value.\n\n Use this method to:\n - Store user settings\n - Update preferences\n\ \ - Configure user experience\n\n ### Examples\n\n - Set preference:\n\n Updates a user preference setting.\n\n\ \ ```yaml\n key: \"theme\"\n value: \"dark\"\n ```" operationId: gitpod.v1.UserService.SetPreference parameters: [] requestBody: content: application/json: examples: set_preference: description: Updates a user preference setting. value: key: theme value: dark schema: $ref: '#/components/schemas/gitpod.v1.SetPreferenceRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.SetPreferenceResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: SetPreference tags: - gitpod.v1.UserService servers: [] /gitpod.v1.UserService/SetSuspended: post: description: "Sets whether a user account is suspended.\n\n Use this method to:\n - Suspend problematic users\n - Reactivate\ \ suspended accounts\n - Manage user access\n\n ### Examples\n\n - Suspend user:\n\n Suspends a user account.\n\n\ \ ```yaml\n userId: \"f53d2330-3795-4c5d-a1f3-453121af9c60\"\n suspended: true\n ```\n\n - Reactivate user:\n\ \n Removes suspension from a user account.\n\n ```yaml\n userId: \"f53d2330-3795-4c5d-a1f3-453121af9c60\"\n\ \ suspended: false\n ```" operationId: gitpod.v1.UserService.SetSuspended parameters: [] requestBody: content: application/json: examples: reactivate_user: description: Removes suspension from a user account. value: suspended: false userId: f53d2330-3795-4c5d-a1f3-453121af9c60 suspend_user: description: Suspends a user account. value: suspended: true userId: f53d2330-3795-4c5d-a1f3-453121af9c60 schema: $ref: '#/components/schemas/gitpod.v1.SetSuspendedRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.SetSuspendedResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: SetSuspended tags: - gitpod.v1.UserService servers: [] /gitpod.v1.WebhookService/CreateWebhook: post: description: "Creates a new webhook for receiving SCM events.\n\n Use this method to:\n - Set up webhooks for repository\ \ or organization events\n - Configure webhook scopes and provider\n\n ### Examples\n\n - Create repository webhook\ \ with multiple scopes:\n\n Creates a webhook scoped to specific repositories.\n\n ```yaml\n name: \"My Repo\ \ Webhook\"\n type: WEBHOOK_TYPE_SCM_REPOSITORY\n scopes:\n - host: \"github.com\"\n owner: \"gitpod-io\"\ \n name: \"gitpod\"\n - host: \"github.com\"\n owner: \"gitpod-io\"\n name: \"gitpod-next\"\n\ \ provider: WEBHOOK_PROVIDER_GITHUB\n ```\n\n - Create organization webhook:\n\n Creates a webhook scoped to\ \ all repositories in an organization.\n\n ```yaml\n name: \"Org Webhook\"\n type: WEBHOOK_TYPE_SCM_ORGANIZATION\n\ \ organizationScope:\n host: \"github.com\"\n name: \"gitpod-io\"\n provider: WEBHOOK_PROVIDER_GITHUB\n\ \ ```" operationId: gitpod.v1.WebhookService.CreateWebhook parameters: [] requestBody: content: application/json: examples: create_organization_webhook: description: Creates a webhook scoped to all repositories in an organization. value: name: Org Webhook organizationScope: host: github.com name: gitpod-io provider: WEBHOOK_PROVIDER_GITHUB type: WEBHOOK_TYPE_SCM_ORGANIZATION create_repository_webhook_with_multiple_scopes: description: Creates a webhook scoped to specific repositories. value: name: My Repo Webhook provider: WEBHOOK_PROVIDER_GITHUB scopes: - host: github.com name: gitpod owner: gitpod-io - host: github.com name: gitpod-next owner: gitpod-io type: WEBHOOK_TYPE_SCM_REPOSITORY schema: $ref: '#/components/schemas/gitpod.v1.CreateWebhookRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.CreateWebhookResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: CreateWebhook tags: - gitpod.v1.WebhookService servers: [] /gitpod.v1.WebhookService/DeleteWebhook: post: description: "Deletes a webhook permanently.\n\n Use this method to:\n - Remove unused webhooks\n - Clean up webhook\ \ configurations\n\n ### Examples\n\n - Delete webhook:\n\n Permanently removes a webhook.\n\n ```yaml\n webhookId:\ \ \"b0e12f6c-4c67-429d-a4a6-d9838b5da047\"\n ```" operationId: gitpod.v1.WebhookService.DeleteWebhook parameters: [] requestBody: content: application/json: examples: delete_webhook: description: Permanently removes a webhook. value: webhookId: b0e12f6c-4c67-429d-a4a6-d9838b5da047 schema: $ref: '#/components/schemas/gitpod.v1.DeleteWebhookRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.DeleteWebhookResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: DeleteWebhook tags: - gitpod.v1.WebhookService servers: [] /gitpod.v1.WebhookService/GetWebhook: post: description: "Gets details about a specific webhook.\n\n Use this method to:\n - View webhook configuration\n - Check\ \ webhook URL\n - See bound workflow count\n\n ### Examples\n\n - Get webhook details:\n\n Retrieves information\ \ about a specific webhook.\n\n ```yaml\n webhookId: \"b0e12f6c-4c67-429d-a4a6-d9838b5da047\"\n ```" operationId: gitpod.v1.WebhookService.GetWebhook parameters: [] requestBody: content: application/json: examples: get_webhook_details: description: Retrieves information about a specific webhook. value: webhookId: b0e12f6c-4c67-429d-a4a6-d9838b5da047 schema: $ref: '#/components/schemas/gitpod.v1.GetWebhookRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.GetWebhookResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: GetWebhook tags: - gitpod.v1.WebhookService servers: [] /gitpod.v1.WebhookService/GetWebhookSecret: post: description: "Gets the webhook secret for signature validation.\n\n This operation is audited for security purposes.\n\ \n Use this method to:\n - Retrieve webhook secret for SCM configuration\n - Verify webhook signatures\n\n ### Examples\n\ \n - Get webhook secret:\n\n Retrieves the webhook secret.\n\n ```yaml\n webhookId: \"b0e12f6c-4c67-429d-a4a6-d9838b5da047\"\ \n ```" operationId: gitpod.v1.WebhookService.GetWebhookSecret parameters: [] requestBody: content: application/json: examples: get_webhook_secret: description: Retrieves the webhook secret. value: webhookId: b0e12f6c-4c67-429d-a4a6-d9838b5da047 schema: $ref: '#/components/schemas/gitpod.v1.GetWebhookSecretRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.GetWebhookSecretResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: GetWebhookSecret tags: - gitpod.v1.WebhookService servers: [] /gitpod.v1.WebhookService/ListWebhookWorkflows: post: description: "Lists workflows bound to a webhook.\n\n Use this method to:\n - View all workflows triggered by a webhook\n\ \ - Check workflow bindings\n\n ### Examples\n\n - List webhook workflows:\n\n Shows all workflows bound to a webhook.\n\ \n ```yaml\n webhookId: \"b0e12f6c-4c67-429d-a4a6-d9838b5da047\"\n pagination:\n pageSize: 20\n ```" operationId: gitpod.v1.WebhookService.ListWebhookWorkflows 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_webhook_workflows: description: Shows all workflows bound to a webhook. value: pagination: pageSize: 20 webhookId: b0e12f6c-4c67-429d-a4a6-d9838b5da047 schema: $ref: '#/components/schemas/gitpod.v1.ListWebhookWorkflowsRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.ListWebhookWorkflowsResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: ListWebhookWorkflows tags: - gitpod.v1.WebhookService servers: [] /gitpod.v1.WebhookService/ListWebhooks: post: description: "Lists webhooks with optional filtering.\n\n Use this method to:\n - View all webhooks in an organization\n\ \ - Filter webhooks by type or provider\n\n ### Examples\n\n - List all webhooks:\n\n Shows all webhooks with pagination.\n\ \n ```yaml\n pagination:\n pageSize: 20\n ```" operationId: gitpod.v1.WebhookService.ListWebhooks 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_all_webhooks: description: Shows all webhooks with pagination. value: pagination: pageSize: 20 schema: $ref: '#/components/schemas/gitpod.v1.ListWebhooksRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.ListWebhooksResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: ListWebhooks tags: - gitpod.v1.WebhookService servers: [] /gitpod.v1.WebhookService/RotateWebhookSecret: post: description: "Rotates the webhook secret.\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.\n\n ```yaml\n\ \ webhookId: \"b0e12f6c-4c67-429d-a4a6-d9838b5da047\"\n ```" operationId: gitpod.v1.WebhookService.RotateWebhookSecret parameters: [] requestBody: content: application/json: examples: rotate_webhook_secret: description: Generates a new webhook secret. value: webhookId: b0e12f6c-4c67-429d-a4a6-d9838b5da047 schema: $ref: '#/components/schemas/gitpod.v1.RotateWebhookSecretRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.RotateWebhookSecretResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: RotateWebhookSecret tags: - gitpod.v1.WebhookService servers: [] /gitpod.v1.WebhookService/UpdateWebhook: post: description: "Updates a webhook's configuration.\n\n Use this method to:\n - Change webhook name or description\n -\ \ Change webhook scopes (the target repositories or organization)\n\n Note: The webhook type and provider cannot be\ \ changed after creation.\n\n ### Examples\n\n - Update webhook name:\n\n Changes the webhook's display name.\n\n\ \ ```yaml\n webhookId: \"b0e12f6c-4c67-429d-a4a6-d9838b5da047\"\n name: \"Updated Webhook Name\"\n ```\n\n\ \ - Update webhook scopes:\n\n Changes the webhook's target repositories.\n\n ```yaml\n webhookId: \"b0e12f6c-4c67-429d-a4a6-d9838b5da047\"\ \n scopes:\n - host: \"github.com\"\n owner: \"gitpod-io\"\n name: \"new-repo\"\n ```" operationId: gitpod.v1.WebhookService.UpdateWebhook parameters: [] requestBody: content: application/json: examples: update_webhook_name: description: Changes the webhook's display name. value: name: Updated Webhook Name webhookId: b0e12f6c-4c67-429d-a4a6-d9838b5da047 update_webhook_scopes: description: Changes the webhook's target repositories. value: scopes: - host: github.com name: new-repo owner: gitpod-io webhookId: b0e12f6c-4c67-429d-a4a6-d9838b5da047 schema: $ref: '#/components/schemas/gitpod.v1.UpdateWebhookRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/gitpod.v1.UpdateWebhookResponse' description: Success default: content: application/json: schema: $ref: '#/components/schemas/connect.error' description: Error security: - bearerAuth: [] summary: UpdateWebhook tags: - gitpod.v1.WebhookService servers: [] /gitpod.v1.WorkflowService/CancelWorkflowExecution: 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 servers: [] /gitpod.v1.WorkflowService/CancelWorkflowExecutionAction: 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 servers: [] /gitpod.v1.WorkflowService/CreateWorkflow: 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 servers: [] /gitpod.v1.WorkflowService/DeleteWorkflow: 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 servers: [] /gitpod.v1.WorkflowService/GetWorkflow: 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 servers: [] /gitpod.v1.WorkflowService/GetWorkflowExecution: 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 servers: [] /gitpod.v1.WorkflowService/GetWorkflowExecutionAction: 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 servers: [] /gitpod.v1.WorkflowService/GetWorkflowExecutionSummary: 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 servers: [] /gitpod.v1.WorkflowService/GetWorkflowWebhookSecret: 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 servers: [] /gitpod.v1.WorkflowService/ListWorkflowExecutionActions: 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 servers: [] /gitpod.v1.WorkflowService/ListWorkflowExecutionOutputs: 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 servers: [] /gitpod.v1.WorkflowService/ListWorkflowExecutions: 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 servers: [] /gitpod.v1.WorkflowService/ListWorkflows: 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 servers: [] /gitpod.v1.WorkflowService/RotateWorkflowWebhookSecret: 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 servers: [] /gitpod.v1.WorkflowService/StartWorkflow: 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 servers: [] /gitpod.v1.WorkflowService/UpdateWorkflow: 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 servers: [] components: schemas: connect-protocol-version: description: Define the version of the Connect protocol enum: - 1 title: Connect-Protocol-Version type: number connect-timeout-header: description: Define the timeout, in ms title: Connect-Timeout-Ms type: number connect.error: additionalProperties: true description: 'Error type returned by Connect: https://connectrpc.com/docs/go/errors/#http-representation' properties: code: description: The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code]. enum: - canceled - unknown - invalid_argument - deadline_exceeded - not_found - already_exists - permission_denied - resource_exhausted - failed_precondition - aborted - out_of_range - unimplemented - internal - unavailable - data_loss - unauthenticated example: - not_found type: string message: description: A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client. type: string title: Connect Error type: object gitpod.v1.Account: additionalProperties: false properties: avatarUrl: title: avatar_url type: string createdAt: $ref: '#/components/schemas/google.protobuf.Timestamp' title: created_at email: title: email type: string id: format: uuid title: id type: string joinables: deprecated: true description: joinables is deprecated. Use ListJoinableOrganizations instead. items: $ref: '#/components/schemas/gitpod.v1.JoinableOrganization' title: joinables type: array memberships: items: $ref: '#/components/schemas/gitpod.v1.AccountMembership' title: memberships type: array name: title: name type: string organizationId: description: organization_id is the ID of the organization the account is owned by if it's created through custom SSO nullable: true title: organization_id type: string publicEmailProvider: description: public_email_provider is true if the email for the Account matches a known public email provider title: public_email_provider type: boolean updatedAt: $ref: '#/components/schemas/google.protobuf.Timestamp' title: updated_at required: - id - name - email - createdAt - updatedAt title: Account type: object gitpod.v1.AccountMembership: additionalProperties: false properties: organizationId: description: organization_id is the id of the organization the user is a member of format: uuid title: organization_id type: string organizationMemberCount: description: organization_member_count is the member count of the organization the user is a member of format: int32 title: organization_member_count type: integer organizationName: description: organization_name is the name of the organization the user is a member of title: organization_name type: string organizationTier: $ref: '#/components/schemas/gitpod.v1.OrganizationTier' description: organization_tier is the tier of the organization (Free, Core, Enterprise) title: organization_tier userId: description: user_id is the ID the user has in the organization format: uuid title: user_id type: string userRole: $ref: '#/components/schemas/gitpod.v1.OrganizationRole' description: user_role is the role the user has in the organization title: user_role required: - userId - userRole - organizationId - organizationName title: AccountMembership type: object gitpod.v1.ActionableErrorDetails: additionalProperties: false description: "ActionableErrorDetails provides structured error information that can be\n attached to any Connect RPC\ \ error via err.AddDetail(). The frontend uses\n this to render actionable UI (buttons, links, guidance) instead of\ \ raw\n error strings.\n\n This is a standalone detail message — it does not modify the environment\n status proto\ \ or any existing message. It follows the same pattern as\n ParseContextURLPreconditionFailureDetails and PolicyEnforcedFailedPreconditionDetails." properties: actions: description: Actions the user can take to resolve the error. items: $ref: '#/components/schemas/gitpod.v1.ErrorAction' title: actions type: array errorCode: description: "Machine-readable error code for programmatic handling.\n Convention: COMPONENT_CATEGORY_SPECIFIC (e.g.\ \ CONTENT_GIT_ACCESS_DENIED)." title: error_code type: string metadata: additionalProperties: title: value type: string description: "Domain-specific metadata relevant to this error type.\n Keys are domain-specific (e.g. \"git_host\"\ , \"repository_url\", \"policy_name\")." title: metadata type: object userMessage: description: Human-readable message for end-users, replacing the raw error string. title: user_message type: string title: ActionableErrorDetails type: object gitpod.v1.ActionableErrorDetails.MetadataEntry: additionalProperties: false properties: key: title: key type: string value: title: value type: string title: MetadataEntry type: object gitpod.v1.AddSessionResourceRequest: additionalProperties: false properties: description: title: description type: string kind: $ref: '#/components/schemas/gitpod.v1.SessionResourceKind' title: kind role: $ref: '#/components/schemas/gitpod.v1.SessionResourceRole' title: role sessionId: format: uuid title: session_id type: string title: title: title type: string url: title: url type: string title: AddSessionResourceRequest type: object gitpod.v1.AddSessionResourceResponse: additionalProperties: false properties: resource: $ref: '#/components/schemas/gitpod.v1.SessionResource' title: resource title: AddSessionResourceResponse type: object gitpod.v1.AddTeamMemberRequest: additionalProperties: false properties: teamId: format: uuid title: team_id type: string userId: format: uuid title: user_id type: string title: AddTeamMemberRequest type: object gitpod.v1.AddTeamMemberResponse: additionalProperties: false properties: member: $ref: '#/components/schemas/gitpod.v1.TeamMember' title: member title: AddTeamMemberResponse type: object gitpod.v1.AdditionalScopesUpdate: additionalProperties: false description: "AdditionalScopesUpdate wraps a list of OIDC scopes so that the update request\n can distinguish \"not\ \ changing scopes\" (field absent) from \"clearing all scopes\"\n (field present, empty list)." properties: scopes: items: maxItems: 100 maxLength: 128 minLength: 1 type: string maxItems: 100 title: scopes type: array title: AdditionalScopesUpdate type: object gitpod.v1.AdmissionLevel: description: Admission level describes who can access an environment instance and its ports. enum: - ADMISSION_LEVEL_UNSPECIFIED - ADMISSION_LEVEL_OWNER_ONLY - ADMISSION_LEVEL_EVERYONE - ADMISSION_LEVEL_ORGANIZATION - ADMISSION_LEVEL_CREATOR_ONLY title: AdmissionLevel type: string gitpod.v1.Agent: additionalProperties: false oneOf: - not: anyOf: - required: - runnerSide required: - inEnvironment - not: anyOf: - required: - inEnvironment required: - runnerSide properties: id: title: id type: string inEnvironment: $ref: '#/components/schemas/gitpod.v1.InEnvironmentAgentSpec' title: in_environment metadata: $ref: '#/components/schemas/gitpod.v1.AgentMetadata' title: metadata runnerSide: $ref: '#/components/schemas/gitpod.v1.RunnerSideAgentSpec' title: runner_side spec: $ref: '#/components/schemas/gitpod.v1.RunnerSideAgentSpec' deprecated: true title: spec title: Agent type: object gitpod.v1.AgentCodeContext: additionalProperties: false oneOf: - not: anyOf: - required: - environmentId - required: - projectId required: - contextUrl - not: anyOf: - required: - contextUrl - required: - projectId required: - environmentId - not: anyOf: - required: - contextUrl - required: - environmentId required: - projectId properties: contextUrl: $ref: '#/components/schemas/gitpod.v1.AgentCodeContext.ContextURL' title: context_url environmentId: format: uuid title: environment_id type: string projectId: format: uuid title: project_id type: string pullRequest: $ref: '#/components/schemas/gitpod.v1.PullRequest' description: "Pull request context - optional metadata about the PR being worked on\n This is populated when the\ \ agent execution is triggered by a PR workflow\n or when explicitly provided through the browser extension" nullable: true title: pull_request title: AgentCodeContext type: object gitpod.v1.AgentCodeContext.ContextURL: additionalProperties: false properties: environmentClassId: format: uuid title: environment_class_id type: string url: format: uri title: url type: string title: ContextURL type: object gitpod.v1.AgentExecution: additionalProperties: false properties: id: description: "ID is a unique identifier of this agent run. No other agent run with the\n same name must be managed\ \ by this agent manager" title: id type: string metadata: $ref: '#/components/schemas/gitpod.v1.AgentExecution.Metadata' description: "Metadata is data associated with this agent that's required for other\n parts of Gitpod to function" title: metadata spec: $ref: '#/components/schemas/gitpod.v1.AgentExecution.Spec' description: "Spec is the configuration of the agent that's required for the\n runner to start the agent" title: spec status: $ref: '#/components/schemas/gitpod.v1.AgentExecution.Status' description: Status is the current status of the agent title: status title: AgentExecution type: object gitpod.v1.AgentExecution.Metadata: additionalProperties: false properties: annotations: additionalProperties: title: value type: string description: annotations are key-value pairs for tracking external context. title: annotations type: object createdAt: $ref: '#/components/schemas/google.protobuf.Timestamp' title: created_at creator: $ref: '#/components/schemas/gitpod.v1.Subject' title: creator description: title: description type: string name: title: name type: string role: $ref: '#/components/schemas/gitpod.v1.AgentExecutionRole' description: role is the role of the agent execution title: role sessionId: description: session_id is the ID of the session this agent execution belongs to. title: session_id type: string x-stainless-skip: true updatedAt: $ref: '#/components/schemas/google.protobuf.Timestamp' title: updated_at workflowActionId: description: "workflow_action_id is set when this agent execution was created as part of a workflow.\n Used to correlate\ \ agent executions with their parent workflow execution action." format: uuid nullable: true title: workflow_action_id type: string title: Metadata type: object gitpod.v1.AgentExecution.Metadata.AnnotationsEntry: additionalProperties: false properties: key: title: key type: string value: title: value type: string title: AnnotationsEntry type: object gitpod.v1.AgentExecution.Phase: enum: - PHASE_UNSPECIFIED - PHASE_PENDING - PHASE_RUNNING - PHASE_WAITING_FOR_INPUT - PHASE_STOPPED title: Phase type: string gitpod.v1.AgentExecution.Spec: additionalProperties: false properties: agentId: format: uuid title: agent_id type: string codeContext: $ref: '#/components/schemas/gitpod.v1.AgentCodeContext' title: code_context desiredPhase: $ref: '#/components/schemas/gitpod.v1.AgentExecution.Phase' description: desired_phase is the desired phase of the agent run title: desired_phase limits: $ref: '#/components/schemas/gitpod.v1.AgentExecution.Spec.Limits' title: limits loopConditions: items: $ref: '#/components/schemas/gitpod.v1.AgentExecution.Spec.LoopCondition' maxItems: 10 title: loop_conditions type: array session: title: session type: string specVersion: description: "version of the spec. The value of this field has no semantic\n meaning (e.g. don't interpret it as\ \ as a timestamp),\n but it can be used to impose a partial order. If a.spec_version <\n b.spec_version then a\ \ was the spec before b." title: spec_version type: string title: Spec type: object gitpod.v1.AgentExecution.Spec.Limits: additionalProperties: false properties: maxInputTokens: title: max_input_tokens type: string maxIterations: title: max_iterations type: string maxOutputTokens: title: max_output_tokens type: string title: Limits type: object gitpod.v1.AgentExecution.Spec.LoopCondition: additionalProperties: false properties: description: title: description type: string expression: title: expression type: string id: title: id type: string title: LoopCondition type: object gitpod.v1.AgentExecution.Status: additionalProperties: false properties: cachedCreationTokensUsed: title: cached_creation_tokens_used type: string cachedInputTokensUsed: title: cached_input_tokens_used type: string contextWindowLength: title: context_window_length type: string conversationUrl: description: conversation_url is the URL to the conversation (all messages exchanged between the agent and the user) of the agent run. title: conversation_url type: string currentActivity: description: current_activity is the current activity description of the agent execution. title: current_activity type: string currentOperation: $ref: '#/components/schemas/gitpod.v1.AgentExecution.Status.CurrentOperation' description: current_operation is the current operation of the agent execution. title: current_operation failureMessage: description: failure_message contains the reason the agent run failed to operate. title: failure_message type: string failureReason: $ref: '#/components/schemas/gitpod.v1.AgentExecutionFailureReason' description: failure_reason contains a structured reason code for the failure. title: failure_reason inputTokensUsed: title: input_tokens_used type: string iterations: title: iterations type: string judgement: description: judgement is the judgement of the agent run produced by the judgement prompt. title: judgement type: string loopConditionResults: items: $ref: '#/components/schemas/gitpod.v1.AgentExecution.Status.LoopConditionResult' title: loop_condition_results type: array x-stainless-skip: true mcpIntegrationStatuses: description: mcp_integration_statuses contains the status of all MCP integrations used by this agent execution items: $ref: '#/components/schemas/gitpod.v1.AgentExecution.Status.MCPIntegrationStatus' title: mcp_integration_statuses type: array mode: $ref: '#/components/schemas/gitpod.v1.AgentMode' description: "mode is the current operational mode of the agent execution.\n This is set by the agent when entering\ \ different modes (e.g., Ralph mode via /ona:ralph command)." title: mode outputTokensUsed: title: output_tokens_used type: string outputs: additionalProperties: $ref: '#/components/schemas/gitpod.v1.AgentExecution.Status.OutputValue' title: value description: "outputs is a map of key-value pairs that can be set by the agent during execution.\n Similar to task\ \ execution outputs, but with typed values for structured data." title: outputs type: object phase: $ref: '#/components/schemas/gitpod.v1.AgentExecution.Phase' title: phase session: title: session type: string statusVersion: description: "version of the status. The value of this field has no semantic\n meaning (e.g. don't interpret it\ \ as as a timestamp),\n but it can be used to impose a partial order. If a.status_version <\n b.status_version\ \ then a was the status before b." title: status_version type: string supportBundleUrl: description: support_bundle_url is the URL to download a diagnostic bundle for this agent execution. title: support_bundle_url type: string x-stainless-skip: true supportedModel: $ref: '#/components/schemas/gitpod.v1.SupportedModel' description: supported_model is the LLM model being used by the agent execution. title: supported_model terminalId: description: 'terminal_id is the ID of the terminal running the agent, if the agent runs as a terminal service (runsOn: terminal).' title: terminal_id type: string x-stainless-skip: true transcriptUrl: description: transcript_url is the URL to the LLM transcript (all messages exchanged between the agent and the LLM) of the agent run. title: transcript_url type: string usedEnvironments: description: used_environments is the list of environments that were used by the agent execution. items: $ref: '#/components/schemas/gitpod.v1.AgentExecution.Status.EnvironmentUsage' title: used_environments type: array waitingInfo: $ref: '#/components/schemas/gitpod.v1.AgentExecution.WaitingInfo' description: "waiting_info is set when phase is PHASE_WAITING_FOR_INPUT and the agent\n has registered interests\ \ (timers, sub-agent completions, user messages)." title: waiting_info x-stainless-skip: true warningMessage: description: warning_message contains warnings, e.g. when the LLM is overloaded. title: warning_message type: string title: Status type: object gitpod.v1.AgentExecution.Status.CurrentOperation: additionalProperties: false oneOf: - not: anyOf: - required: - toolUse required: - llm - not: anyOf: - required: - llm required: - toolUse properties: llm: $ref: '#/components/schemas/gitpod.v1.AgentExecution.Status.LLM' title: llm retries: description: retries is the number of times the agent run has retried one or more steps title: retries type: string session: title: session type: string toolUse: $ref: '#/components/schemas/gitpod.v1.AgentExecution.Status.ToolUse' title: tool_use title: CurrentOperation type: object gitpod.v1.AgentExecution.Status.EnvironmentUsage: additionalProperties: false properties: createdByAgent: title: created_by_agent type: boolean environmentId: format: uuid title: environment_id type: string title: EnvironmentUsage type: object gitpod.v1.AgentExecution.Status.LLM: additionalProperties: false properties: complete: title: complete type: boolean title: LLM type: object gitpod.v1.AgentExecution.Status.LoopConditionResult: additionalProperties: false properties: conditionId: title: condition_id type: string iteration: format: int32 title: iteration type: integer lastEvaluatedAt: $ref: '#/components/schemas/google.protobuf.Timestamp' title: last_evaluated_at met: title: met type: boolean title: LoopConditionResult type: object gitpod.v1.AgentExecution.Status.MCPIntegrationStatus: additionalProperties: false description: "MCPIntegrationStatus represents the status of a single MCP integration\n within an agent execution context" properties: failureMessage: description: failure_message contains the reason the MCP integration failed to connect or operate title: failure_message type: string id: description: id is the unique name of the MCP integration title: id type: string name: description: name is the unique name of the MCP integration (e.g., "linear", "notion") title: name type: string phase: $ref: '#/components/schemas/gitpod.v1.MCPIntegrationPhase' description: phase is the current connection/health phase title: phase warningMessage: description: warning_message contains warnings (e.g., rate limiting, degraded performance) title: warning_message type: string title: MCPIntegrationStatus type: object gitpod.v1.AgentExecution.Status.OutputValue: additionalProperties: false oneOf: - not: anyOf: - required: - floatValue - required: - intValue - required: - stringValue required: - boolValue - not: anyOf: - required: - boolValue - required: - intValue - required: - stringValue required: - floatValue - not: anyOf: - required: - boolValue - required: - floatValue - required: - stringValue required: - intValue - not: anyOf: - required: - boolValue - required: - floatValue - required: - intValue required: - stringValue properties: boolValue: title: bool_value type: boolean floatValue: format: double title: float_value type: number intValue: title: int_value type: string stringValue: maxLength: 4096 title: string_value type: string title: OutputValue type: object gitpod.v1.AgentExecution.Status.OutputsEntry: additionalProperties: false properties: key: title: key type: string value: $ref: '#/components/schemas/gitpod.v1.AgentExecution.Status.OutputValue' title: value title: OutputsEntry type: object gitpod.v1.AgentExecution.Status.ToolUse: additionalProperties: false properties: complete: title: complete type: boolean toolName: minLength: 1 title: tool_name type: string title: ToolUse type: object gitpod.v1.AgentExecution.WaitingInfo: additionalProperties: false description: WaitingInfo describes what an agent is waiting for when in PHASE_WAITING_FOR_INPUT. properties: interests: items: $ref: '#/components/schemas/gitpod.v1.AgentExecution.WaitingInfo.Interest' title: interests type: array waitId: title: wait_id type: string waitingSince: $ref: '#/components/schemas/google.protobuf.Timestamp' title: waiting_since title: WaitingInfo type: object gitpod.v1.AgentExecution.WaitingInfo.EnvironmentInterest: additionalProperties: false properties: environmentId: format: uuid title: environment_id type: string phase: description: "Optional. When empty, any terminal phase (running, stopped, deleted)\n fires the interest. Valid values:\ \ \"running\", \"stopped\", \"deleted\"." enum: - '' - running - stopped - deleted title: phase type: string title: EnvironmentInterest type: object gitpod.v1.AgentExecution.WaitingInfo.Interest: additionalProperties: false oneOf: - not: anyOf: - required: - subAgent - required: - timer - required: - userMessage required: - environment - not: anyOf: - required: - environment - required: - timer - required: - userMessage required: - subAgent - not: anyOf: - required: - environment - required: - subAgent - required: - userMessage required: - timer - not: anyOf: - required: - environment - required: - subAgent - required: - timer required: - userMessage properties: environment: $ref: '#/components/schemas/gitpod.v1.AgentExecution.WaitingInfo.EnvironmentInterest' title: environment id: title: id type: string subAgent: $ref: '#/components/schemas/gitpod.v1.AgentExecution.WaitingInfo.SubAgentInterest' title: sub_agent timer: $ref: '#/components/schemas/gitpod.v1.AgentExecution.WaitingInfo.TimerInterest' title: timer userMessage: $ref: '#/components/schemas/gitpod.v1.AgentExecution.WaitingInfo.UserMessageInterest' title: user_message title: Interest type: object gitpod.v1.AgentExecution.WaitingInfo.SubAgentInterest: additionalProperties: false properties: executionId: title: execution_id type: string title: SubAgentInterest type: object gitpod.v1.AgentExecution.WaitingInfo.TimerInterest: additionalProperties: false properties: cron: description: cron is the cron expression, if cron-based. title: cron type: string duration: description: duration is the original duration spec (e.g. "5m"), if interval-based. title: duration type: string firesAt: $ref: '#/components/schemas/google.protobuf.Timestamp' description: fires_at is the next fire time. title: fires_at title: TimerInterest type: object gitpod.v1.AgentExecution.WaitingInfo.UserMessageInterest: additionalProperties: false title: UserMessageInterest type: object gitpod.v1.AgentExecutionFailureReason: description: AgentExecutionFailureReason represents the reason why an agent execution failed enum: - AGENT_EXECUTION_FAILURE_REASON_UNSPECIFIED - AGENT_EXECUTION_FAILURE_REASON_ENVIRONMENT - AGENT_EXECUTION_FAILURE_REASON_SERVICE - AGENT_EXECUTION_FAILURE_REASON_LLM_INTEGRATION - AGENT_EXECUTION_FAILURE_REASON_INTERNAL - AGENT_EXECUTION_FAILURE_REASON_AGENT_EXECUTION title: AgentExecutionFailureReason type: string gitpod.v1.AgentExecutionRole: description: AgentExecutionRole represents the role of an agent execution enum: - AGENT_EXECUTION_ROLE_UNSPECIFIED - AGENT_EXECUTION_ROLE_DEFAULT - AGENT_EXECUTION_ROLE_WORKFLOW title: AgentExecutionRole type: string gitpod.v1.AgentMessage: additionalProperties: false description: "AgentMessage is a message sent between agents (e.g. from a parent agent to a\n child agent execution,\ \ or vice versa)." properties: payload: description: Free-form payload of the message. title: payload type: string role: $ref: '#/components/schemas/gitpod.v1.AgentMessage.Role' description: The role of the sender in the agent hierarchy. title: role x-stainless-skip: true senderExecutionId: description: The execution ID of the agent that sent this message. title: sender_execution_id type: string x-stainless-skip: true type: $ref: '#/components/schemas/gitpod.v1.AgentMessage.Type' title: type title: AgentMessage type: object gitpod.v1.AgentMessage.Role: description: Role identifies the sender's relationship in the parent/child hierarchy. enum: - ROLE_UNSPECIFIED - ROLE_PARENT - ROLE_CHILD title: Role type: string gitpod.v1.AgentMessage.Type: enum: - TYPE_UNSPECIFIED - TYPE_UPDATE - TYPE_COMPLETE title: Type type: string gitpod.v1.AgentMetadata: additionalProperties: false properties: description: title: description type: string name: title: name type: string title: AgentMetadata type: object gitpod.v1.AgentMode: description: AgentMode defines the operational mode of an agent enum: - AGENT_MODE_UNSPECIFIED - AGENT_MODE_EXECUTION - AGENT_MODE_PLANNING - AGENT_MODE_RALPH - AGENT_MODE_SPEC title: AgentMode type: string gitpod.v1.AgentPolicy: additionalProperties: false description: AgentPolicy contains agent-specific policy settings for an organization properties: commandDenyList: description: command_deny_list contains a list of commands that agents are not allowed to execute items: type: string title: command_deny_list type: array conversationSharingPolicy: $ref: '#/components/schemas/gitpod.v1.ConversationSharingPolicy' description: conversation_sharing_policy controls whether agent conversations can be shared title: conversation_sharing_policy maxSubagentsPerEnvironment: description: "max_subagents_per_environment limits the number of non-terminal sub-agents\n a parent can have running\ \ simultaneously in the same environment.\n Valid range: 0-10. Zero means use the default (5)." format: int32 maximum: 10 title: max_subagents_per_environment type: integer mcpDisabled: description: mcp_disabled controls whether MCP (Model Context Protocol) is disabled for agents title: mcp_disabled type: boolean scmToolsAllowedGroupId: description: "scm_tools_allowed_group_id restricts SCM tools access to members of this group.\n Empty means no restriction\ \ (all users can use SCM tools if not disabled)." title: scm_tools_allowed_group_id type: string scmToolsDisabled: description: scm_tools_disabled controls whether SCM (Source Control Management) tools are disabled for agents title: scm_tools_disabled type: boolean required: - mcpDisabled - commandDenyList - scmToolsDisabled title: AgentPolicy type: object gitpod.v1.AgentResponseBlock: additionalProperties: false oneOf: - not: anyOf: - required: - actionStarted - required: - agentModeChange - required: - availableCommands - required: - clarifyingQuestions - required: - codeAnnotation - required: - environmentCreation - required: - fileModification - required: - hostAuthenticationRequired - required: - nextStepsProposal - required: - text - required: - thought - required: - todoGroup - required: - todoItem - required: - userInput - required: - userInputSeen required: - actionCompleted - not: anyOf: - required: - actionCompleted - required: - agentModeChange - required: - availableCommands - required: - clarifyingQuestions - required: - codeAnnotation - required: - environmentCreation - required: - fileModification - required: - hostAuthenticationRequired - required: - nextStepsProposal - required: - text - required: - thought - required: - todoGroup - required: - todoItem - required: - userInput - required: - userInputSeen required: - actionStarted - not: anyOf: - required: - actionCompleted - required: - actionStarted - required: - availableCommands - required: - clarifyingQuestions - required: - codeAnnotation - required: - environmentCreation - required: - fileModification - required: - hostAuthenticationRequired - required: - nextStepsProposal - required: - text - required: - thought - required: - todoGroup - required: - todoItem - required: - userInput - required: - userInputSeen required: - agentModeChange - not: anyOf: - required: - actionCompleted - required: - actionStarted - required: - agentModeChange - required: - clarifyingQuestions - required: - codeAnnotation - required: - environmentCreation - required: - fileModification - required: - hostAuthenticationRequired - required: - nextStepsProposal - required: - text - required: - thought - required: - todoGroup - required: - todoItem - required: - userInput - required: - userInputSeen required: - availableCommands - not: anyOf: - required: - actionCompleted - required: - actionStarted - required: - agentModeChange - required: - availableCommands - required: - codeAnnotation - required: - environmentCreation - required: - fileModification - required: - hostAuthenticationRequired - required: - nextStepsProposal - required: - text - required: - thought - required: - todoGroup - required: - todoItem - required: - userInput - required: - userInputSeen required: - clarifyingQuestions - not: anyOf: - required: - actionCompleted - required: - actionStarted - required: - agentModeChange - required: - availableCommands - required: - clarifyingQuestions - required: - environmentCreation - required: - fileModification - required: - hostAuthenticationRequired - required: - nextStepsProposal - required: - text - required: - thought - required: - todoGroup - required: - todoItem - required: - userInput - required: - userInputSeen required: - codeAnnotation - not: anyOf: - required: - actionCompleted - required: - actionStarted - required: - agentModeChange - required: - availableCommands - required: - clarifyingQuestions - required: - codeAnnotation - required: - fileModification - required: - hostAuthenticationRequired - required: - nextStepsProposal - required: - text - required: - thought - required: - todoGroup - required: - todoItem - required: - userInput - required: - userInputSeen required: - environmentCreation - not: anyOf: - required: - actionCompleted - required: - actionStarted - required: - agentModeChange - required: - availableCommands - required: - clarifyingQuestions - required: - codeAnnotation - required: - environmentCreation - required: - hostAuthenticationRequired - required: - nextStepsProposal - required: - text - required: - thought - required: - todoGroup - required: - todoItem - required: - userInput - required: - userInputSeen required: - fileModification - not: anyOf: - required: - actionCompleted - required: - actionStarted - required: - agentModeChange - required: - availableCommands - required: - clarifyingQuestions - required: - codeAnnotation - required: - environmentCreation - required: - fileModification - required: - nextStepsProposal - required: - text - required: - thought - required: - todoGroup - required: - todoItem - required: - userInput - required: - userInputSeen required: - hostAuthenticationRequired - not: anyOf: - required: - actionCompleted - required: - actionStarted - required: - agentModeChange - required: - availableCommands - required: - clarifyingQuestions - required: - codeAnnotation - required: - environmentCreation - required: - fileModification - required: - hostAuthenticationRequired - required: - text - required: - thought - required: - todoGroup - required: - todoItem - required: - userInput - required: - userInputSeen required: - nextStepsProposal - not: anyOf: - required: - actionCompleted - required: - actionStarted - required: - agentModeChange - required: - availableCommands - required: - clarifyingQuestions - required: - codeAnnotation - required: - environmentCreation - required: - fileModification - required: - hostAuthenticationRequired - required: - nextStepsProposal - required: - thought - required: - todoGroup - required: - todoItem - required: - userInput - required: - userInputSeen required: - text - not: anyOf: - required: - actionCompleted - required: - actionStarted - required: - agentModeChange - required: - availableCommands - required: - clarifyingQuestions - required: - codeAnnotation - required: - environmentCreation - required: - fileModification - required: - hostAuthenticationRequired - required: - nextStepsProposal - required: - text - required: - todoGroup - required: - todoItem - required: - userInput - required: - userInputSeen required: - thought - not: anyOf: - required: - actionCompleted - required: - actionStarted - required: - agentModeChange - required: - availableCommands - required: - clarifyingQuestions - required: - codeAnnotation - required: - environmentCreation - required: - fileModification - required: - hostAuthenticationRequired - required: - nextStepsProposal - required: - text - required: - thought - required: - todoItem - required: - userInput - required: - userInputSeen required: - todoGroup - not: anyOf: - required: - actionCompleted - required: - actionStarted - required: - agentModeChange - required: - availableCommands - required: - clarifyingQuestions - required: - codeAnnotation - required: - environmentCreation - required: - fileModification - required: - hostAuthenticationRequired - required: - nextStepsProposal - required: - text - required: - thought - required: - todoGroup - required: - userInput - required: - userInputSeen required: - todoItem - not: anyOf: - required: - actionCompleted - required: - actionStarted - required: - agentModeChange - required: - availableCommands - required: - clarifyingQuestions - required: - codeAnnotation - required: - environmentCreation - required: - fileModification - required: - hostAuthenticationRequired - required: - nextStepsProposal - required: - text - required: - thought - required: - todoGroup - required: - todoItem - required: - userInputSeen required: - userInput - not: anyOf: - required: - actionCompleted - required: - actionStarted - required: - agentModeChange - required: - availableCommands - required: - clarifyingQuestions - required: - codeAnnotation - required: - environmentCreation - required: - fileModification - required: - hostAuthenticationRequired - required: - nextStepsProposal - required: - text - required: - thought - required: - todoGroup - required: - todoItem - required: - userInput required: - userInputSeen properties: actionCompleted: $ref: '#/components/schemas/gitpod.v1.AgentResponseBlock.ActionCompleted' title: action_completed actionStarted: $ref: '#/components/schemas/gitpod.v1.AgentResponseBlock.ActionStarted' title: action_started agentModeChange: $ref: '#/components/schemas/gitpod.v1.AgentResponseBlock.AgentModeChange' title: agent_mode_change availableCommands: $ref: '#/components/schemas/gitpod.v1.AgentResponseBlock.AvailableCommands' title: available_commands clarifyingQuestions: $ref: '#/components/schemas/gitpod.v1.ClarifyingQuestions' title: clarifying_questions codeAnnotation: $ref: '#/components/schemas/gitpod.v1.AgentResponseBlock.CodeAnnotation' title: code_annotation createdAt: $ref: '#/components/schemas/google.protobuf.Timestamp' description: Timestamp when this block was created. Used for debugging and support bundles. title: created_at environmentCreation: $ref: '#/components/schemas/gitpod.v1.AgentResponseBlock.EnvironmentCreation' title: environment_creation fileModification: $ref: '#/components/schemas/gitpod.v1.AgentResponseBlock.FileModification' title: file_modification hostAuthenticationRequired: $ref: '#/components/schemas/gitpod.v1.AgentResponseBlock.HostAuthenticationRequired' title: host_authentication_required id: description: "id is the unique identifier of the response block. A conversation can have multiple blocks with the\ \ same ID.\n Clients are expected to use the ID to update or replace a block." format: uuid title: id type: string nextStepsProposal: $ref: '#/components/schemas/gitpod.v1.NextStepsProposal' title: next_steps_proposal phase: $ref: '#/components/schemas/gitpod.v1.AgentResponseBlock.Phase' description: phase is the phase of the response block indicating how to update the previous output block with the same ID. title: phase text: $ref: '#/components/schemas/gitpod.v1.AgentResponseBlock.TextOutput' title: text thought: $ref: '#/components/schemas/gitpod.v1.AgentResponseBlock.Thought' title: thought todoGroup: $ref: '#/components/schemas/gitpod.v1.AgentResponseBlock.TodoGroup' title: todo_group todoGroupId: description: Active todo snapshot group for routing response fragments in snapshot mode. title: todo_group_id type: string todoItem: $ref: '#/components/schemas/gitpod.v1.AgentResponseBlock.TodoItem' title: todo_item todoItemId: description: Active in-progress todo item for routing response fragments in snapshot mode. title: todo_item_id type: string userInput: $ref: '#/components/schemas/gitpod.v1.UserInputBlock' title: user_input userInputSeen: $ref: '#/components/schemas/gitpod.v1.AgentResponseBlock.UserInputBlockSeen' title: user_input_seen title: AgentResponseBlock type: object gitpod.v1.AgentResponseBlock.ActionCompleted: additionalProperties: false properties: actionId: minLength: 1 title: action_id type: string failed: title: failed type: boolean resultDescription: title: result_description type: string title: ActionCompleted type: object gitpod.v1.AgentResponseBlock.ActionStarted: additionalProperties: false properties: actionId: minLength: 1 title: action_id type: string intentDescription: title: intent_description type: string title: ActionStarted type: object gitpod.v1.AgentResponseBlock.AgentModeChange: additionalProperties: false description: "AgentModeChange signals a mode transition in autonomous agent modes (e.g., Ralph mode).\n This provides\ \ structured signaling instead of parsing magic tokens from text output." properties: message: description: Human-readable message describing the mode change title: message type: string state: $ref: '#/components/schemas/gitpod.v1.AgentResponseBlock.AgentModeChange.State' title: state title: AgentModeChange type: object gitpod.v1.AgentResponseBlock.AgentModeChange.State: enum: - STATE_UNSPECIFIED - STATE_SPEC_COMPLETE - STATE_ITERATION_COMPLETE - STATE_COMPLETE - STATE_ONA_SPEC_COMPLETE title: State type: string gitpod.v1.AgentResponseBlock.AvailableCommand: additionalProperties: false properties: description: description: Human-readable description of what the command does title: description type: string name: description: The command name without the leading slash (e.g., "go-tests", "create-pr") title: name type: string title: AvailableCommand type: object gitpod.v1.AgentResponseBlock.AvailableCommands: additionalProperties: false properties: commands: items: $ref: '#/components/schemas/gitpod.v1.AgentResponseBlock.AvailableCommand' title: commands type: array title: AvailableCommands type: object gitpod.v1.AgentResponseBlock.CodeAnnotation: additionalProperties: false properties: description: title: description type: string endLine: format: int32 title: end_line type: integer filePath: minLength: 1 title: file_path type: string startLine: format: int32 title: start_line type: integer title: title: title type: string title: CodeAnnotation type: object gitpod.v1.AgentResponseBlock.EnvironmentCreation: additionalProperties: false properties: actionId: minLength: 1 title: action_id type: string environmentId: format: uuid title: environment_id type: string title: EnvironmentCreation type: object gitpod.v1.AgentResponseBlock.FileModification: additionalProperties: false properties: actionId: title: action_id type: string content: description: Legacy SEARCH/REPLACE format content (deprecated in favor of diff) title: content type: string diff: $ref: '#/components/schemas/gitpod.v1.AgentResponseBlock.FileModification.Diff' description: "Enhanced diff format for dashboard consumption.\n When present, the dashboard will use this instead\ \ of parsing the content field.\n This provides better performance and more accurate diff rendering." title: diff filePath: minLength: 1 title: file_path type: string startLine: format: int32 title: start_line type: integer title: FileModification type: object gitpod.v1.AgentResponseBlock.FileModification.Diff: additionalProperties: false description: "Diff provides a structured diff format optimized for dashboard consumption.\n This format allows the dashboard\ \ to render diffs efficiently without parsing\n the legacy SEARCH/REPLACE format in the content field." properties: diffGroups: description: Structured diff groups for efficient rendering items: $ref: '#/components/schemas/gitpod.v1.AgentResponseBlock.FileModification.DiffGroup' title: diff_groups type: array stats: $ref: '#/components/schemas/gitpod.v1.AgentResponseBlock.FileModification.DiffStats' description: Summary statistics for the diff title: stats title: Diff type: object gitpod.v1.AgentResponseBlock.FileModification.DiffGroup: additionalProperties: false description: DiffGroup represents a contiguous block of lines with the same change type properties: lines: description: The actual lines of code for this group items: type: string title: lines type: array type: $ref: '#/components/schemas/gitpod.v1.AgentResponseBlock.FileModification.DiffGroup.Type' title: type title: DiffGroup type: object gitpod.v1.AgentResponseBlock.FileModification.DiffGroup.Type: enum: - TYPE_UNSPECIFIED - TYPE_ADDED - TYPE_REMOVED - TYPE_UNCHANGED title: Type type: string gitpod.v1.AgentResponseBlock.FileModification.DiffStats: additionalProperties: false description: Statistics about the changes in the diff properties: additions: description: Number of lines added format: int32 title: additions type: integer deletions: description: Number of lines deleted format: int32 title: deletions type: integer title: DiffStats type: object gitpod.v1.AgentResponseBlock.HostAuthenticationRequired: additionalProperties: false properties: actionId: minLength: 1 title: action_id type: string host: title: host type: string runnerId: format: uuid title: runner_id type: string title: HostAuthenticationRequired type: object gitpod.v1.AgentResponseBlock.Phase: enum: - PHASE_UNSPECIFIED - PHASE_UPDATE - PHASE_COMPLETED - PHASE_DELTA title: Phase type: string gitpod.v1.AgentResponseBlock.TextOutput: additionalProperties: false properties: content: title: content type: string sequenceId: description: Sequence ID for deduplication within the same message. Starts from 1, with 0 indicating unset (backwards compatible). title: sequence_id type: string type: $ref: '#/components/schemas/gitpod.v1.AgentResponseBlock.TextOutput.Type' title: type title: TextOutput type: object gitpod.v1.AgentResponseBlock.TextOutput.Type: enum: - TYPE_UNSPECIFIED - TYPE_USER_FACING_OUTPUT - TYPE_THOUGHTS title: Type type: string gitpod.v1.AgentResponseBlock.Thought: additionalProperties: false properties: content: title: content type: string title: Thought type: object gitpod.v1.AgentResponseBlock.TodoGroup: additionalProperties: false properties: groupId: description: Agent-controlled identifier for snapshot replacement semantics. minLength: 1 title: group_id type: string todos: description: Complete todo snapshot for this group. items: $ref: '#/components/schemas/gitpod.v1.AgentResponseBlock.TodoItem' title: todos type: array updatedAt: $ref: '#/components/schemas/google.protobuf.Timestamp' description: Timestamp of the latest snapshot update. title: updated_at title: TodoGroup type: object gitpod.v1.AgentResponseBlock.TodoItem: additionalProperties: false properties: id: minLength: 1 title: id type: string phase: $ref: '#/components/schemas/gitpod.v1.AgentResponseBlock.TodoItem.Phase' title: phase title: title: title type: string title: TodoItem type: object gitpod.v1.AgentResponseBlock.TodoItem.Phase: enum: - PHASE_UNSPECIFIED - PHASE_PENDING - PHASE_IN_PROGRESS - PHASE_DONE - PHASE_CLEARED title: Phase type: string gitpod.v1.AgentResponseBlock.UserInputBlockSeen: additionalProperties: false properties: id: title: id type: string title: UserInputBlockSeen type: object gitpod.v1.AgentTraceModelBreakdown: additionalProperties: false description: AgentTraceModelBreakdown contains stats for a single LLM model. properties: linesAdded: description: Lines added by sessions using this model. title: lines_added type: string linesRemoved: description: Lines removed by sessions using this model. title: lines_removed type: string model: $ref: '#/components/schemas/gitpod.v1.SupportedModel' description: The model these stats are for. title: model sessions: description: Number of sessions that used this model. title: sessions type: string title: AgentTraceModelBreakdown type: object gitpod.v1.AgentTraceSummary: additionalProperties: false description: AgentTraceSummary contains aggregate totals for a date range. properties: byModel: description: Per-model breakdown of session stats. items: $ref: '#/components/schemas/gitpod.v1.AgentTraceModelBreakdown' title: by_model type: array totalLinesAdded: description: Total lines added across all sessions. title: total_lines_added type: string totalLinesAddedTrend: description: Fractional change in total_lines_added compared to the previous period. format: double title: total_lines_added_trend type: number totalLinesRemoved: description: Total lines removed across all sessions. title: total_lines_removed type: string totalLinesRemovedTrend: description: Fractional change in total_lines_removed compared to the previous period. format: double title: total_lines_removed_trend type: number totalSessions: description: Total number of agent trace sessions in the date range. title: total_sessions type: string totalSessionsTrend: description: "Fractional change in total_sessions compared to the previous period of\n equal length. Computed as\ \ (current - previous) / previous. Zero when there\n is no previous data." format: double title: total_sessions_trend type: number title: AgentTraceSummary type: object gitpod.v1.AgentTraceTimeBucket: additionalProperties: false description: AgentTraceTimeBucket contains stats for a single time period. properties: byModel: description: Per-model breakdown for this bucket. items: $ref: '#/components/schemas/gitpod.v1.AgentTraceModelBreakdown' title: by_model type: array startTime: $ref: '#/components/schemas/google.protobuf.Timestamp' description: Start of this time bucket. title: start_time totalLinesAdded: description: Total lines added in this bucket. title: total_lines_added type: string totalLinesRemoved: description: Total lines removed in this bucket. title: total_lines_removed type: string totalSessions: description: Number of agent trace sessions in this bucket. title: total_sessions type: string title: AgentTraceTimeBucket type: object gitpod.v1.AllowPortAccessRequest: additionalProperties: false properties: environmentId: description: "environment_id specifies the environment to check access for.\n\n +required" format: uuid title: environment_id type: string port: description: "port specifies the port number to check access for.\n\n +required" format: int32 maximum: 65535 minimum: 1 title: port type: integer title: AllowPortAccessRequest type: object gitpod.v1.AllowPortAccessResponse: additionalProperties: false properties: allowed: description: allowed indicates whether the caller is permitted to access the port. title: allowed type: boolean title: AllowPortAccessResponse type: object gitpod.v1.AnnouncementBanner: additionalProperties: false properties: enabled: description: enabled controls whether the banner is displayed title: enabled type: boolean message: description: message is the banner message displayed to users. Supports basic Markdown. maxLength: 1000 title: message type: string organizationId: description: organization_id is the ID of the organization format: uuid title: organization_id type: string required: - organizationId title: AnnouncementBanner type: object gitpod.v1.AutoTopupSettings: additionalProperties: false description: AutoTopupSettings configures automatic credit top-ups for an organization. properties: amountCredits: description: 'OCU amount per top-up. Must be one of: 40, 100, 200, 400, 1000.' format: double title: amount_credits type: number enabled: description: Whether auto-topup is enabled. title: enabled type: boolean maxDailyTopups: description: Maximum number of automatic top-ups per day (safety cap, 0 means no cap). format: int32 title: max_daily_topups type: integer title: AutoTopupSettings type: object gitpod.v1.AutomationTrigger: additionalProperties: false description: "An AutomationTrigger represents a trigger for an automation action.\n The `manual` field shows a start\ \ button in the UI for manually triggering the automation.\n The `post_machine_start` field indicates that the automation\ \ should be triggered after the machine has started, before the devcontainer is ready.\n This is used for machine-level\ \ services like security agents that need to start early.\n The `post_environment_start` field indicates that the\ \ automation should be triggered after the environment has started (devcontainer ready).\n The `post_devcontainer_start`\ \ field indicates that the automation should be triggered after the dev container has started.\n The `prebuild` field\ \ starts the automation during a prebuild of an environment. This phase does not have user secrets available.\n The\ \ `before_snapshot` field triggers the automation after all prebuild tasks complete but before the snapshot is taken.\n\ \ This is used for tasks that need to run last during prebuilds, such as IDE warmup.\n Note: The prebuild and before_snapshot\ \ triggers can only be used with tasks, not services." oneOf: - not: anyOf: - required: - manual - required: - postDevcontainerStart - required: - postEnvironmentStart - required: - postMachineStart - required: - prebuild required: - beforeSnapshot - not: anyOf: - required: - beforeSnapshot - required: - postDevcontainerStart - required: - postEnvironmentStart - required: - postMachineStart - required: - prebuild required: - manual - not: anyOf: - required: - beforeSnapshot - required: - manual - required: - postEnvironmentStart - required: - postMachineStart - required: - prebuild required: - postDevcontainerStart - not: anyOf: - required: - beforeSnapshot - required: - manual - required: - postDevcontainerStart - required: - postMachineStart - required: - prebuild required: - postEnvironmentStart - not: anyOf: - required: - beforeSnapshot - required: - manual - required: - postDevcontainerStart - required: - postEnvironmentStart - required: - prebuild required: - postMachineStart - not: anyOf: - required: - beforeSnapshot - required: - manual - required: - postDevcontainerStart - required: - postEnvironmentStart - required: - postMachineStart required: - prebuild properties: beforeSnapshot: title: before_snapshot type: boolean manual: title: manual type: boolean postDevcontainerStart: title: post_devcontainer_start type: boolean postEnvironmentStart: title: post_environment_start type: boolean postMachineStart: title: post_machine_start type: boolean prebuild: title: prebuild type: boolean title: AutomationTrigger type: object gitpod.v1.AutomationsFile: additionalProperties: false description: "WARN: Do not remove any field here, as it will break reading automation yaml files. We error if there\ \ are any\n unknown fields in the yaml (to ensure the yaml is correct), but would break if we removed any fields.\n\ \ This includes marking a field as \"reserved\" in the proto file, this will also break reading the yaml." properties: services: additionalProperties: $ref: '#/components/schemas/gitpod.v1.AutomationsFile.Service' title: value title: services type: object tasks: additionalProperties: $ref: '#/components/schemas/gitpod.v1.AutomationsFile.Task' title: value title: tasks type: object title: AutomationsFile type: object gitpod.v1.AutomationsFile.Service: additionalProperties: false properties: commands: $ref: '#/components/schemas/gitpod.v1.ServiceSpec.Commands' title: commands description: title: description type: string name: minLength: 1 title: name type: string role: enum: - '' - default - editor - ai-agent title: role type: string runsOn: $ref: '#/components/schemas/gitpod.v1.RunsOn' title: runs_on triggeredBy: items: enum: - manual - postEnvironmentStart - postDevcontainerStart type: string title: triggered_by type: array title: Service type: object gitpod.v1.AutomationsFile.ServicesEntry: additionalProperties: false properties: key: title: key type: string value: $ref: '#/components/schemas/gitpod.v1.AutomationsFile.Service' title: value title: ServicesEntry type: object gitpod.v1.AutomationsFile.Task: additionalProperties: false properties: command: minLength: 1 title: command type: string dependsOn: items: type: string title: depends_on type: array description: title: description type: string name: minLength: 1 title: name type: string runsOn: $ref: '#/components/schemas/gitpod.v1.RunsOn' title: runs_on triggeredBy: items: enum: - manual - postEnvironmentStart - postDevcontainerStart - prebuild type: string title: triggered_by type: array title: Task type: object gitpod.v1.AutomationsFile.TasksEntry: additionalProperties: false properties: key: title: key type: string value: $ref: '#/components/schemas/gitpod.v1.AutomationsFile.Task' title: value title: TasksEntry type: object gitpod.v1.AvailableRunnerManager: additionalProperties: false properties: name: description: name is the human-readable name of the runner manager title: name type: string region: description: region is the region where the runner manager is located title: region type: string runnerManagerId: description: runner_manager_id is the unique identifier of the runner manager title: runner_manager_id type: string title: AvailableRunnerManager type: object gitpod.v1.BPFDebugLevel: description: "BPFDebugLevel controls the verbosity of BPF trace_pipe output (bpf_printk).\n Applies to all BPF-based\ \ agents (veto exec, future agents)." enum: - BPF_DEBUG_LEVEL_UNSPECIFIED - BPF_DEBUG_LEVEL_INFO - BPF_DEBUG_LEVEL_VERBOSE title: BPFDebugLevel type: string gitpod.v1.BigPaginationRequest: additionalProperties: false description: Do not use this in user facing APIs unless you have a good reason for that properties: pageSize: description: "Page size is the maximum number of results to retrieve per page.\n Defaults to 25. Maximum 10000." format: int32 maximum: 10000 title: page_size type: integer token: description: "Token for the next set of results that was returned as next_token of a\n PaginationResponse" title: token type: string title: BigPaginationRequest type: object gitpod.v1.BillingAddress: additionalProperties: false description: BillingAddress represents a billing address for an organization properties: city: description: city is the city name maxLength: 100 minLength: 1 title: city type: string country: description: country is the two-letter country code (ISO 3166-1 alpha-2) maxLength: 2 minLength: 2 pattern: ^[A-Z]{2}$ title: country type: string line1: description: line1 is the first line of the address (street address) maxLength: 255 minLength: 1 title: line1 type: string line2: description: line2 is the second line of the address (apartment, suite, etc.) maxLength: 255 title: line2 type: string postalCode: description: postal_code is the postal or ZIP code maxLength: 20 minLength: 1 title: postal_code type: string state: description: state is the state or province maxLength: 100 title: state type: string required: - line1 - city - postalCode - country title: BillingAddress type: object gitpod.v1.BillingPlanKind: enum: - BILLING_PLAN_KIND_UNSPECIFIED - BILLING_PLAN_KIND_FREE - BILLING_PLAN_KIND_CORE title: BillingPlanKind type: string gitpod.v1.BillingPlanSpec: additionalProperties: false properties: amountCentsUsd: description: amount_cents contains the amount of cents to charge the organization title: amount_cents_usd type: string kind: $ref: '#/components/schemas/gitpod.v1.BillingPlanKind' description: kind contains the kind of plan title: kind versionId: description: version contains the version of the plan title: version_id type: string required: - amountCentsUsd title: BillingPlanSpec type: object gitpod.v1.BillingPlanStatus: additionalProperties: false properties: amountCentsUsd: description: amount_cents contains the amount of cents to charge the organization title: amount_cents_usd type: string endingAt: $ref: '#/components/schemas/google.protobuf.Timestamp' description: ending_at contains the date and time when the plan ends title: ending_at kind: $ref: '#/components/schemas/gitpod.v1.BillingPlanKind' description: kind contains the kind of plan title: kind versionId: description: version contains the version of the plan title: version_id type: string required: - amountCentsUsd title: BillingPlanStatus type: object gitpod.v1.BillingRealm: enum: - BILLING_REALM_UNSPECIFIED - BILLING_REALM_SANDBOX - BILLING_REALM_PRODUCTION title: BillingRealm type: string gitpod.v1.BillingRecord: additionalProperties: false properties: id: description: id is the unique identifier for the billing record format: uuid title: id type: string metadata: $ref: '#/components/schemas/gitpod.v1.BillingRecordMetadata' title: metadata spec: $ref: '#/components/schemas/gitpod.v1.BillingRecordSpec' title: spec status: $ref: '#/components/schemas/gitpod.v1.BillingRecordStatus' title: status title: BillingRecord type: object gitpod.v1.BillingRecordMetadata: additionalProperties: false properties: createdAt: $ref: '#/components/schemas/google.protobuf.Timestamp' description: created_at is the time the record was created title: created_at organizationId: description: organization_id is the ID of the organization that owns the record format: uuid title: organization_id type: string realm: $ref: '#/components/schemas/gitpod.v1.BillingRealm' description: realm is the billing realm (sandbox or production) title: realm updatedAt: $ref: '#/components/schemas/google.protobuf.Timestamp' description: updated_at is the time the record was last updated title: updated_at title: BillingRecordMetadata type: object gitpod.v1.BillingRecordSpec: additionalProperties: false properties: plan: $ref: '#/components/schemas/gitpod.v1.BillingPlanSpec' description: plan contains the plan details title: plan title: BillingRecordSpec type: object gitpod.v1.BillingRecordStatus: additionalProperties: false properties: credit: $ref: '#/components/schemas/gitpod.v1.CreditStatus' description: credit contains the status of the credit balance title: credit error: description: error contains any error message maxLength: 1024 minLength: 1 title: error type: string paymentMethodVerification: $ref: '#/components/schemas/gitpod.v1.PaymentMethodVerificationStatus' description: card_verification contains the status of the card verification title: payment_method_verification plan: $ref: '#/components/schemas/gitpod.v1.BillingPlanStatus' description: plan contains the plan status title: plan title: BillingRecordStatus type: object gitpod.v1.BlockAccountRequest: additionalProperties: false properties: accountId: description: account_id is the UUID of the account to block format: uuid title: account_id type: string reason: description: reason is the reason for blocking the account (required for audit trail) maxLength: 1024 minLength: 1 title: reason type: string required: - accountId - reason title: BlockAccountRequest type: object gitpod.v1.BlockAccountResponse: additionalProperties: false properties: environmentsStopped: description: environments_stopped is the number of environments that were stopped format: int32 title: environments_stopped type: integer subscriptionsCancelled: description: subscriptions_cancelled is the number of subscriptions that were cancelled format: int32 title: subscriptions_cancelled type: integer title: BlockAccountResponse type: object gitpod.v1.Breadcrumb: additionalProperties: false description: Breadcrumb information (Sentry-compatible) properties: category: description: Breadcrumb category maxLength: 100 title: category type: string data: additionalProperties: maxLength: 1000 title: value type: string description: Additional breadcrumb data maxProperties: 20 title: data type: object level: $ref: '#/components/schemas/gitpod.v1.ErrorLevel' description: Breadcrumb level title: level message: description: Breadcrumb message maxLength: 1000 title: message type: string timestamp: $ref: '#/components/schemas/google.protobuf.Timestamp' description: When the breadcrumb occurred title: timestamp type: description: Breadcrumb type (e.g., "navigation", "http", "user", "error") maxLength: 100 title: type type: string title: Breadcrumb type: object gitpod.v1.Breadcrumb.DataEntry: additionalProperties: false properties: key: title: key type: string value: title: value type: string title: DataEntry type: object gitpod.v1.CallCheckAuthenticationForHost: additionalProperties: false title: CallCheckAuthenticationForHost type: object gitpod.v1.CallCheckAuthenticationForHost.Request: additionalProperties: false properties: host: title: host type: string principalId: title: principal_id type: string title: Request type: object gitpod.v1.CallCheckAuthenticationForHost.Response: additionalProperties: false properties: resp: $ref: '#/components/schemas/gitpod.v1.CheckAuthenticationForHostResponse' title: resp title: Response type: object gitpod.v1.CallCheckRepositoryAccess: additionalProperties: false title: CallCheckRepositoryAccess type: object gitpod.v1.CallCheckRepositoryAccess.Request: additionalProperties: false properties: principalId: description: principal_id is the ID of the user or service account to check access for. title: principal_id type: string repositoryUrl: description: repository_url is the URL of the repository to check access for. title: repository_url type: string title: Request type: object gitpod.v1.CallCheckRepositoryAccess.Response: additionalProperties: false properties: resp: $ref: '#/components/schemas/gitpod.v1.CheckRepositoryAccessResponse' title: resp title: Response type: object gitpod.v1.CallImprovePromptForAgent: additionalProperties: false title: CallImprovePromptForAgent type: object gitpod.v1.CallImprovePromptForAgent.Request: additionalProperties: false properties: agentId: title: agent_id type: string prompt: title: prompt type: string title: Request type: object gitpod.v1.CallImprovePromptForAgent.Response: additionalProperties: false properties: improvedPrompt: title: improved_prompt type: string title: Response type: object gitpod.v1.CallListSCMOrganizations: additionalProperties: false title: CallListSCMOrganizations type: object gitpod.v1.CallListSCMOrganizations.Request: additionalProperties: false properties: principalId: description: The principal's ID to list organizations for title: principal_id type: string scmHost: description: The SCM host to list organizations from (e.g., "github.com", "gitlab.com") title: scm_host type: string title: Request type: object gitpod.v1.CallListSCMOrganizations.Response: additionalProperties: false properties: organizations: description: List of organizations the user belongs to items: $ref: '#/components/schemas/gitpod.v1.ListSCMOrganizationsResponse.SCMOrganization' title: organizations type: array title: Response type: object gitpod.v1.CallParseContext: additionalProperties: false title: CallParseContext type: object gitpod.v1.CallParseContext.Request: additionalProperties: false properties: contextUrl: title: context_url type: string principalId: title: principal_id type: string title: Request type: object gitpod.v1.CallParseContext.Response: additionalProperties: false properties: resp: $ref: '#/components/schemas/gitpod.v1.ParseContextURLResponse' title: resp title: Response type: object gitpod.v1.CallPing: additionalProperties: false title: CallPing type: object gitpod.v1.CallPing.Request: additionalProperties: false properties: empty: type: boolean title: Request type: object gitpod.v1.CallPing.Response: additionalProperties: false title: Response type: object gitpod.v1.CallSearchRepositories: additionalProperties: false title: CallSearchRepositories type: object gitpod.v1.CallSearchRepositories.Request: additionalProperties: false properties: limit: deprecated: true description: "Maximum number of repositories to return.\n Deprecated: Use pagination.page_size instead" format: int32 title: limit type: integer pagination: $ref: '#/components/schemas/gitpod.v1.PaginationRequest' description: Pagination parameters for repository search title: pagination principalId: description: The principal's ID to search repositories for title: principal_id type: string scmHost: description: The SCM's host to search repositories for title: scm_host type: string searchMode: $ref: '#/components/schemas/gitpod.v1.SearchMode' description: Search mode determines how search_string is interpreted title: search_mode searchString: description: Search query - interpretation depends on search_mode title: search_string type: string title: Request type: object gitpod.v1.CallSearchRepositories.Response: additionalProperties: false properties: lastPage: description: 'Deprecated: Use pagination token instead. Total pages can be extracted from token.' format: int32 title: last_page type: integer pagination: $ref: '#/components/schemas/gitpod.v1.PaginationResponse' description: "Pagination information for the response.\n Token format: \"NEXT_PAGE/TOTAL_PAGES/TOTAL_COUNT\" (e.g.,\ \ \"2/40/1000\").\n Use -1 for unknown values (e.g., \"2/-1/-1\" when totals unavailable).\n Empty token means\ \ no more pages." title: pagination repositories: description: List of repositories matching the search criteria items: $ref: '#/components/schemas/gitpod.v1.SearchRepositoriesResponse.Repository' title: repositories type: array title: Response type: object gitpod.v1.CallSendMessageToAgentExecution: additionalProperties: false title: CallSendMessageToAgentExecution type: object gitpod.v1.CallSendMessageToAgentExecution.Request: additionalProperties: false oneOf: - not: anyOf: - required: - message - required: - wakeEvent required: - agentMessage - not: anyOf: - required: - agentMessage - required: - wakeEvent required: - message - not: anyOf: - required: - agentMessage - required: - message required: - wakeEvent properties: agentExecutionId: title: agent_execution_id type: string agentMessage: $ref: '#/components/schemas/gitpod.v1.AgentMessage' title: agent_message message: $ref: '#/components/schemas/gitpod.v1.UserInputBlock' title: message wakeEvent: $ref: '#/components/schemas/gitpod.v1.WakeEvent' title: wake_event title: Request type: object gitpod.v1.CallSendMessageToAgentExecution.Response: additionalProperties: false title: Response type: object gitpod.v1.CallValidateConfig: additionalProperties: false title: CallValidateConfig type: object gitpod.v1.CallValidateConfig.Request: additionalProperties: false oneOf: - not: anyOf: - required: - scm required: - environmentClass - not: anyOf: - required: - environmentClass required: - scm properties: environmentClass: $ref: '#/components/schemas/gitpod.v1.EnvironmentClass' title: environment_class scm: $ref: '#/components/schemas/gitpod.v1.SCMIntegration' title: scm title: Request type: object gitpod.v1.CallValidateConfig.Response: additionalProperties: false oneOf: - not: anyOf: - required: - scm required: - environmentClass - not: anyOf: - required: - environmentClass required: - scm properties: environmentClass: $ref: '#/components/schemas/gitpod.v1.EnvironmentClassValidationResult' title: environment_class scm: $ref: '#/components/schemas/gitpod.v1.SCMIntegrationValidationResult' title: scm title: Response type: object gitpod.v1.CancelPrebuildRequest: additionalProperties: false properties: prebuildId: description: prebuild_id specifies the prebuild to cancel format: uuid title: prebuild_id type: string required: - prebuildId title: CancelPrebuildRequest type: object gitpod.v1.CancelPrebuildResponse: additionalProperties: false properties: prebuild: $ref: '#/components/schemas/gitpod.v1.Prebuild' title: prebuild required: - prebuild title: CancelPrebuildResponse type: object gitpod.v1.CancelSubscriptionRequest: additionalProperties: false properties: organizationId: description: subscription_id is the ID of the subscription to cancel minLength: 1 title: organization_id type: string subscriptionType: $ref: '#/components/schemas/gitpod.v1.SubscriptionType' description: subscription_type specifies the type of subscription to cancel title: subscription_type required: - organizationId - subscriptionType title: CancelSubscriptionRequest type: object gitpod.v1.CancelSubscriptionResponse: additionalProperties: false title: CancelSubscriptionResponse type: object gitpod.v1.CancelWorkflowExecutionActionRequest: additionalProperties: false description: CancelWorkflowExecutionActionRequest cancels a running workflow execution action. properties: workflowExecutionActionId: format: uuid title: workflow_execution_action_id type: string title: CancelWorkflowExecutionActionRequest type: object gitpod.v1.CancelWorkflowExecutionActionResponse: additionalProperties: false title: CancelWorkflowExecutionActionResponse type: object gitpod.v1.CancelWorkflowExecutionRequest: additionalProperties: false description: CancelWorkflowExecutionRequest cancels a running workflow execution. properties: workflowExecutionId: format: uuid title: workflow_execution_id type: string title: CancelWorkflowExecutionRequest type: object gitpod.v1.CancelWorkflowExecutionResponse: additionalProperties: false title: CancelWorkflowExecutionResponse type: object gitpod.v1.CheckAuthenticationForHostRequest: additionalProperties: false properties: host: title: host type: string runnerId: format: uuid title: runner_id type: string title: CheckAuthenticationForHostRequest type: object gitpod.v1.CheckAuthenticationForHostResponse: additionalProperties: false properties: authenticated: title: authenticated type: boolean authenticationUrl: deprecated: true title: authentication_url type: string patSupported: deprecated: true title: pat_supported type: boolean scmId: description: scm_id is the unique identifier of the SCM provider title: scm_id type: string scmName: description: scm_name is the human-readable name of the SCM provider (e.g., "GitHub", "GitLab") title: scm_name type: string supportsOauth2: $ref: '#/components/schemas/gitpod.v1.CheckAuthenticationForHostResponse.AuthenticationMethodOAuth2' description: supports_oauth2 indicates that the host supports OAuth2 authentication title: supports_oauth2 supportsPat: $ref: '#/components/schemas/gitpod.v1.CheckAuthenticationForHostResponse.AuthenticationMethodPersonalAccessToken' description: supports_pat indicates that the host supports Personal Access Token authentication title: supports_pat title: CheckAuthenticationForHostResponse type: object gitpod.v1.CheckAuthenticationForHostResponse.AuthenticationMethodOAuth2: additionalProperties: false properties: authUrl: description: auth_url is the URL where users can authenticate title: auth_url type: string docsUrl: description: docs_url is the URL to the documentation explaining this authentication method title: docs_url type: string title: AuthenticationMethodOAuth2 type: object gitpod.v1.CheckAuthenticationForHostResponse.AuthenticationMethodPersonalAccessToken: additionalProperties: false properties: createUrl: description: create_url is the URL where users can create a new Personal Access Token title: create_url type: string docsUrl: description: docs_url is the URL to the documentation explaining PAT usage for this host title: docs_url type: string example: description: example is an example of a Personal Access Token title: example type: string requiredScopes: description: required_scopes is the list of permissions required for the Personal Access Token items: type: string title: required_scopes type: array title: AuthenticationMethodPersonalAccessToken type: object gitpod.v1.CheckRepositoryAccessRequest: additionalProperties: false properties: repositoryUrl: description: "repository_url is the URL of the repository to check access for.\n Can be a clone URL (https://github.com/org/repo.git)\ \ or web URL (https://github.com/org/repo)." format: uri title: repository_url type: string runnerId: format: uuid title: runner_id type: string title: CheckRepositoryAccessRequest type: object gitpod.v1.CheckRepositoryAccessResponse: additionalProperties: false properties: errorMessage: description: "error_message provides details when access check fails.\n Empty when has_access is true." title: error_message type: string hasAccess: description: has_access indicates whether the principal has read access to the repository. title: has_access type: boolean title: CheckRepositoryAccessResponse type: object gitpod.v1.ClarifyingQuestions: additionalProperties: false properties: questions: items: $ref: '#/components/schemas/gitpod.v1.ClarifyingQuestions.Question' minItems: 1 title: questions type: array title: ClarifyingQuestions type: object gitpod.v1.ClarifyingQuestions.Choice: additionalProperties: false properties: description: title: description type: string label: minLength: 1 title: label type: string text: minLength: 1 title: text type: string title: Choice type: object gitpod.v1.ClarifyingQuestions.Question: additionalProperties: false properties: allowOther: title: allow_other type: boolean choices: items: $ref: '#/components/schemas/gitpod.v1.ClarifyingQuestions.Choice' maxItems: 6 minItems: 2 title: choices type: array question: minLength: 1 title: question type: string questionId: minLength: 1 title: question_id type: string title: Question type: object gitpod.v1.ClearTopupFailureRequest: additionalProperties: false properties: organizationId: description: organization_id is the ID of the organization to clear the topup failure for format: uuid title: organization_id type: string required: - organizationId title: ClearTopupFailureRequest type: object gitpod.v1.ClearTopupFailureResponse: additionalProperties: false title: ClearTopupFailureResponse type: object gitpod.v1.CoAuthorSummary: additionalProperties: false description: CoAuthorSummary contains aggregate totals for a date range. properties: byTool: description: Per-tool breakdown of contribution stats. items: $ref: '#/components/schemas/gitpod.v1.ToolBreakdown' title: by_tool type: array distinctAuthors: description: Number of distinct authors (by author_hash). title: distinct_authors type: string distinctAuthorsTrend: description: Fractional change in distinct_authors compared to the previous period. format: double title: distinct_authors_trend type: number totalCommits: description: Total number of commits in the date range. title: total_commits type: string totalCommitsTrend: description: "Fractional change in total_commits compared to the previous period of equal\n length. Computed as\ \ (current - previous) / previous. Zero when there is no\n previous data." format: double title: total_commits_trend type: number totalLinesAdded: description: Total lines added across all commits. title: total_lines_added type: string totalLinesAddedTrend: description: Fractional change in total_lines_added compared to the previous period. format: double title: total_lines_added_trend type: number totalLinesRemoved: description: Total lines removed across all commits. title: total_lines_removed type: string totalLinesRemovedTrend: description: Fractional change in total_lines_removed compared to the previous period. format: double title: total_lines_removed_trend type: number title: CoAuthorSummary type: object gitpod.v1.CoAuthorTimeBucket: additionalProperties: false description: CoAuthorTimeBucket contains stats for a single time period. properties: aiRatio: description: Ratio of AI-assisted lines added to total lines added (0.0–1.0). format: double title: ai_ratio type: number byTool: description: Per-tool breakdown for this bucket. items: $ref: '#/components/schemas/gitpod.v1.ToolBreakdown' title: by_tool type: array distinctAuthors: description: Number of distinct authors (by author_hash) in this bucket. title: distinct_authors type: string startTime: $ref: '#/components/schemas/google.protobuf.Timestamp' description: Start of this time bucket. title: start_time totalCommits: description: Total number of commits in this bucket (across all tools). title: total_commits type: string totalLinesAdded: description: Total lines added in this bucket (across all tools). title: total_lines_added type: string totalLinesRemoved: description: Total lines removed in this bucket (across all tools). title: total_lines_removed type: string title: CoAuthorTimeBucket type: object gitpod.v1.CoAuthorTool: description: "CoAuthorTool identifies the AI tool that co-authored a commit.\n UNSPECIFIED (0) is the proto default\ \ and must not appear in reported data.\n Use HUMAN for commits with no AI co-author." enum: - CO_AUTHOR_TOOL_UNSPECIFIED - CO_AUTHOR_TOOL_NO_COAUTHOR - CO_AUTHOR_TOOL_HUMAN_COAUTHOR - CO_AUTHOR_TOOL_ONA - CO_AUTHOR_TOOL_GITHUB_COPILOT - CO_AUTHOR_TOOL_CURSOR - CO_AUTHOR_TOOL_OTHER - CO_AUTHOR_TOOL_CLAUDE title: CoAuthorTool type: string gitpod.v1.CommitCoAuthorStat: additionalProperties: false description: CommitCoAuthorStat represents co-author data for a single commit. properties: authorHash: description: "One-way hash of the author email. Enables distinct author counts\n without storing PII." maxLength: 128 minLength: 1 title: author_hash type: string commitDate: $ref: '#/components/schemas/google.protobuf.Timestamp' description: Author date of the commit. title: commit_date commitHash: description: SHA of the commit. Used with project_id as the idempotency key. maxLength: 64 minLength: 1 title: commit_hash type: string linesAdded: description: Lines added in this commit. title: lines_added type: string linesRemoved: description: Lines removed in this commit. title: lines_removed type: string rawCoauthor: description: "Raw co-author email address from the Co-authored-by trailer.\n Empty when there is no co-author trailer.\ \ Stored verbatim so the\n backend can reclassify historical data when new AI tools are added." maxLength: 320 title: raw_coauthor type: string tool: $ref: '#/components/schemas/gitpod.v1.CoAuthorTool' description: "Which tool co-authored this commit, NO_COAUTHOR for solo commits,\n or HUMAN_COAUTHOR for human pair-programming.\n\ \ UNSPECIFIED is rejected — callers must always set a concrete value." not: enum: - 0 title: tool required: - commitDate title: CommitCoAuthorStat type: object gitpod.v1.CompleteBillingSetupRequest: additionalProperties: false properties: organizationId: description: organization_id is the ID of the organization to complete billing setup for format: uuid title: organization_id type: string setupIntentId: description: setup_intent_id is the Stripe SetupIntent ID to verify completion minLength: 1 title: setup_intent_id type: string required: - organizationId - setupIntentId title: CompleteBillingSetupRequest type: object gitpod.v1.CompleteBillingSetupResponse: additionalProperties: false properties: contractId: description: contract_id is the Metronome contract ID created for the organization title: contract_id type: string trialAmountCredits: description: trial_amount_credits is the amount of trial credits granted in Gitpod Credits format: double title: trial_amount_credits type: number trialExpiresAt: $ref: '#/components/schemas/google.protobuf.Timestamp' description: trial_expires_at is when the trial credits expire title: trial_expires_at trialGranted: description: trial_granted indicates whether a free trial was successfully granted title: trial_granted type: boolean title: CompleteBillingSetupResponse type: object gitpod.v1.ContextURLInitializer: additionalProperties: false properties: url: description: url is the URL from which the environment is created format: uri title: url type: string title: ContextURLInitializer type: object gitpod.v1.ConversationSharingPolicy: description: ConversationSharingPolicy controls how agent conversations can be shared. enum: - CONVERSATION_SHARING_POLICY_UNSPECIFIED - CONVERSATION_SHARING_POLICY_DISABLED - CONVERSATION_SHARING_POLICY_ORGANIZATION title: ConversationSharingPolicy type: string gitpod.v1.CorrectUsageEventsRequest: additionalProperties: false properties: idempotencyKeys: description: Idempotency keys of events to correct. items: minItems: 1 type: string minItems: 1 title: idempotency_keys type: array reason: description: Why these events are being corrected (stored in cancel_reason and correction payload). minLength: 1 title: reason type: string title: CorrectUsageEventsRequest type: object gitpod.v1.CorrectUsageEventsResponse: additionalProperties: false properties: results: items: $ref: '#/components/schemas/gitpod.v1.UsageEventCorrectionResult' title: results type: array title: CorrectUsageEventsResponse type: object gitpod.v1.CountRequest: additionalProperties: false description: "CountRequest controls whether the response should include a bounded\n count of matching records." properties: include: description: "When true, the first page of results will include a CountResponse with\n the bounded total. Subsequent\ \ pages (requests with a pagination token)\n will not contain the count." title: include type: boolean title: CountRequest type: object gitpod.v1.CountResponse: additionalProperties: false description: "CountResponse represents a bounded count of matching records.\n When the actual count exceeds the counting\ \ limit, value is capped and\n relation is set to GREATER_THAN_OR_EQUAL." properties: relation: $ref: '#/components/schemas/gitpod.v1.CountResponseRelation' description: Indicates whether value is the exact total or a lower bound. title: relation value: description: The count of matching records, capped at the server's counting limit. format: int32 title: value type: integer title: CountResponse type: object gitpod.v1.CountResponseRelation: enum: - COUNT_RESPONSE_RELATION_UNSPECIFIED - COUNT_RESPONSE_RELATION_EQ - COUNT_RESPONSE_RELATION_GTE title: CountResponseRelation type: string gitpod.v1.Coupon: additionalProperties: false description: Coupon represents a promotional code that can be redeemed for credits properties: code: description: code is the unique coupon code that customers can redeem title: code type: string config: $ref: '#/components/schemas/gitpod.v1.CouponConfig' description: config is the configuration for this coupon title: config createdAt: $ref: '#/components/schemas/google.protobuf.Timestamp' description: created_at is when the coupon was created title: created_at description: description: description is a human-readable description of the coupon nullable: true title: description type: string expiresAt: $ref: '#/components/schemas/google.protobuf.Timestamp' description: expires_at is when this coupon expires (optional) nullable: true title: expires_at id: description: id is the unique identifier for the coupon format: uuid title: id type: string maxUses: description: max_uses is the maximum number of times this coupon can be redeemed exclusiveMinimum: true format: int32 minimum: 0 title: max_uses type: integer maxUsesPerOrg: description: max_uses_per_org is the maximum number of times this coupon can be redeemed per organization exclusiveMinimum: true format: int32 minimum: 0 nullable: true title: max_uses_per_org type: integer updatedAt: $ref: '#/components/schemas/google.protobuf.Timestamp' description: updated_at is when the coupon was last updated title: updated_at title: Coupon type: object gitpod.v1.CouponConfig: additionalProperties: false properties: autoTerminate: description: auto_terminate is whether the subscription should be terminated after the duration has passed title: auto_terminate type: boolean durationMonths: description: duration_months is the duration of the coupon in months nullable: true title: duration_months type: string oneTimeOcuGrant: description: one_time_ocu_grant is the amount of OCU this coupon grants nullable: true title: one_time_ocu_grant type: string percentageOff: description: percentage_off is the percentage off this coupon grants nullable: true title: percentage_off type: string title: CouponConfig type: object gitpod.v1.CreateAgentExecutionConversationTokenRequest: additionalProperties: false properties: agentExecutionId: format: uuid title: agent_execution_id type: string title: CreateAgentExecutionConversationTokenRequest type: object gitpod.v1.CreateAgentExecutionConversationTokenResponse: additionalProperties: false properties: token: title: token type: string title: CreateAgentExecutionConversationTokenResponse type: object gitpod.v1.CreateAgentExecutionTranscriptTokenRequest: additionalProperties: false properties: agentExecutionId: format: uuid title: agent_execution_id type: string title: CreateAgentExecutionTranscriptTokenRequest type: object gitpod.v1.CreateAgentExecutionTranscriptTokenResponse: additionalProperties: false properties: token: title: token type: string title: CreateAgentExecutionTranscriptTokenResponse type: object gitpod.v1.CreateAgentRequest: additionalProperties: false oneOf: - not: anyOf: - required: - runnerSide required: - inEnvironment - not: anyOf: - required: - inEnvironment required: - runnerSide properties: description: description: A description of what the agent does title: description type: string inEnvironment: $ref: '#/components/schemas/gitpod.v1.InEnvironmentAgentSpec' title: in_environment name: description: The name of the agent minLength: 1 title: name type: string runnerSide: $ref: '#/components/schemas/gitpod.v1.RunnerSideAgentSpec' title: runner_side title: CreateAgentRequest type: object gitpod.v1.CreateAgentResponse: additionalProperties: false properties: agent: $ref: '#/components/schemas/gitpod.v1.Agent' description: The created agent title: agent required: - agent title: CreateAgentResponse type: object gitpod.v1.CreateCardVerificationRequest: additionalProperties: false properties: email: description: email is the exact email address of the account format: email maxLength: 255 minLength: 1 title: email type: string freeCredits: description: "free_credits is the number of free credits to grant when the user's Core\n subscription is provisioned.\ \ If zero or unset, the default amount is used." format: int32 nullable: true title: free_credits type: integer organizationId: description: organization_id is the specific organization to verify (required if user has multiple orgs or already has a verified org) format: uuid nullable: true title: organization_id type: string reason: description: "reason is an optional description of why this email is being approved\n (e.g., \"Ona for Open Source\ \ - Project X\")" maxLength: 1024 nullable: true title: reason type: string required: - email title: CreateCardVerificationRequest type: object gitpod.v1.CreateCardVerificationResponse: additionalProperties: false title: CreateCardVerificationResponse type: object gitpod.v1.CreateCouponRequest: additionalProperties: false properties: code: description: code is the unique coupon code that customers will redeem maxLength: 50 minLength: 3 title: code type: string config: $ref: '#/components/schemas/gitpod.v1.CouponConfig' description: config is the configuration for this coupon title: config description: description: description is a human-readable description of the coupon maxLength: 500 nullable: true title: description type: string expiresAt: $ref: '#/components/schemas/google.protobuf.Timestamp' description: expires_at is when this coupon expires (optional) nullable: true title: expires_at maxUses: description: max_uses is the maximum number of times this coupon can be redeemed exclusiveMinimum: true format: int32 minimum: 0 title: max_uses type: integer maxUsesPerOrg: description: max_uses_per_org is the maximum number of times this coupon can be redeemed per organization exclusiveMinimum: true format: int32 minimum: 0 nullable: true title: max_uses_per_org type: integer required: - code - maxUses title: CreateCouponRequest type: object gitpod.v1.CreateCouponResponse: additionalProperties: false properties: coupon: $ref: '#/components/schemas/gitpod.v1.Coupon' title: coupon title: CreateCouponResponse type: object gitpod.v1.CreateCustomDomainRequest: additionalProperties: false description: CreateCustomDomainRequest is the request message for creating a custom domain properties: awsAccountId: deprecated: true description: 'aws_account_id is the AWS account ID (deprecated: use cloud_account_id)' nullable: true title: aws_account_id type: string cloudAccountId: description: cloud_account_id is the unified cloud account identifier (AWS Account ID or GCP Project ID) nullable: true title: cloud_account_id type: string domainName: description: domain_name is the custom domain name maxLength: 253 minLength: 4 title: domain_name type: string organizationId: description: organization_id is the ID of the organization to create the custom domain for format: uuid title: organization_id type: string provider: $ref: '#/components/schemas/gitpod.v1.CustomDomainProvider' description: provider is the cloud provider for this custom domain title: provider required: - organizationId - domainName title: CreateCustomDomainRequest type: object gitpod.v1.CreateCustomDomainResponse: additionalProperties: false description: CreateCustomDomainResponse is the response message for creating a custom domain properties: customDomain: $ref: '#/components/schemas/gitpod.v1.CustomDomain' description: custom_domain is the created custom domain title: custom_domain required: - customDomain title: CreateCustomDomainResponse type: object gitpod.v1.CreateDomainVerificationRequest: additionalProperties: false properties: domain: maxLength: 253 minLength: 4 title: domain type: string organizationId: format: uuid title: organization_id type: string required: - organizationId - domain title: CreateDomainVerificationRequest type: object gitpod.v1.CreateDomainVerificationResponse: additionalProperties: false properties: domainVerification: $ref: '#/components/schemas/gitpod.v1.DomainVerification' title: domain_verification required: - domainVerification title: CreateDomainVerificationResponse type: object gitpod.v1.CreateEnvironmentAccessTokenRequest: additionalProperties: false properties: environmentId: description: environment_id specifies the environment for which the access token should be created. format: uuid title: environment_id type: string required: - environmentId title: CreateEnvironmentAccessTokenRequest type: object gitpod.v1.CreateEnvironmentAccessTokenResponse: additionalProperties: false properties: accessToken: description: access_token is the token that can be used for environment authentication title: access_token type: string required: - accessToken title: CreateEnvironmentAccessTokenResponse type: object gitpod.v1.CreateEnvironmentClassRequest: additionalProperties: false properties: configuration: items: $ref: '#/components/schemas/gitpod.v1.FieldValue' title: configuration type: array description: maxLength: 200 minLength: 3 title: description type: string displayName: maxLength: 127 minLength: 3 title: display_name type: string runnerId: format: uuid title: runner_id type: string title: CreateEnvironmentClassRequest type: object gitpod.v1.CreateEnvironmentClassResponse: additionalProperties: false properties: id: title: id type: string title: CreateEnvironmentClassResponse type: object gitpod.v1.CreateEnvironmentFromProjectBadRequestEnvironmentClassDetails: additionalProperties: false description: '`CreateEnvironmentFromProjectBadRequestEnvironmentClassDetails` contains details about possible environment class IDs to use with this project.' properties: environmentClassIds: description: environment_class_ids are the available environment class IDs to use with this project. items: format: uuid type: string title: environment_class_ids type: array title: CreateEnvironmentFromProjectBadRequestEnvironmentClassDetails type: object gitpod.v1.CreateEnvironmentFromProjectRequest: additionalProperties: false properties: annotations: additionalProperties: title: value type: string description: annotations are key/value pairs attached to the environment metadata. title: annotations type: object x-stainless-skip: true name: description: "name is a user-defined identifier for the environment.\n If not specified, the system will generate\ \ a name." maxLength: 80 nullable: true title: name type: string projectId: format: uuid title: project_id type: string sessionId: description: "session_id is the ID of the session this environment belongs to.\n If empty, a new session is created\ \ implicitly." format: uuid title: session_id type: string spec: $ref: '#/components/schemas/gitpod.v1.EnvironmentSpec' description: "Spec is the configuration of the environment that's required for the\n runner to start the environment\n\ \ Configuration already defined in the Project will override parts of the spec, if set" title: spec title: CreateEnvironmentFromProjectRequest type: object gitpod.v1.CreateEnvironmentFromProjectRequest.AnnotationsEntry: additionalProperties: false properties: key: title: key type: string value: title: value type: string title: AnnotationsEntry type: object gitpod.v1.CreateEnvironmentFromProjectResponse: additionalProperties: false properties: environment: $ref: '#/components/schemas/gitpod.v1.Environment' title: environment required: - environment title: CreateEnvironmentFromProjectResponse type: object gitpod.v1.CreateEnvironmentLogsTokenRequest: additionalProperties: false properties: environmentId: description: "environment_id specifies the environment for which the logs token should be created.\n\n +required" format: uuid title: environment_id type: string title: CreateEnvironmentLogsTokenRequest type: object gitpod.v1.CreateEnvironmentLogsTokenResponse: additionalProperties: false properties: accessToken: description: access_token is the token that can be used to access the logs of the environment title: access_token type: string required: - accessToken title: CreateEnvironmentLogsTokenResponse type: object gitpod.v1.CreateEnvironmentPreconditionFailureDetails: additionalProperties: false description: "`CreateEnvironmentPreconditionFailureDetails` contains details about why a\n `CreateEnvironment` or `CreateEnvironmentFromProject`\ \ request failed with failed_precondition.\n The `missing_authentication_tokens_for_hosts` field lists the hosts for\ \ which the required authentication tokens were missing." properties: missingAuthenticationTokensForHosts: items: type: string title: missing_authentication_tokens_for_hosts type: array title: CreateEnvironmentPreconditionFailureDetails type: object gitpod.v1.CreateEnvironmentRequest: additionalProperties: false description: "Required fields:\n - metadata.organization_id\n - metadata.configuration_id" properties: annotations: additionalProperties: title: value type: string description: annotations are key/value pairs attached to the environment metadata. title: annotations type: object x-stainless-skip: true name: description: "name is a user-defined identifier for the environment.\n If not specified, the system will generate\ \ a name." maxLength: 80 nullable: true title: name type: string sessionId: description: "session_id is the ID of the session this environment belongs to.\n If empty, a new session is created\ \ implicitly." format: uuid title: session_id type: string spec: $ref: '#/components/schemas/gitpod.v1.EnvironmentSpec' description: "spec is the configuration of the environment that's required for the to\n start the environment" title: spec title: CreateEnvironmentRequest type: object gitpod.v1.CreateEnvironmentRequest.AnnotationsEntry: additionalProperties: false properties: key: title: key type: string value: title: value type: string title: AnnotationsEntry type: object gitpod.v1.CreateEnvironmentResponse: additionalProperties: false properties: environment: $ref: '#/components/schemas/gitpod.v1.Environment' title: environment required: - environment title: CreateEnvironmentResponse type: object gitpod.v1.CreateGroupRequest: additionalProperties: false description: CreateGroup messages properties: description: maxLength: 255 title: description type: string name: maxLength: 80 minLength: 3 title: name type: string organizationId: format: uuid title: organization_id type: string title: CreateGroupRequest type: object gitpod.v1.CreateGroupResponse: additionalProperties: false properties: group: $ref: '#/components/schemas/gitpod.v1.Group' title: group title: CreateGroupResponse type: object gitpod.v1.CreateHostAuthenticationTokenRequest: additionalProperties: false properties: expiresAt: $ref: '#/components/schemas/google.protobuf.Timestamp' title: expires_at host: minLength: 1 title: host type: string integrationId: format: uuid title: integration_id type: string refreshToken: description: stored encrypted, retrieved via GetHostAuthenticationTokenValue title: refresh_token type: string runnerId: format: uuid title: runner_id type: string scopes: description: Maximum 100 scopes allowed (101 for validation purposes) items: maxItems: 101 type: string maxItems: 101 title: scopes type: array source: $ref: '#/components/schemas/gitpod.v1.HostAuthenticationTokenSource' title: source subject: $ref: '#/components/schemas/gitpod.v1.Subject' description: Subject identifies the principal (user or service account) for the token title: subject token: description: stored encrypted, retrieved via GetHostAuthenticationTokenValue minLength: 1 title: token type: string userId: deprecated: true description: 'Deprecated: Use principal_id and principal_type instead' format: uuid title: user_id type: string title: CreateHostAuthenticationTokenRequest type: object gitpod.v1.CreateHostAuthenticationTokenResponse: additionalProperties: false properties: token: $ref: '#/components/schemas/gitpod.v1.HostAuthenticationToken' title: token required: - token title: CreateHostAuthenticationTokenResponse type: object gitpod.v1.CreateIntegrationDefinitionRequest: additionalProperties: false properties: auth: $ref: '#/components/schemas/gitpod.v1.IntegrationAuthentication' description: auth defines the authentication requirements for this integration title: auth capabilities: $ref: '#/components/schemas/gitpod.v1.IntegrationCapabilities' description: capabilities defines what this integration can do title: capabilities description: description: description provides a human-readable description of the integration title: description type: string experimental: description: experimental indicates if this integration is experimental and requires feature flag title: experimental type: boolean host: description: host is the hostname for this integration (e.g., "linear.app") title: host type: string iconUrl: description: icon_url is the URL for this integration's icon title: icon_url type: string name: description: name is the human-readable name for this integration type minLength: 1 title: name type: string title: CreateIntegrationDefinitionRequest type: object gitpod.v1.CreateIntegrationDefinitionResponse: additionalProperties: false properties: definition: $ref: '#/components/schemas/gitpod.v1.IntegrationDefinition' title: definition required: - definition title: CreateIntegrationDefinitionResponse type: object gitpod.v1.CreateIntegrationRequest: additionalProperties: false properties: auth: $ref: '#/components/schemas/gitpod.v1.IntegrationAuthentication' description: auth defines which authentication methods are enabled for this integration title: auth capabilities: $ref: '#/components/schemas/gitpod.v1.IntegrationCapabilities' description: capabilities defines which capabilities are enabled for this integration title: capabilities enabled: description: enabled indicates if this integration is enabled title: enabled type: boolean host: description: host is the hostname for this integration (e.g., "linear.app") - optional, inherits from definition title: host type: string integrationDefinitionId: description: integration_definition_id references the integration definition ID minLength: 1 title: integration_definition_id type: string runnerId: description: runner_id is optional and immutable - if provided, restricts integration to specific runner format: uuid title: runner_id type: string title: CreateIntegrationRequest type: object gitpod.v1.CreateIntegrationResponse: additionalProperties: false properties: integration: $ref: '#/components/schemas/gitpod.v1.Integration' title: integration required: - integration title: CreateIntegrationResponse type: object gitpod.v1.CreateLLMAccessTokenRequest: additionalProperties: false properties: agentExecutionId: description: "The agent execution ID for tracking and runner selection.\n If empty, falls back to current logic\ \ for backward compatibility." title: agent_execution_id type: string requiredModels: description: The models required by the agent to function. items: $ref: '#/components/schemas/gitpod.v1.SupportedModel' title: required_models type: array title: CreateLLMAccessTokenRequest type: object gitpod.v1.CreateLLMAccessTokenResponse: additionalProperties: false properties: accessToken: title: access_token type: string llmUrl: title: llm_url type: string title: CreateLLMAccessTokenResponse type: object gitpod.v1.CreateLLMIntegrationRequest: additionalProperties: false properties: apiKey: description: api_key is the LLM provider's API key. title: api_key type: string endpoint: title: endpoint type: string maxTokens: description: "max_tokens is the maximum number of tokens to generate before stopping.\n If set to 0, the model's\ \ default will be used." title: max_tokens type: string models: description: models represents the LLM models this integration supports items: $ref: '#/components/schemas/gitpod.v1.SupportedModel' minItems: 1 title: models type: array runnerId: format: uuid title: runner_id type: string title: CreateLLMIntegrationRequest type: object gitpod.v1.CreateLLMIntegrationResponse: additionalProperties: false properties: id: description: id is a uniquely generated identifier for the LLM integration format: uuid title: id type: string title: CreateLLMIntegrationResponse type: object gitpod.v1.CreateLogSection: additionalProperties: false description: "CreateLogSection defines the structure of JSON metadata for a create log section entry.\n Example log\ \ line:\n [section-create] {\"id\":\"foo\",\"title\":\"Foo\"}" properties: continuous: description: "continuous indicates if the log section is continuous. Continuous log sections\n are expected to remain\ \ open over the lifetime of an environment, e.g. system logs." title: continuous type: boolean id: title: id type: string title: description: title is an (optional) human-readable title for the log section. title: title type: string title: CreateLogSection type: object gitpod.v1.CreateMCPAccessTokenRequest: additionalProperties: false properties: empty: type: boolean title: CreateMCPAccessTokenRequest type: object gitpod.v1.CreateMCPAccessTokenResponse: additionalProperties: false properties: accessToken: title: access_token type: string title: CreateMCPAccessTokenResponse type: object gitpod.v1.CreateMagicLinkRequest: additionalProperties: false properties: email: format: email title: email type: string name: description: Name of the Account title: name type: string required: - email title: CreateMagicLinkRequest type: object gitpod.v1.CreateMagicLinkResponse: additionalProperties: false properties: magicLink: description: The magic link to send to the user format: uri title: magic_link type: string required: - magicLink title: CreateMagicLinkResponse type: object gitpod.v1.CreateMembershipRequest: additionalProperties: false description: CreateMembership messages properties: groupId: format: uuid title: group_id type: string subject: $ref: '#/components/schemas/gitpod.v1.Subject' description: Subject to add to the group title: subject title: CreateMembershipRequest type: object gitpod.v1.CreateMembershipResponse: additionalProperties: false properties: member: $ref: '#/components/schemas/gitpod.v1.GroupMembership' title: member title: CreateMembershipResponse type: object gitpod.v1.CreateOrganizationInviteRequest: additionalProperties: false properties: organizationId: format: uuid title: organization_id type: string required: - organizationId title: CreateOrganizationInviteRequest type: object gitpod.v1.CreateOrganizationInviteResponse: additionalProperties: false properties: invite: $ref: '#/components/schemas/gitpod.v1.OrganizationInvite' title: invite required: - invite title: CreateOrganizationInviteResponse type: object gitpod.v1.CreateOrganizationLLMConfigurationRequest: additionalProperties: false properties: apiKey: description: api_key is the plaintext Anthropic API key to encrypt and store maxLength: 512 minLength: 1 title: api_key type: string organizationId: description: organization_id is the ID of the organization to configure format: uuid title: organization_id type: string title: CreateOrganizationLLMConfigurationRequest type: object gitpod.v1.CreateOrganizationLLMConfigurationResponse: additionalProperties: false properties: configuration: $ref: '#/components/schemas/gitpod.v1.OrganizationLLMConfiguration' description: configuration contains metadata about the stored configuration title: configuration title: CreateOrganizationLLMConfigurationResponse type: object gitpod.v1.CreateOrganizationRequest: additionalProperties: false properties: inviteAccountsWithMatchingDomain: description: Should other Accounts with the same domain be automatically invited to the organization? title: invite_accounts_with_matching_domain type: boolean joinOrganization: description: join_organization decides whether the Identity issuing this request joins the org on creation title: join_organization type: boolean name: description: name is the organization name minLength: 3 title: name type: string required: - name title: CreateOrganizationRequest type: object gitpod.v1.CreateOrganizationResponse: additionalProperties: false properties: member: $ref: '#/components/schemas/gitpod.v1.OrganizationMember' description: member is the member that joined the org on creation. Only set if specified "join_organization" is "true" in the request. title: member organization: $ref: '#/components/schemas/gitpod.v1.Organization' description: organization is the created organization title: organization required: - organization title: CreateOrganizationResponse type: object gitpod.v1.CreatePersonalAccessTokenRequest: additionalProperties: false properties: description: title: description type: string readOnly: description: "When true, the token can only be used for read operations.\n Mutations will be denied at the data\ \ layer." title: read_only type: boolean userId: format: uuid title: user_id type: string validFor: $ref: '#/components/schemas/google.protobuf.Duration' title: valid_for title: CreatePersonalAccessTokenRequest type: object gitpod.v1.CreatePersonalAccessTokenResponse: additionalProperties: false properties: token: title: token type: string required: - token title: CreatePersonalAccessTokenResponse type: object gitpod.v1.CreatePortAccessTokenRequest: additionalProperties: false properties: environmentId: description: "environment_id specifies the environment for which the port access token should be created.\n\n +required" format: uuid title: environment_id type: string port: description: "port specifies the port number for which the access token should be created.\n\n +required" format: int32 maximum: 65535 minimum: 1 title: port type: integer title: CreatePortAccessTokenRequest type: object gitpod.v1.CreatePortAccessTokenResponse: additionalProperties: false properties: accessToken: description: access_token is the token that can be used to access the port. title: access_token type: string required: - accessToken title: CreatePortAccessTokenResponse type: object gitpod.v1.CreatePrebuildLogsTokenRequest: additionalProperties: false properties: prebuildId: description: "prebuild_id specifies the prebuild for which the logs token should be created.\n\n +required" format: uuid title: prebuild_id type: string required: - prebuildId title: CreatePrebuildLogsTokenRequest type: object gitpod.v1.CreatePrebuildLogsTokenResponse: additionalProperties: false properties: accessToken: description: access_token is the token that can be used to access the logs of the prebuild title: access_token type: string required: - accessToken title: CreatePrebuildLogsTokenResponse type: object gitpod.v1.CreatePrebuildRequest: additionalProperties: false properties: environmentClassId: description: "environment_class_id specifies which environment class to use for the prebuild.\n If not specified,\ \ uses the project's default environment class." format: uuid nullable: true title: environment_class_id type: string projectId: description: project_id specifies the project to create a prebuild for format: uuid title: project_id type: string spec: $ref: '#/components/schemas/gitpod.v1.PrebuildSpec' description: spec contains the configuration for creating the prebuild title: spec required: - projectId - spec title: CreatePrebuildRequest type: object gitpod.v1.CreatePrebuildResponse: additionalProperties: false properties: prebuild: $ref: '#/components/schemas/gitpod.v1.Prebuild' title: prebuild required: - prebuild title: CreatePrebuildResponse type: object gitpod.v1.CreateProjectFromEnvironmentRequest: additionalProperties: false properties: environmentId: description: environment_id specifies the environment identifier format: uuid title: environment_id type: string name: maxLength: 80 minLength: 1 title: name type: string title: CreateProjectFromEnvironmentRequest type: object gitpod.v1.CreateProjectFromEnvironmentResponse: additionalProperties: false properties: project: $ref: '#/components/schemas/gitpod.v1.Project' title: project title: CreateProjectFromEnvironmentResponse type: object gitpod.v1.CreateProjectPolicyRequest: additionalProperties: false description: CreateProjectPolicyRequest creates a Project Policy. properties: groupId: description: group_id specifies the group_id identifier format: uuid title: group_id type: string projectId: description: project_id specifies the project identifier format: uuid title: project_id type: string role: $ref: '#/components/schemas/gitpod.v1.ProjectRole' title: role title: CreateProjectPolicyRequest type: object gitpod.v1.CreateProjectPolicyResponse: additionalProperties: false properties: policy: $ref: '#/components/schemas/gitpod.v1.ProjectPolicy' title: policy title: CreateProjectPolicyResponse type: object gitpod.v1.CreateProjectRequest: additionalProperties: false properties: automationsFilePath: description: 'automations_file_path is the path to the automations file relative to the repo root path must not be absolute (start with a /): ``` this.matches(''^$|^[^/].*'') ``` ' title: automations_file_path type: string devcontainerFilePath: description: 'devcontainer_file_path is the path to the devcontainer file relative to the repo root path must not be absolute (start with a /): ``` this.matches(''^$|^[^/].*'') ``` ' title: devcontainer_file_path type: string initializer: $ref: '#/components/schemas/gitpod.v1.EnvironmentInitializer' description: initializer is the content initializer title: initializer name: maxLength: 80 minLength: 1 title: name type: string prebuildConfiguration: $ref: '#/components/schemas/gitpod.v1.ProjectPrebuildConfiguration' description: "prebuild_configuration defines how prebuilds are created for this project.\n If not set, prebuilds\ \ are disabled for the project." title: prebuild_configuration technicalDescription: description: "technical_description is a detailed technical description of the project\n This field is not returned\ \ by default in GetProject or ListProjects responses 8KB max" maxLength: 8192 title: technical_description type: string required: - initializer title: CreateProjectRequest type: object gitpod.v1.CreateProjectResponse: additionalProperties: false properties: project: $ref: '#/components/schemas/gitpod.v1.Project' title: project title: CreateProjectResponse type: object gitpod.v1.CreateProjectsRequest: additionalProperties: false properties: projects: items: $ref: '#/components/schemas/gitpod.v1.CreateProjectRequest' maxItems: 100 minItems: 1 title: projects type: array title: CreateProjectsRequest type: object gitpod.v1.CreateProjectsResponse: additionalProperties: false properties: createdProjects: description: created_projects contains the successfully created projects items: $ref: '#/components/schemas/gitpod.v1.Project' title: created_projects type: array failedProjects: description: failed_projects contains details about projects that failed to create items: $ref: '#/components/schemas/gitpod.v1.CreateProjectsResponse.Failure' title: failed_projects type: array title: CreateProjectsResponse type: object gitpod.v1.CreateProjectsResponse.Failure: additionalProperties: false properties: error: description: error describes why the project creation failed title: error type: string index: description: index is the position in the request array (0-based) format: int32 title: index type: integer name: description: name is the project name that failed title: name type: string title: Failure type: object gitpod.v1.CreatePromptRequest: additionalProperties: false properties: command: maxLength: 50 pattern: ^[a-zA-Z0-9_-]*$ title: command type: string description: maxLength: 500 minLength: 1 title: description type: string isCommand: title: is_command type: boolean isSkill: title: is_skill type: boolean isTemplate: title: is_template type: boolean name: maxLength: 255 minLength: 1 title: name type: string prompt: maxLength: 20000 minLength: 1 title: prompt type: string title: CreatePromptRequest type: object gitpod.v1.CreatePromptResponse: additionalProperties: false properties: prompt: $ref: '#/components/schemas/gitpod.v1.Prompt' title: prompt title: CreatePromptResponse type: object gitpod.v1.CreateRoleAssignmentRequest: additionalProperties: false description: CreateRoleAssignment messages properties: groupId: format: uuid title: group_id type: string resourceId: format: uuid title: resource_id type: string resourceRole: $ref: '#/components/schemas/gitpod.v1.ResourceRole' title: resource_role resourceType: $ref: '#/components/schemas/gitpod.v1.ResourceType' title: resource_type title: CreateRoleAssignmentRequest type: object gitpod.v1.CreateRoleAssignmentResponse: additionalProperties: false properties: assignment: $ref: '#/components/schemas/gitpod.v1.RoleAssignment' title: assignment title: CreateRoleAssignmentResponse type: object gitpod.v1.CreateRunnerLogsTokenRequest: additionalProperties: false properties: runnerId: description: "runner_id specifies the runner for which the logs token should be created.\n\n +required" format: uuid title: runner_id type: string title: CreateRunnerLogsTokenRequest type: object gitpod.v1.CreateRunnerLogsTokenResponse: additionalProperties: false properties: accessToken: description: access_token is the token that can be used to access the logs and support bundle of the runner title: access_token type: string required: - accessToken title: CreateRunnerLogsTokenResponse type: object gitpod.v1.CreateRunnerManagerRequest: additionalProperties: false properties: configuration: $ref: '#/components/schemas/gitpod.v1.RunnerManagerConfiguration' title: configuration name: minLength: 1 title: name type: string region: minLength: 1 title: region type: string title: CreateRunnerManagerRequest type: object gitpod.v1.CreateRunnerManagerResponse: additionalProperties: false properties: accessToken: title: access_token type: string runnerManager: $ref: '#/components/schemas/gitpod.v1.RunnerManager' title: runner_manager required: - runnerManager title: CreateRunnerManagerResponse type: object gitpod.v1.CreateRunnerPolicyRequest: additionalProperties: false description: CreateRunnerPolicyRequest creates a Runner Policy. properties: groupId: description: group_id specifies the group_id identifier format: uuid title: group_id type: string role: $ref: '#/components/schemas/gitpod.v1.RunnerRole' title: role runnerId: description: runner_id specifies the project identifier format: uuid title: runner_id type: string title: CreateRunnerPolicyRequest type: object gitpod.v1.CreateRunnerPolicyResponse: additionalProperties: false properties: policy: $ref: '#/components/schemas/gitpod.v1.RunnerPolicy' title: policy required: - policy title: CreateRunnerPolicyResponse type: object gitpod.v1.CreateRunnerRequest: additionalProperties: false properties: kind: $ref: '#/components/schemas/gitpod.v1.RunnerKind' description: "The runner's kind\n This field is optional and here for backwards-compatibility. Use the provider\ \ field instead.\n If provider is set, the runner's kind will be deduced from the provider.\n Only one of kind\ \ and provider must be set." title: kind name: description: The runner name for humans maxLength: 127 minLength: 3 title: name type: string provider: $ref: '#/components/schemas/gitpod.v1.RunnerProvider' description: "The specific implementation type of the runner\n This field is optional for backwards compatibility\ \ but will be required in the future.\n When specified, kind must not be specified (will be deduced from provider)" title: provider runnerManagerId: description: "The runner manager id specifies the runner manager for the managed runner.\n This field is mandatory\ \ for managed runners, otheriwse should not be set." format: uuid title: runner_manager_id type: string spec: $ref: '#/components/schemas/gitpod.v1.RunnerSpec' title: spec title: CreateRunnerRequest type: object gitpod.v1.CreateRunnerResponse: additionalProperties: false properties: accessToken: deprecated: true description: deprecated, will be removed. Use exchange_token instead. title: access_token type: string exchangeToken: description: "exchange_token is a one-time use token that should be exchanged by the runner for an access token,\n\ \ using the IdentityService.ExchangeToken rpc. The token expires after 24 hours." title: exchange_token type: string runner: $ref: '#/components/schemas/gitpod.v1.Runner' title: runner required: - runner title: CreateRunnerResponse type: object gitpod.v1.CreateRunnerTokenRequest: additionalProperties: false properties: runnerId: format: uuid title: runner_id type: string title: CreateRunnerTokenRequest type: object gitpod.v1.CreateRunnerTokenResponse: additionalProperties: false properties: accessToken: deprecated: true description: deprecated, will be removed. Use exchange_token instead. title: access_token type: string exchangeToken: description: "exchange_token is a one-time use token that should be exchanged by the runner for an access token,\n\ \ using the IdentityService.ExchangeToken rpc. The token expires after 24 hours." title: exchange_token type: string title: CreateRunnerTokenResponse type: object gitpod.v1.CreateSCIMConfigurationRequest: additionalProperties: false properties: name: description: name is a human-readable name for the SCIM configuration maxLength: 128 nullable: true title: name type: string organizationId: description: organization_id is the ID of the organization to create the SCIM configuration for format: uuid title: organization_id type: string ssoConfigurationId: description: sso_configuration_id is the SSO configuration to link (required for user provisioning) format: uuid title: sso_configuration_id type: string tokenExpiresIn: $ref: '#/components/schemas/google.protobuf.Duration' description: "token_expires_in is the duration until the token expires.\n Defaults to 1 year. Minimum 1 day, maximum\ \ 2 years." nullable: true title: token_expires_in required: - organizationId - ssoConfigurationId title: CreateSCIMConfigurationRequest type: object gitpod.v1.CreateSCIMConfigurationResponse: additionalProperties: false properties: scimConfiguration: $ref: '#/components/schemas/gitpod.v1.SCIMConfiguration' description: scim_configuration is the created SCIM configuration title: scim_configuration token: description: "token is the bearer token for SCIM API authentication.\n This is only returned once during creation\ \ - store it securely." title: token type: string tokenExpiresAt: $ref: '#/components/schemas/google.protobuf.Timestamp' description: token_expires_at is when the token will expire title: token_expires_at required: - scimConfiguration - token - tokenExpiresAt title: CreateSCIMConfigurationResponse type: object gitpod.v1.CreateSCMIntegrationRequest: additionalProperties: false properties: host: title: host type: string issuerUrl: description: issuer_url can be set to override the authentication provider URL, if it doesn't match the SCM host. nullable: true title: issuer_url type: string oauthClientId: description: "oauth_client_id is the OAuth app's client ID, if OAuth is configured.\n If configured, oauth_plaintext_client_secret\ \ must also be set." nullable: true title: oauth_client_id type: string oauthPlaintextClientSecret: description: "oauth_plaintext_client_secret is the OAuth app's client secret in clear text.\n This will first be\ \ encrypted with the runner's public key before being stored." nullable: true title: oauth_plaintext_client_secret type: string pat: title: pat type: boolean runnerId: format: uuid title: runner_id type: string scmId: description: scm_id references the scm_id in the runner's configuration schema that this integration is for title: scm_id type: string virtualDirectory: description: "virtual_directory is the virtual directory path for Azure DevOps Server (e.g., \"/tfs\").\n This field\ \ is only used for Azure DevOps Server SCM integrations and should be empty for other SCM types.\n Azure DevOps\ \ Server APIs work without collection when PAT scope is 'All accessible organizations'." nullable: true title: virtual_directory type: string title: CreateSCMIntegrationRequest type: object gitpod.v1.CreateSCMIntegrationResponse: additionalProperties: false properties: id: description: id is a uniquely generated identifier for the SCM integration format: uuid title: id type: string title: CreateSCMIntegrationResponse type: object gitpod.v1.CreateSSOConfigurationRequest: additionalProperties: false properties: additionalScopes: description: "additional_scopes are extra OIDC scopes to request from the identity provider during sign-in.\n These\ \ are appended to the default scopes (openid, email, profile)." items: maxItems: 100 maxLength: 128 minLength: 1 type: string maxItems: 100 title: additional_scopes type: array claimsExpression: description: "claims_expression is an optional CEL expression evaluated against OIDC token claims during login.\n\ \ When set, the expression must evaluate to true for the login to succeed.\n Example: `claims.email_verified &&\ \ claims.email.endsWith(\"@example.com\")`" maxLength: 4096 nullable: true title: claims_expression type: string clientId: description: client_id is the client ID of the OIDC application set on the IdP minLength: 1 title: client_id type: string clientSecret: description: client_secret is the client secret of the OIDC application set on the IdP minLength: 1 title: client_secret type: string displayName: maxLength: 128 title: display_name type: string emailDomain: description: email_domain is the domain that is allowed to sign in to the organization minLength: 4 nullable: true title: email_domain type: string emailDomains: items: maxLength: 253 minLength: 4 pattern: ^(?:[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?\.)+[a-zA-Z]{2,}$ type: string uniqueItems: true title: email_domains type: array uniqueItems: true issuerUrl: description: issuer_url is the URL of the IdP issuer format: uri title: issuer_url type: string organizationId: format: uuid title: organization_id type: string required: - organizationId - clientId - clientSecret - issuerUrl title: CreateSSOConfigurationRequest type: object gitpod.v1.CreateSSOConfigurationResponse: additionalProperties: false properties: ssoConfiguration: $ref: '#/components/schemas/gitpod.v1.SSOConfiguration' description: sso_configuration is the created SSO configuration title: sso_configuration required: - ssoConfiguration title: CreateSSOConfigurationResponse type: object gitpod.v1.CreateSearchAccessTokenRequest: additionalProperties: false properties: empty: type: boolean title: CreateSearchAccessTokenRequest type: object gitpod.v1.CreateSearchAccessTokenResponse: additionalProperties: false properties: accessToken: title: access_token type: string title: CreateSearchAccessTokenResponse type: object gitpod.v1.CreateSecretRequest: additionalProperties: false oneOf: - not: anyOf: - required: - containerRegistryBasicAuthHost - required: - environmentVariable - required: - filePath required: - apiOnly - not: anyOf: - required: - apiOnly - required: - environmentVariable - required: - filePath required: - containerRegistryBasicAuthHost - not: anyOf: - required: - apiOnly - required: - containerRegistryBasicAuthHost - required: - filePath required: - environmentVariable - not: anyOf: - required: - apiOnly - required: - containerRegistryBasicAuthHost - required: - environmentVariable required: - filePath properties: apiOnly: description: "api_only indicates the secret is only available via API/CLI.\n These secrets are NOT automatically\ \ injected into services or devcontainers.\n Useful for secrets that should only be consumed programmatically\ \ (e.g., by security agents)." title: api_only type: boolean containerRegistryBasicAuthHost: description: secret will be mounted as a docker config in the environment VM, mount will have the docker registry host title: container_registry_basic_auth_host type: string environmentVariable: description: secret will be created as an Environment Variable with the same name as the secret title: environment_variable type: boolean filePath: description: 'absolute path to the file where the secret is mounted value must be an absolute path (e.g. /path/to/file): ``` this.matches(''^/[^/].*$'') ``` ' title: file_path type: string name: maxLength: 127 minLength: 3 pattern: ^[0-9a-zA-Z_]{3,}$ title: name type: string projectId: deprecated: true description: "project_id is the ProjectID this Secret belongs to\n Deprecated: use scope instead" title: project_id type: string scope: $ref: '#/components/schemas/gitpod.v1.SecretScope' description: scope is the scope of the secret title: scope value: description: value is the plaintext value of the secret maxLength: 10240 minLength: 1 title: value type: string title: CreateSecretRequest type: object gitpod.v1.CreateSecretResponse: additionalProperties: false properties: secret: $ref: '#/components/schemas/gitpod.v1.Secret' title: secret title: CreateSecretResponse type: object gitpod.v1.CreateServiceAccountAccessTokenRequest: additionalProperties: false properties: serviceAccountId: format: uuid title: service_account_id type: string title: CreateServiceAccountAccessTokenRequest type: object gitpod.v1.CreateServiceAccountAccessTokenResponse: additionalProperties: false properties: token: title: token type: string title: CreateServiceAccountAccessTokenResponse type: object gitpod.v1.CreateServiceAccountRequest: additionalProperties: false properties: description: maxLength: 500 title: description type: string name: maxLength: 64 minLength: 1 title: name type: string validUntil: $ref: '#/components/schemas/google.protobuf.Timestamp' description: "valid_until specifies when this service account expires.\n Note: In the current design, the service\ \ account itself has an expiry.\n All authentication using this service account will fail after this time." title: valid_until required: - validUntil title: CreateServiceAccountRequest type: object gitpod.v1.CreateServiceAccountResponse: additionalProperties: false properties: serviceAccount: $ref: '#/components/schemas/gitpod.v1.ServiceAccount' title: service_account required: - serviceAccount title: CreateServiceAccountResponse type: object gitpod.v1.CreateServiceAccountTokenRequest: additionalProperties: false properties: description: title: description type: string validFor: $ref: '#/components/schemas/google.protobuf.Duration' description: "valid_for specifies how long the token should be valid.\n A large value (e.g. reaching year 2099)\ \ represents \"no expiry\".\n The actual expiry is always capped to the service account's own expiry." title: valid_for title: CreateServiceAccountTokenRequest type: object gitpod.v1.CreateServiceAccountTokenResponse: additionalProperties: false properties: serviceAccountToken: $ref: '#/components/schemas/gitpod.v1.ServiceAccountToken' description: service_account_token contains the token metadata. title: service_account_token token: description: token is the actual JWT token value. This is only returned once during creation. title: token type: string required: - token title: CreateServiceAccountTokenResponse type: object gitpod.v1.CreateServiceRequest: additionalProperties: false properties: environmentId: format: uuid title: environment_id type: string metadata: $ref: '#/components/schemas/gitpod.v1.ServiceMetadata' title: metadata spec: $ref: '#/components/schemas/gitpod.v1.ServiceSpec' title: spec title: CreateServiceRequest type: object gitpod.v1.CreateServiceResponse: additionalProperties: false properties: service: $ref: '#/components/schemas/gitpod.v1.Service' title: service required: - service title: CreateServiceResponse type: object gitpod.v1.CreateSessionRequest: additionalProperties: false properties: description: nullable: true title: description type: string name: nullable: true title: name type: string title: CreateSessionRequest type: object gitpod.v1.CreateSessionResponse: additionalProperties: false properties: session: $ref: '#/components/schemas/gitpod.v1.Session' title: session title: CreateSessionResponse type: object gitpod.v1.CreateSubscriptionRequest: additionalProperties: false properties: amountCents: description: amount_cents is the amount of cents to charge the organization enum: - 2000 - 5000 - 10000 - 20000 - 50000 title: amount_cents type: string couponCode: description: coupon_code is the code of the coupon to apply to the subscription title: coupon_code type: string organizationId: description: organization_id is the ID of the organization to create subscription for format: uuid title: organization_id type: string subscriptionType: $ref: '#/components/schemas/gitpod.v1.SubscriptionType' description: subscription_type specifies the type of subscription to create title: subscription_type required: - organizationId - subscriptionType - amountCents title: CreateSubscriptionRequest type: object gitpod.v1.CreateSubscriptionResponse: additionalProperties: false properties: subscription: $ref: '#/components/schemas/gitpod.v1.Subscription' title: subscription title: CreateSubscriptionResponse type: object gitpod.v1.CreateTaskRequest: additionalProperties: false properties: dependsOn: items: format: uuid type: string title: depends_on type: array environmentId: format: uuid title: environment_id type: string metadata: $ref: '#/components/schemas/gitpod.v1.TaskMetadata' title: metadata spec: $ref: '#/components/schemas/gitpod.v1.TaskSpec' title: spec title: CreateTaskRequest type: object gitpod.v1.CreateTaskResponse: additionalProperties: false properties: task: $ref: '#/components/schemas/gitpod.v1.Task' title: task required: - task title: CreateTaskResponse type: object gitpod.v1.CreateTeamCreditAllocationRequest: additionalProperties: false properties: creditBudget: description: credit_budget is the allocated credit budget in whole credits. Must be > 0. exclusiveMinimum: true minimum: 0 title: credit_budget type: string organizationId: format: uuid title: organization_id type: string teamId: format: uuid title: team_id type: string required: - organizationId - teamId - creditBudget title: CreateTeamCreditAllocationRequest type: object gitpod.v1.CreateTeamCreditAllocationResponse: additionalProperties: false properties: allocation: $ref: '#/components/schemas/gitpod.v1.TeamCreditAllocationInfo' title: allocation title: CreateTeamCreditAllocationResponse type: object gitpod.v1.CreateTeamRequest: additionalProperties: false properties: name: maxLength: 80 minLength: 3 title: name type: string organizationId: format: uuid title: organization_id type: string title: CreateTeamRequest type: object gitpod.v1.CreateTeamResponse: additionalProperties: false properties: team: $ref: '#/components/schemas/gitpod.v1.Team' title: team title: CreateTeamResponse type: object gitpod.v1.CreateWarmPoolRequest: additionalProperties: false properties: desiredSize: deprecated: true description: "desired_size is the number of warm instances to maintain.\n Deprecated: Use min_size and max_size\ \ instead for dynamic scaling." format: int32 maximum: 20 minimum: 1 title: desired_size type: integer environmentClassId: description: "environment_class_id specifies which environment class to warm.\n Must be listed in the project's\ \ prebuild configuration environment_class_ids." format: uuid title: environment_class_id type: string maxSize: description: "max_size is the maximum number of warm instances to maintain.\n The pool will never scale above this\ \ value.\n Must be >= min_size and <= 20." format: int32 maximum: 20 minimum: 1 nullable: true title: max_size type: integer minSize: description: "min_size is the minimum number of warm instances to maintain.\n The pool will never scale below this\ \ value.\n Must be >= 0 and <= max_size. Set to 0 to allow full scale-down." format: int32 maximum: 20 nullable: true title: min_size type: integer projectId: description: "project_id specifies the project this warm pool belongs to.\n The project must have prebuilds enabled." format: uuid title: project_id type: string required: - projectId - environmentClassId title: CreateWarmPoolRequest type: object gitpod.v1.CreateWarmPoolResponse: additionalProperties: false properties: warmPool: $ref: '#/components/schemas/gitpod.v1.WarmPool' title: warm_pool required: - warmPool title: CreateWarmPoolResponse type: object gitpod.v1.CreateWebhookRequest: additionalProperties: false description: CreateWebhookRequest creates a new webhook. properties: description: description: description is an optional description of the webhook's purpose maxLength: 500 title: description type: string name: description: name is the display name of the webhook maxLength: 80 minLength: 1 title: name type: string organizationScope: $ref: '#/components/schemas/gitpod.v1.WebhookOrganizationScope' description: "organization_scope is the SCM organization scope for this webhook.\n For ORGANIZATION type: identifies\ \ the organization and its SCM host.\n When provided, takes precedence over the deprecated scope field." title: organization_scope provider: $ref: '#/components/schemas/gitpod.v1.WebhookProvider' description: provider is the Git provider not: enum: - 0 title: provider scope: deprecated: true description: "Deprecated: Use scopes instead.\n scope is the target of the webhook:\n - For REPOSITORY type: \"\ owner/repo\" (e.g., \"gitpod-io/gitpod\")\n - For ORGANIZATION type: \"owner\" (e.g., \"gitpod-io\")\n - Empty\ \ string is allowed for webhooks that don't require scope filtering" maxLength: 255 title: scope type: string scopes: description: "scopes is the list of repository scopes for this webhook.\n For REPOSITORY type: each entry represents\ \ a specific repository with full SCM data.\n When provided, takes precedence over the deprecated scope field." items: $ref: '#/components/schemas/gitpod.v1.WebhookRepositoryScope' maxItems: 100 title: scopes type: array type: $ref: '#/components/schemas/gitpod.v1.WebhookType' description: type determines the scope level of the webhook not: enum: - 0 title: type title: CreateWebhookRequest type: object gitpod.v1.CreateWebhookResponse: additionalProperties: false properties: webhook: $ref: '#/components/schemas/gitpod.v1.Webhook' title: webhook title: CreateWebhookResponse type: object gitpod.v1.CreateWorkflowRequest: additionalProperties: false description: CreateWorkflowRequest creates a new workflow. properties: action: $ref: '#/components/schemas/gitpod.v1.WorkflowAction' title: action description: description: 'Description must be at most 500 characters: ``` size(this) <= 500 ``` ' title: description type: string executor: $ref: '#/components/schemas/gitpod.v1.Subject' description: "Optional executor for the workflow. If not provided, defaults to the creator.\n Must be either the\ \ caller themselves or a service account." nullable: true title: executor name: description: 'Name must be between 1 and 80 characters: ``` size(this) >= 1 && size(this) <= 80 ``` ' title: name type: string report: $ref: '#/components/schemas/gitpod.v1.WorkflowAction' title: report triggers: description: 'Automation must have between 1 and 10 triggers: ``` size(this) >= 1 && size(this) <= 10 ``` ' items: $ref: '#/components/schemas/gitpod.v1.WorkflowTrigger' title: triggers type: array required: - action title: CreateWorkflowRequest type: object gitpod.v1.CreateWorkflowResponse: additionalProperties: false properties: workflow: $ref: '#/components/schemas/gitpod.v1.Workflow' title: workflow title: CreateWorkflowResponse type: object gitpod.v1.CreditCardVerificationStatus: enum: - CREDIT_CARD_VERIFICATION_STATUS_UNSPECIFIED - CREDIT_CARD_VERIFICATION_STATUS_PENDING - CREDIT_CARD_VERIFICATION_STATUS_REQUIRES_CONFIRMATION - CREDIT_CARD_VERIFICATION_STATUS_INVALID_CVC - CREDIT_CARD_VERIFICATION_STATUS_INVALID_NUMBER - CREDIT_CARD_VERIFICATION_STATUS_INSUFFICIENT_FUNDS - CREDIT_CARD_VERIFICATION_STATUS_EXPIRED_CARD - CREDIT_CARD_VERIFICATION_STATUS_FAILED - CREDIT_CARD_VERIFICATION_STATUS_SUCCESS - CREDIT_CARD_VERIFICATION_STATUS_NOT_REQUIRED title: CreditCardVerificationStatus type: string gitpod.v1.CreditStatus: enum: - CREDIT_STATUS_UNSPECIFIED - CREDIT_STATUS_OUT_OF_CREDITS - CREDIT_STATUS_LOW_ON_CREDITS - CREDIT_STATUS_HAS_CREDITS title: CreditStatus type: string gitpod.v1.CreditUsageDataPoint: additionalProperties: false description: A single data point in a credit consumption time series. properties: ocu: description: Cost in Ona Compute Units. format: double title: ocu type: number time: $ref: '#/components/schemas/google.protobuf.Timestamp' description: Start of the day (UTC midnight). title: time title: CreditUsageDataPoint type: object gitpod.v1.CreditsByType: additionalProperties: false description: CreditsByType contains credits consumed for a single usage type. properties: credits: format: double title: credits type: number usageType: $ref: '#/components/schemas/gitpod.v1.UsageType' title: usage_type title: CreditsByType type: object gitpod.v1.CrowdStrikeConfig: additionalProperties: false description: CrowdStrikeConfig configures CrowdStrike Falcon sensor deployment properties: additionalOptions: additionalProperties: title: value type: string description: "additional_options contains additional FALCONCTL_OPT_* options as key-value pairs.\n Keys should NOT\ \ include the FALCONCTL_OPT_ prefix." title: additional_options type: object cidSecretId: description: cid_secret_id references an organization secret containing the Customer ID (CID). format: uuid title: cid_secret_id type: string enabled: description: enabled controls whether CrowdStrike Falcon is deployed to environments title: enabled type: boolean image: description: image is the CrowdStrike Falcon sensor container image reference title: image type: string tags: description: tags are optional tags to apply to the Falcon sensor (comma-separated) title: tags type: string title: CrowdStrikeConfig type: object gitpod.v1.CrowdStrikeConfig.AdditionalOptionsEntry: additionalProperties: false properties: key: title: key type: string value: title: value type: string title: AdditionalOptionsEntry type: object gitpod.v1.CumulativeCreditUsage: additionalProperties: false description: CumulativeCreditUsage contains cumulative credit consumption totals. properties: totalCredits: description: Total credits consumed. format: double title: total_credits type: number usageByType: description: Credits consumed broken down by usage type. items: $ref: '#/components/schemas/gitpod.v1.CreditsByType' title: usage_by_type type: array title: CumulativeCreditUsage type: object gitpod.v1.CustomAgentEnvMapping: additionalProperties: false description: "CustomAgentEnvMapping maps a script placeholder to an organization secret.\n The backend resolves the\ \ secret name to a UUID at runtime." properties: name: description: name is the environment variable name used as a placeholder in the start command. title: name type: string secretName: description: secret_name is the name of the organization secret whose value populates this placeholder. title: secret_name type: string title: CustomAgentEnvMapping type: object gitpod.v1.CustomDomain: additionalProperties: false description: CustomDomain represents a custom domain configuration for an organization properties: awsAccountId: deprecated: true description: 'aws_account_id is the AWS account ID (deprecated: use cloud_account_id)' title: aws_account_id type: string cloudAccountId: description: cloud_account_id is the unified cloud account identifier (AWS Account ID or GCP Project ID) title: cloud_account_id type: string createdAt: $ref: '#/components/schemas/google.protobuf.Timestamp' description: created_at is when the custom domain was created title: created_at domainName: description: domain_name is the custom domain name maxLength: 253 minLength: 4 title: domain_name type: string id: description: id is the unique identifier of the custom domain format: uuid title: id type: string organizationId: description: organization_id is the ID of the organization this custom domain belongs to format: uuid title: organization_id type: string provider: $ref: '#/components/schemas/gitpod.v1.CustomDomainProvider' description: provider is the cloud provider for this custom domain title: provider updatedAt: $ref: '#/components/schemas/google.protobuf.Timestamp' description: updated_at is when the custom domain was last updated title: updated_at required: - id - organizationId - domainName - createdAt - updatedAt title: CustomDomain type: object gitpod.v1.CustomDomainProvider: description: CustomDomainProvider represents the cloud provider for custom domain configuration enum: - CUSTOM_DOMAIN_PROVIDER_UNSPECIFIED - CUSTOM_DOMAIN_PROVIDER_AWS - CUSTOM_DOMAIN_PROVIDER_GCP title: CustomDomainProvider type: string gitpod.v1.CustomSecurityAgent: additionalProperties: false description: CustomSecurityAgent defines a custom security agent configured by an organization admin. properties: description: description: description is a human-readable description of what this agent does title: description type: string enabled: description: enabled controls whether this custom agent is deployed to environments title: enabled type: boolean envMappings: description: "env_mappings maps script placeholders to organization secret names,\n resolved to secret values at\ \ runtime." items: $ref: '#/components/schemas/gitpod.v1.CustomAgentEnvMapping' title: env_mappings type: array id: description: "id is a unique identifier for this custom agent within the organization.\n Server-generated at save\ \ time if empty." title: id type: string name: description: name is the display name for this custom agent title: name type: string startCommand: description: start_command is the shell script that starts the agent title: start_command type: string title: CustomSecurityAgent type: object gitpod.v1.DailyCreditUsage: additionalProperties: false description: DailyCreditUsage contains credit usage for a single day. properties: date: $ref: '#/components/schemas/google.protobuf.Timestamp' description: Start of the day (midnight in the requested timezone). title: date orgUsage: description: Org-wide usage broken down by type. items: $ref: '#/components/schemas/gitpod.v1.CreditsByType' title: org_usage type: array teamUsage: description: "Per-team usage for this day (top teams + \"Others\").\n Empty team_id represents the \"Others\" aggregation\ \ bucket." items: $ref: '#/components/schemas/gitpod.v1.TeamCreditUsage' title: team_usage type: array userUsage: description: Per-user usage for this day (top users + "Others"). items: $ref: '#/components/schemas/gitpod.v1.UserCreditUsage' title: user_usage type: array title: DailyCreditUsage type: object gitpod.v1.DailyUsage: additionalProperties: false description: DailyUsage contains usage data for a single day properties: creditsConsumed: description: credits_consumed is the number of Ona credits consumed on this day format: double title: credits_consumed type: number date: $ref: '#/components/schemas/google.protobuf.Timestamp' description: date is the start of the day (midnight UTC) title: date title: DailyUsage type: object gitpod.v1.DateRange: additionalProperties: false description: DateRange specifies a time period for queries. properties: endTime: $ref: '#/components/schemas/google.protobuf.Timestamp' description: End time of the date range (exclusive). title: end_time startTime: $ref: '#/components/schemas/google.protobuf.Timestamp' description: Start time of the date range (inclusive). title: start_time required: - startTime - endTime title: DateRange type: object gitpod.v1.DeleteAccountRequest: additionalProperties: false properties: accountId: format: uuid title: account_id type: string reason: description: reason is an optional field for the reason for account deletion maxLength: 256 nullable: true title: reason type: string required: - accountId title: DeleteAccountRequest type: object gitpod.v1.DeleteAccountResponse: additionalProperties: false title: DeleteAccountResponse type: object gitpod.v1.DeleteAgentExecutionRequest: additionalProperties: false properties: agentExecutionId: format: uuid title: agent_execution_id type: string title: DeleteAgentExecutionRequest type: object gitpod.v1.DeleteAgentExecutionResponse: additionalProperties: false title: DeleteAgentExecutionResponse type: object gitpod.v1.DeleteAgentRequest: additionalProperties: false properties: agentId: description: The ID of the agent to delete format: uuid title: agent_id type: string title: DeleteAgentRequest type: object gitpod.v1.DeleteAgentResponse: additionalProperties: false title: DeleteAgentResponse type: object gitpod.v1.DeleteCustomDomainRequest: additionalProperties: false description: DeleteCustomDomainRequest is the request message for deleting a custom domain properties: organizationId: description: organization_id is the ID of the organization to delete custom domain for format: uuid title: organization_id type: string required: - organizationId title: DeleteCustomDomainRequest type: object gitpod.v1.DeleteCustomDomainResponse: additionalProperties: false description: DeleteCustomDomainResponse is the response message for deleting a custom domain title: DeleteCustomDomainResponse type: object gitpod.v1.DeleteDomainVerificationRequest: additionalProperties: false properties: domainVerificationId: format: uuid title: domain_verification_id type: string required: - domainVerificationId title: DeleteDomainVerificationRequest type: object gitpod.v1.DeleteDomainVerificationResponse: additionalProperties: false title: DeleteDomainVerificationResponse type: object gitpod.v1.DeleteEnvironmentRequest: additionalProperties: false properties: environmentId: description: "environment_id specifies the environment that is going to delete.\n\n +required" format: uuid title: environment_id type: string force: description: "force indicates whether the environment should be deleted forcefully\n When force deleting an Environment,\ \ the Environment is removed immediately and\n environment lifecycle is not respected.\n Force deleting can result\ \ in data loss on the environment." title: force type: boolean title: DeleteEnvironmentRequest type: object gitpod.v1.DeleteEnvironmentResponse: additionalProperties: false title: DeleteEnvironmentResponse type: object gitpod.v1.DeleteGroupRequest: additionalProperties: false description: DeleteGroup messages properties: groupId: format: uuid title: group_id type: string title: DeleteGroupRequest type: object gitpod.v1.DeleteGroupResponse: additionalProperties: false description: Empty response title: DeleteGroupResponse type: object gitpod.v1.DeleteHostAuthenticationTokenRequest: additionalProperties: false properties: id: format: uuid title: id type: string title: DeleteHostAuthenticationTokenRequest type: object gitpod.v1.DeleteHostAuthenticationTokenResponse: additionalProperties: false title: DeleteHostAuthenticationTokenResponse type: object gitpod.v1.DeleteIntegrationDefinitionRequest: additionalProperties: false properties: id: minLength: 1 title: id type: string title: DeleteIntegrationDefinitionRequest type: object gitpod.v1.DeleteIntegrationDefinitionResponse: additionalProperties: false title: DeleteIntegrationDefinitionResponse type: object gitpod.v1.DeleteIntegrationRequest: additionalProperties: false properties: id: format: uuid title: id type: string title: DeleteIntegrationRequest type: object gitpod.v1.DeleteIntegrationResponse: additionalProperties: false title: DeleteIntegrationResponse type: object gitpod.v1.DeleteLLMIntegrationRequest: additionalProperties: false properties: force: description: "force skips dependency checks and deletes the integration even if it would\n leave no enabled integration\ \ for a model in use" title: force type: boolean id: format: uuid title: id type: string title: DeleteLLMIntegrationRequest type: object gitpod.v1.DeleteLLMIntegrationResponse: additionalProperties: false title: DeleteLLMIntegrationResponse type: object gitpod.v1.DeleteMembershipRequest: additionalProperties: false description: DeleteMembership messages properties: membershipId: description: The membership to delete format: uuid title: membership_id type: string title: DeleteMembershipRequest type: object gitpod.v1.DeleteMembershipResponse: additionalProperties: false description: Empty response title: DeleteMembershipResponse type: object gitpod.v1.DeleteNotificationsRequest: additionalProperties: false properties: notificationIds: items: format: uuid maxItems: 25 minItems: 1 type: string maxItems: 25 minItems: 1 title: notification_ids type: array title: DeleteNotificationsRequest type: object gitpod.v1.DeleteNotificationsResponse: additionalProperties: false title: DeleteNotificationsResponse type: object gitpod.v1.DeleteOrganizationLLMConfigurationRequest: additionalProperties: false properties: organizationId: description: organization_id is the ID of the organization to delete configuration for format: uuid title: organization_id type: string title: DeleteOrganizationLLMConfigurationRequest type: object gitpod.v1.DeleteOrganizationLLMConfigurationResponse: additionalProperties: false title: DeleteOrganizationLLMConfigurationResponse type: object gitpod.v1.DeleteOrganizationRequest: additionalProperties: false properties: organizationId: description: organization_id is the ID of the organization to delete format: uuid title: organization_id type: string required: - organizationId title: DeleteOrganizationRequest type: object gitpod.v1.DeleteOrganizationResponse: additionalProperties: false title: DeleteOrganizationResponse type: object gitpod.v1.DeletePersonalAccessTokenRequest: additionalProperties: false properties: personalAccessTokenId: format: uuid title: personal_access_token_id type: string title: DeletePersonalAccessTokenRequest type: object gitpod.v1.DeletePersonalAccessTokenResponse: additionalProperties: false title: DeletePersonalAccessTokenResponse type: object gitpod.v1.DeletePrebuildRequest: additionalProperties: false properties: prebuildId: description: prebuild_id specifies the prebuild to delete format: uuid title: prebuild_id type: string required: - prebuildId title: DeletePrebuildRequest type: object gitpod.v1.DeletePrebuildResponse: additionalProperties: false title: DeletePrebuildResponse type: object gitpod.v1.DeletePreferenceRequest: additionalProperties: false properties: userPreferenceId: format: uuid title: user_preference_id type: string title: DeletePreferenceRequest type: object gitpod.v1.DeletePreferenceResponse: additionalProperties: false title: DeletePreferenceResponse type: object gitpod.v1.DeleteProjectPolicyRequest: additionalProperties: false description: DeleteProjectPolicyRequest deletes a Project Policy. properties: groupId: description: group_id specifies the group_id identifier format: uuid title: group_id type: string projectId: description: project_id specifies the project identifier format: uuid title: project_id type: string title: DeleteProjectPolicyRequest type: object gitpod.v1.DeleteProjectPolicyResponse: additionalProperties: false title: DeleteProjectPolicyResponse type: object gitpod.v1.DeleteProjectRequest: additionalProperties: false properties: projectId: description: project_id specifies the project identifier format: uuid title: project_id type: string title: DeleteProjectRequest type: object gitpod.v1.DeleteProjectResponse: additionalProperties: false title: DeleteProjectResponse type: object gitpod.v1.DeleteProjectsRequest: additionalProperties: false properties: projectIds: items: format: uuid maxItems: 100 minItems: 1 type: string maxItems: 100 minItems: 1 title: project_ids type: array title: DeleteProjectsRequest type: object gitpod.v1.DeleteProjectsResponse: additionalProperties: false properties: deletedProjectIds: description: deleted_project_ids contains the IDs of successfully deleted projects items: type: string title: deleted_project_ids type: array failedProjects: description: failed_projects contains details about projects that failed to delete items: $ref: '#/components/schemas/gitpod.v1.DeleteProjectsResponse.Failure' title: failed_projects type: array title: DeleteProjectsResponse type: object gitpod.v1.DeleteProjectsResponse.Failure: additionalProperties: false properties: error: description: error describes why the project deletion failed title: error type: string index: description: index is the position in the request array (0-based) format: int32 title: index type: integer projectId: description: project_id is the project ID that failed title: project_id type: string title: Failure type: object gitpod.v1.DeletePromptRequest: additionalProperties: false properties: promptId: format: uuid title: prompt_id type: string title: DeletePromptRequest type: object gitpod.v1.DeletePromptResponse: additionalProperties: false title: DeletePromptResponse type: object gitpod.v1.DeleteRoleAssignmentRequest: additionalProperties: false description: DeleteRoleAssignment messages properties: assignmentId: format: uuid title: assignment_id type: string title: DeleteRoleAssignmentRequest type: object gitpod.v1.DeleteRoleAssignmentResponse: additionalProperties: false description: Empty response title: DeleteRoleAssignmentResponse type: object gitpod.v1.DeleteRunnerManagerRequest: additionalProperties: false properties: runnerManagerId: format: uuid title: runner_manager_id type: string title: DeleteRunnerManagerRequest type: object gitpod.v1.DeleteRunnerManagerResponse: additionalProperties: false title: DeleteRunnerManagerResponse type: object gitpod.v1.DeleteRunnerPolicyRequest: additionalProperties: false description: DeleteRunnerPolicyRequest deletes a Project Policy. properties: groupId: description: group_id specifies the group_id identifier format: uuid title: group_id type: string runnerId: description: runner_id specifies the project identifier format: uuid title: runner_id type: string title: DeleteRunnerPolicyRequest type: object gitpod.v1.DeleteRunnerPolicyResponse: additionalProperties: false title: DeleteRunnerPolicyResponse type: object gitpod.v1.DeleteRunnerRequest: additionalProperties: false properties: force: description: "force indicates whether the runner should be deleted forcefully.\n When force deleting a Runner, all\ \ Environments on the runner are also force deleted and\n regular Runner lifecycle is not respected.\n Force deleting\ \ can result in data loss." title: force type: boolean runnerId: format: uuid title: runner_id type: string title: DeleteRunnerRequest type: object gitpod.v1.DeleteRunnerResponse: additionalProperties: false title: DeleteRunnerResponse type: object gitpod.v1.DeleteSCIMConfigurationRequest: additionalProperties: false properties: scimConfigurationId: description: scim_configuration_id is the ID of the SCIM configuration to delete format: uuid title: scim_configuration_id type: string required: - scimConfigurationId title: DeleteSCIMConfigurationRequest type: object gitpod.v1.DeleteSCIMConfigurationResponse: additionalProperties: false title: DeleteSCIMConfigurationResponse type: object gitpod.v1.DeleteSCMIntegrationRequest: additionalProperties: false properties: id: format: uuid title: id type: string title: DeleteSCMIntegrationRequest type: object gitpod.v1.DeleteSCMIntegrationResponse: additionalProperties: false title: DeleteSCMIntegrationResponse type: object gitpod.v1.DeleteSSOConfigurationRequest: additionalProperties: false properties: ssoConfigurationId: format: uuid title: sso_configuration_id type: string required: - ssoConfigurationId title: DeleteSSOConfigurationRequest type: object gitpod.v1.DeleteSSOConfigurationResponse: additionalProperties: false title: DeleteSSOConfigurationResponse type: object gitpod.v1.DeleteSecretRequest: additionalProperties: false properties: secretId: format: uuid title: secret_id type: string title: DeleteSecretRequest type: object gitpod.v1.DeleteSecretResponse: additionalProperties: false title: DeleteSecretResponse type: object gitpod.v1.DeleteServiceAccountRequest: additionalProperties: false properties: serviceAccountId: format: uuid title: service_account_id type: string title: DeleteServiceAccountRequest type: object gitpod.v1.DeleteServiceAccountResponse: additionalProperties: false title: DeleteServiceAccountResponse type: object gitpod.v1.DeleteServiceAccountTokenRequest: additionalProperties: false properties: serviceAccountTokenId: format: uuid title: service_account_token_id type: string title: DeleteServiceAccountTokenRequest type: object gitpod.v1.DeleteServiceAccountTokenResponse: additionalProperties: false title: DeleteServiceAccountTokenResponse type: object gitpod.v1.DeleteServiceRequest: additionalProperties: false properties: force: title: force type: boolean id: format: uuid title: id type: string title: DeleteServiceRequest type: object gitpod.v1.DeleteServiceResponse: additionalProperties: false title: DeleteServiceResponse type: object gitpod.v1.DeleteSessionRequest: additionalProperties: false properties: force: title: force type: boolean sessionId: format: uuid title: session_id type: string title: DeleteSessionRequest type: object gitpod.v1.DeleteSessionResponse: additionalProperties: false title: DeleteSessionResponse type: object gitpod.v1.DeleteTaskRequest: additionalProperties: false properties: id: format: uuid title: id type: string title: DeleteTaskRequest type: object gitpod.v1.DeleteTaskResponse: additionalProperties: false title: DeleteTaskResponse type: object gitpod.v1.DeleteTeamCreditAllocationRequest: additionalProperties: false properties: organizationId: format: uuid title: organization_id type: string teamId: format: uuid title: team_id type: string required: - organizationId - teamId title: DeleteTeamCreditAllocationRequest type: object gitpod.v1.DeleteTeamCreditAllocationResponse: additionalProperties: false title: DeleteTeamCreditAllocationResponse type: object gitpod.v1.DeleteTeamRequest: additionalProperties: false properties: teamId: format: uuid title: team_id type: string title: DeleteTeamRequest type: object gitpod.v1.DeleteTeamResponse: additionalProperties: false title: DeleteTeamResponse type: object gitpod.v1.DeleteUserRequest: additionalProperties: false properties: userId: format: uuid title: user_id type: string title: DeleteUserRequest type: object gitpod.v1.DeleteUserResponse: additionalProperties: false title: DeleteUserResponse type: object gitpod.v1.DeleteWarmPoolRequest: additionalProperties: false properties: warmPoolId: description: warm_pool_id specifies the warm pool to delete format: uuid title: warm_pool_id type: string required: - warmPoolId title: DeleteWarmPoolRequest type: object gitpod.v1.DeleteWarmPoolResponse: additionalProperties: false title: DeleteWarmPoolResponse type: object gitpod.v1.DeleteWebhookRequest: additionalProperties: false description: DeleteWebhookRequest deletes a webhook permanently. properties: webhookId: format: uuid title: webhook_id type: string title: DeleteWebhookRequest type: object gitpod.v1.DeleteWebhookResponse: additionalProperties: false properties: affectedWorkflowIds: description: "IDs of workflows that had their triggers converted to manual type\n because they referenced the deleted\ \ webhook." items: type: string title: affected_workflow_ids type: array title: DeleteWebhookResponse type: object gitpod.v1.DeleteWorkflowRequest: additionalProperties: false description: DeleteWorkflowRequest deletes a workflow permanently. properties: force: description: "force indicates whether to immediately delete the workflow and all related resources.\n When true,\ \ performs cascading deletion of:\n - All workflow executions\n - All workflow execution actions\n - All environments\ \ created by workflow actions\n - All agent executions created by workflow actions\n - The workflow itself\n When\ \ false (default), marks workflow executions for deletion and relies on\n background reconciliation to clean up\ \ resources." title: force type: boolean workflowId: format: uuid title: workflow_id type: string title: DeleteWorkflowRequest type: object gitpod.v1.DeleteWorkflowResponse: additionalProperties: false title: DeleteWorkflowResponse type: object gitpod.v1.DisableProjectInsightsRequest: additionalProperties: false description: DisableProjectInsightsRequest disables co-author insights for a project. properties: projectId: description: Project to disable insights for. format: uuid title: project_id type: string title: DisableProjectInsightsRequest type: object gitpod.v1.DisableProjectInsightsResponse: additionalProperties: false title: DisableProjectInsightsResponse type: object gitpod.v1.DomainVerification: additionalProperties: false properties: createdAt: $ref: '#/components/schemas/google.protobuf.Timestamp' title: created_at domain: maxLength: 253 minLength: 4 title: domain type: string id: format: uuid title: id type: string organizationId: format: uuid title: organization_id type: string state: $ref: '#/components/schemas/gitpod.v1.DomainVerificationState' title: state verificationToken: title: verification_token type: string verifiedAt: $ref: '#/components/schemas/google.protobuf.Timestamp' title: verified_at required: - id - organizationId - domain - state title: DomainVerification type: object gitpod.v1.DomainVerificationState: enum: - DOMAIN_VERIFICATION_STATE_UNSPECIFIED - DOMAIN_VERIFICATION_STATE_PENDING - DOMAIN_VERIFICATION_STATE_VERIFIED title: DomainVerificationState type: string gitpod.v1.DotfilesConfiguration: additionalProperties: false properties: repository: description: The URL of a dotfiles repository. format: uri title: repository type: string title: DotfilesConfiguration type: object gitpod.v1.Editor: additionalProperties: false properties: alias: title: alias type: string iconUrl: title: icon_url type: string id: format: uuid title: id type: string installationInstructions: title: installation_instructions type: string name: title: name type: string shortDescription: title: short_description type: string urlTemplate: title: url_template type: string versions: description: versions contains the list of available versions for this editor items: $ref: '#/components/schemas/gitpod.v1.EditorVersion' title: versions type: array required: - id - name - installationInstructions - urlTemplate title: Editor type: object gitpod.v1.EditorVersion: additionalProperties: false properties: version: description: "version is the version string of the editor\n Examples for JetBrains: 2025.2" title: version type: string required: - version title: EditorVersion type: object gitpod.v1.EditorVersionPolicy: additionalProperties: false description: EditorVersionPolicy defines the version policy for a specific editor properties: allowedVersions: description: "allowed_versions lists the versions that are allowed\n If empty, we will use the latest version of\ \ the editor\n\n Examples for JetBrains: `[\"2025.2\", \"2025.1\", \"2024.3\"]`" items: type: string title: allowed_versions type: array title: EditorVersionPolicy type: object gitpod.v1.EditorVersions: additionalProperties: false description: EditorVersions contains the recommended versions for an editor. properties: versions: description: "versions is the list of recommended versions for this editor.\n If empty, all available versions are\ \ recommended.\n Examples for JetBrains: [\"2025.1\", \"2024.3\"]" items: type: string title: versions type: array title: EditorVersions type: object gitpod.v1.EmitAgentSessionActivityRequest: additionalProperties: false properties: agentExecutionId: description: The agent execution ID. Used to resolve the organization for auth/token lookup. format: uuid title: agent_execution_id type: string externalAgentSessionId: description: "The external session ID (e.g., Linear agent session ID).\n The runner resolves this from annotations\ \ at startup and passes it directly,\n avoiding repeated annotation lookups on every emit call." minLength: 1 title: external_agent_session_id type: string nextStepsProposal: $ref: '#/components/schemas/gitpod.v1.NextStepsProposal' description: "Optional next steps proposal from the agent. Reported separately from\n response_block so integrations\ \ can decide whether and how to render it.\n The Linear integration ignores this; other integrations may render\ \ it." title: next_steps_proposal responseBlock: $ref: '#/components/schemas/gitpod.v1.AgentResponseBlock' description: "The structured response block to forward to the external session.\n The backend type-switches on the\ \ block's oneof output to decide how to render." title: response_block status: $ref: '#/components/schemas/gitpod.v1.AgentExecution.Status' description: "The current agent execution status. When present, the backend uses this\n for phase-specific emissions\ \ (thoughts, errors, keepalive, external URLs)\n instead of relying on the separate status reflection path.\n\ \ This field is optional for backward compatibility." title: status title: EmitAgentSessionActivityRequest type: object gitpod.v1.EmitAgentSessionActivityResponse: additionalProperties: false title: EmitAgentSessionActivityResponse type: object gitpod.v1.EnableProjectInsightsRequest: additionalProperties: false description: EnableProjectInsightsRequest enables co-author insights for a project. properties: projectId: description: Project to enable insights for. format: uuid title: project_id type: string title: EnableProjectInsightsRequest type: object gitpod.v1.EnableProjectInsightsResponse: additionalProperties: false title: EnableProjectInsightsResponse type: object gitpod.v1.EndLogSection: additionalProperties: false description: "EndLogSection defines the structure of JSON metadata for an end log section entry.\n Example log line:\n\ \ [section-end] {\"id\":\"section-id\",\"outcome\":\"LOG_SECTION_OUTCOME_SUCCESS\",\"secondsElapsed\":1.3}" properties: id: title: id type: string outcome: $ref: '#/components/schemas/gitpod.v1.LogSectionOutcome' description: outcome indicates the outcome of the log section. title: outcome secondsElapsed: description: seconds_elapsed is the number of seconds that have elapsed since the start of the log section. format: float title: seconds_elapsed type: number title: EndLogSection type: object gitpod.v1.Environment: additionalProperties: false description: +resource get environment properties: id: description: "ID is a unique identifier of this environment. No other environment with the\n same name must be managed\ \ by this environment manager" title: id type: string metadata: $ref: '#/components/schemas/gitpod.v1.EnvironmentMetadata' description: "Metadata is data associated with this environment that's required for other\n parts of Gitpod to function" title: metadata spec: $ref: '#/components/schemas/gitpod.v1.EnvironmentSpec' description: "Spec is the configuration of the environment that's required for the\n runner to start the environment" title: spec status: $ref: '#/components/schemas/gitpod.v1.EnvironmentStatus' description: Status is the current status of the environment title: status required: - id title: Environment type: object gitpod.v1.EnvironmentActivitySignal: additionalProperties: false description: EnvironmentActivitySignal used to signal activity for an environment. properties: source: description: "source of the activity signal, such as \"VS Code\", \"SSH\", or \"Automations\".\n It should be a\ \ human-readable string that describes the source of the activity signal." maxLength: 80 minLength: 3 title: source type: string timestamp: $ref: '#/components/schemas/google.protobuf.Timestamp' description: "timestamp of when the activity was observed by the source.\n Only reported every 5 minutes.\n Zero\ \ value means no activity was observed." title: timestamp title: EnvironmentActivitySignal type: object gitpod.v1.EnvironmentClass: additionalProperties: false properties: configuration: description: configuration describes the configuration of the environment class items: $ref: '#/components/schemas/gitpod.v1.FieldValue' title: configuration type: array description: description: description is a human readable description of the environment class maxLength: 200 minLength: 3 title: description type: string displayName: description: display_name is the human readable name of the environment class maxLength: 127 minLength: 3 title: display_name type: string enabled: description: "enabled indicates whether the environment class can be used to create\n new environments." title: enabled type: boolean id: description: id is the unique identifier of the environment class title: id type: string runnerId: description: runner_id is the unique identifier of the runner the environment class belongs to title: runner_id type: string required: - id - runnerId title: EnvironmentClass type: object gitpod.v1.EnvironmentClassValidationResult: additionalProperties: false properties: configurationErrors: items: $ref: '#/components/schemas/gitpod.v1.FieldValidationError' title: configuration_errors type: array descriptionError: nullable: true title: description_error type: string displayNameError: nullable: true title: display_name_error type: string valid: title: valid type: boolean title: EnvironmentClassValidationResult type: object gitpod.v1.EnvironmentGitStatus: additionalProperties: false properties: branch: description: branch is branch we're currently on title: branch type: string changedFiles: description: "changed_files is an array of changed files in the environment, possibly\n truncated" items: $ref: '#/components/schemas/gitpod.v1.FileChange' maxItems: 101 title: changed_files type: array cloneUrl: description: "clone_url is the repository url as you would pass it to \"git clone\".\n Only HTTPS clone URLs are\ \ supported." title: clone_url type: string latestCommit: description: latest_commit is the most recent commit on the current branch title: latest_commit type: string totalChangedFiles: format: int32 title: total_changed_files type: integer totalUnpushedCommits: description: the total number of unpushed changes format: int32 title: total_unpushed_commits type: integer unpushedCommits: description: "unpushed_commits is an array of unpushed changes in the environment, possibly\n truncated" items: maxItems: 101 type: string maxItems: 101 title: unpushed_commits type: array title: EnvironmentGitStatus type: object gitpod.v1.EnvironmentInitializer: additionalProperties: false description: EnvironmentInitializer specifies how an environment is to be initialized properties: specs: items: $ref: '#/components/schemas/gitpod.v1.EnvironmentInitializer.Spec' title: specs type: array title: EnvironmentInitializer type: object gitpod.v1.EnvironmentInitializer.Spec: additionalProperties: false oneOf: - not: anyOf: - required: - git required: - contextUrl - not: anyOf: - required: - contextUrl required: - git properties: contextUrl: $ref: '#/components/schemas/gitpod.v1.ContextURLInitializer' title: context_url git: $ref: '#/components/schemas/gitpod.v1.GitInitializer' title: git title: Spec type: object gitpod.v1.EnvironmentMaxLifetimeExceededDetails: additionalProperties: false description: "EnvironmentMaxLifetimeExceededDetails contains details about why an environment\n was rejected due to\ \ the maximum lifetime policy." properties: expiredAt: $ref: '#/components/schemas/google.protobuf.Timestamp' description: expired_at is the timestamp when the environment's lifetime expired (its lockdown_at value). title: expired_at policyValue: $ref: '#/components/schemas/google.protobuf.Duration' description: policy_value is the configured maximum environment lifetime duration. title: policy_value title: EnvironmentMaxLifetimeExceededDetails type: object gitpod.v1.EnvironmentMetadata: additionalProperties: false description: "EnvironmentMetadata is data associated with an environment that's required for\n other parts of the system\ \ to function" properties: annotations: additionalProperties: title: value type: string description: "annotations are key/value pairs that gets attached to the environment.\n +internal - not yet implemented" title: annotations type: object archivedAt: $ref: '#/components/schemas/google.protobuf.Timestamp' description: Time when the Environment was archived. If not set, the environment is not archived. title: archived_at createdAt: $ref: '#/components/schemas/google.protobuf.Timestamp' description: Time when the Environment was created. title: created_at creator: $ref: '#/components/schemas/gitpod.v1.Subject' description: creator is the identity of the creator of the environment title: creator lastStartedAt: $ref: '#/components/schemas/google.protobuf.Timestamp' description: Time when the Environment was last started (i.e. CreateEnvironment or StartEnvironment were called). title: last_started_at lockdownAt: $ref: '#/components/schemas/google.protobuf.Timestamp' description: "lockdown_at is the time at which the environment becomes locked down due\n to the organization's maximum\ \ environment lifetime policy. Nil when no\n lifetime policy applies." title: lockdown_at name: description: name is the name of the environment as specified by the user maxLength: 80 title: name type: string organizationId: description: organization_id is the ID of the organization that contains the environment format: uuid title: organization_id type: string originalContextUrl: description: "original_context_url is the normalized URL from which the environment was\n created" title: original_context_url type: string prebuildId: description: "prebuild_id is the ID of the prebuild this environment was created from.\n Only set if the environment\ \ was created from a prebuild." format: uuid nullable: true title: prebuild_id type: string projectId: description: If the Environment was started from a project, the project_id will reference the project. title: project_id type: string role: $ref: '#/components/schemas/gitpod.v1.EnvironmentRole' description: role is the role of the environment title: role runnerId: description: Runner is the ID of the runner that runs this environment. title: runner_id type: string sessionId: description: session_id is the ID of the session this environment belongs to. title: session_id type: string x-stainless-skip: true title: EnvironmentMetadata type: object gitpod.v1.EnvironmentMetadata.AnnotationsEntry: additionalProperties: false properties: key: title: key type: string value: title: value type: string title: AnnotationsEntry type: object gitpod.v1.EnvironmentPhase: enum: - ENVIRONMENT_PHASE_UNSPECIFIED - ENVIRONMENT_PHASE_CREATING - ENVIRONMENT_PHASE_STARTING - ENVIRONMENT_PHASE_RUNNING - ENVIRONMENT_PHASE_UPDATING - ENVIRONMENT_PHASE_STOPPING - ENVIRONMENT_PHASE_STOPPED - ENVIRONMENT_PHASE_DELETING - ENVIRONMENT_PHASE_DELETED title: EnvironmentPhase type: string gitpod.v1.EnvironmentRole: description: EnvironmentRole represents the role of an environment enum: - ENVIRONMENT_ROLE_UNSPECIFIED - ENVIRONMENT_ROLE_DEFAULT - ENVIRONMENT_ROLE_PREBUILD - ENVIRONMENT_ROLE_WORKFLOW title: EnvironmentRole type: string gitpod.v1.EnvironmentSpec: additionalProperties: false description: "EnvironmentSpec specifies the configuration of an environment for an environment\n start" properties: admission: $ref: '#/components/schemas/gitpod.v1.AdmissionLevel' description: admission controlls who can access the environment and its ports. title: admission automationsFile: $ref: '#/components/schemas/gitpod.v1.EnvironmentSpec.AutomationsFile' description: automations_file is the automations file spec of the environment title: automations_file content: $ref: '#/components/schemas/gitpod.v1.EnvironmentSpec.Content' description: content is the content spec of the environment title: content desiredPhase: $ref: '#/components/schemas/gitpod.v1.EnvironmentPhase' description: Phase is the desired phase of the environment title: desired_phase devcontainer: $ref: '#/components/schemas/gitpod.v1.EnvironmentSpec.DevContainer' description: devcontainer is the devcontainer spec of the environment title: devcontainer kernelControlsConfig: $ref: '#/components/schemas/gitpod.v1.KernelControlsConfig' description: kernel_controls_config configures kernel-level controls for this environment title: kernel_controls_config machine: $ref: '#/components/schemas/gitpod.v1.EnvironmentSpec.Machine' description: machine is the machine spec of the environment title: machine ports: description: ports is the set of ports which ought to be exposed to your network items: $ref: '#/components/schemas/gitpod.v1.EnvironmentSpec.EnvironmentPort' title: ports type: array secrets: description: secrets are confidential data that is mounted into the environment items: $ref: '#/components/schemas/gitpod.v1.EnvironmentSpec.Secret' title: secrets type: array specVersion: description: "version of the spec. The value of this field has no semantic\n meaning (e.g. don't interpret it as\ \ as a timestamp),\n but it can be used to impose a partial order. If a.spec_version <\n b.spec_version then a\ \ was the spec before b." title: spec_version type: string sshPublicKeys: description: ssh_public_keys are the public keys used to ssh into the environment items: $ref: '#/components/schemas/gitpod.v1.EnvironmentSpec.SSHPublicKey' title: ssh_public_keys type: array timeout: $ref: '#/components/schemas/gitpod.v1.EnvironmentSpec.Timeout' description: Timeout configures the environment timeout title: timeout workflowActionId: description: "workflow_action_id is an optional reference to the workflow execution action\n that created this environment.\ \ Used for tracking and event correlation." format: uuid nullable: true title: workflow_action_id type: string title: EnvironmentSpec type: object gitpod.v1.EnvironmentSpec.AutomationsFile: additionalProperties: false properties: automationsFilePath: description: "automations_file_path is the path to the automations file that is applied in the environment,\n relative\ \ to the repo root.\npath must not be absolute (start with a /):\n```\nthis.matches('^$|^[^/].*')\n```\n\n" title: automations_file_path type: string session: title: session type: string triggerFilter: description: "trigger_filter specifies which automation triggers should execute.\n When set, only automations matching\ \ these triggers will run.\n If empty/unset, all triggers are evaluated normally." items: $ref: '#/components/schemas/gitpod.v1.AutomationTrigger' title: trigger_filter type: array title: AutomationsFile type: object gitpod.v1.EnvironmentSpec.Content: additionalProperties: false properties: gitEmail: description: The Git email address title: git_email type: string gitUsername: description: The Git username title: git_username type: string initializer: $ref: '#/components/schemas/gitpod.v1.EnvironmentInitializer' description: initializer configures how the environment is to be initialized title: initializer session: title: session type: string title: Content type: object gitpod.v1.EnvironmentSpec.DevContainer: additionalProperties: false properties: defaultDevcontainerImage: description: default_devcontainer_image is the default image that is used to start the devcontainer if no devcontainer config file is found title: default_devcontainer_image type: string devcontainerFilePath: description: 'devcontainer_file_path is the path to the devcontainer file relative to the repo root path must not be absolute (start with a /): ``` this.matches(''^$|^[^/].*'') ``` ' title: devcontainer_file_path type: string dotfiles: $ref: '#/components/schemas/gitpod.v1.EnvironmentSpec.DevContainer.Dotfiles' description: 'Experimental: dotfiles is the dotfiles configuration of the devcontainer' title: dotfiles lifecycleStage: $ref: '#/components/schemas/gitpod.v1.EnvironmentSpec.DevContainer.LifecycleStage' description: "lifecycle_stage controls which devcontainer lifecycle commands are executed.\n Defaults to FULL if\ \ not specified." title: lifecycle_stage session: title: session type: string title: DevContainer type: object gitpod.v1.EnvironmentSpec.DevContainer.Dotfiles: additionalProperties: false properties: repository: description: URL of a dotfiles Git repository (e.g. https://github.com/owner/repository) format: uri title: repository type: string required: - repository title: Dotfiles type: object gitpod.v1.EnvironmentSpec.DevContainer.LifecycleStage: description: "LifecycleStage controls which devcontainer lifecycle commands are executed.\n See https://containers.dev/implementors/json_reference/#lifecycle-scripts" enum: - LIFECYCLE_STAGE_UNSPECIFIED - LIFECYCLE_STAGE_FULL - LIFECYCLE_STAGE_PREBUILD title: LifecycleStage type: string gitpod.v1.EnvironmentSpec.EnvironmentPort: additionalProperties: false properties: admission: $ref: '#/components/schemas/gitpod.v1.AdmissionLevel' description: policy of this port title: admission authNonce: description: "auth_nonce is a monotonically increasing counter incremented by the\n backend whenever the port's\ \ admission level changes. Used by the proxy\n to invalidate browser auth cookies without requiring a backend\ \ round-trip." title: auth_nonce type: string x-stainless-skip: true name: description: name of this port maxLength: 100 minLength: 1 title: name type: string port: description: port number format: int32 maximum: 65535 minimum: 1024 title: port type: integer protocol: $ref: '#/components/schemas/gitpod.v1.EnvironmentSpec.EnvironmentPort.Protocol' description: "protocol for communication (Gateway proxy → user environment service).\n this setting only affects\ \ the protocol used between Gateway and user environment services." title: protocol title: EnvironmentPort type: object gitpod.v1.EnvironmentSpec.EnvironmentPort.Protocol: description: Protocol describes the communication protocol between Gateway and user environment services. enum: - PROTOCOL_UNSPECIFIED - PROTOCOL_HTTP - PROTOCOL_HTTPS title: Protocol type: string gitpod.v1.EnvironmentSpec.Machine: additionalProperties: false properties: class: description: Class denotes the class of the environment we ought to start title: class type: string preferDualDisk: description: "prefer_dual_disk indicates the management plane wants this environment\n to use a dual-disk layout\ \ (separate system and data disks). The runner\n may ignore this if it does not support dual-disk." title: prefer_dual_disk type: boolean x-stainless-skip: true session: title: session type: string title: Machine type: object gitpod.v1.EnvironmentSpec.SSHPublicKey: additionalProperties: false properties: id: description: id is the unique identifier of the public key title: id type: string value: description: value is the actual public key in the public key file format title: value type: string title: SSHPublicKey type: object gitpod.v1.EnvironmentSpec.Secret: additionalProperties: false oneOf: - not: anyOf: - required: - containerRegistryBasicAuthHost - required: - environmentVariable - required: - filePath - required: - gitCredentialHost required: - apiOnly - not: anyOf: - required: - apiOnly - required: - environmentVariable - required: - filePath - required: - gitCredentialHost required: - containerRegistryBasicAuthHost - not: anyOf: - required: - apiOnly - required: - containerRegistryBasicAuthHost - required: - filePath - required: - gitCredentialHost required: - environmentVariable - not: anyOf: - required: - apiOnly - required: - containerRegistryBasicAuthHost - required: - environmentVariable - required: - gitCredentialHost required: - filePath - not: anyOf: - required: - apiOnly - required: - containerRegistryBasicAuthHost - required: - environmentVariable - required: - filePath required: - gitCredentialHost properties: apiOnly: description: "api_only indicates the secret is only available via API/CLI.\n These secrets are resolved but NOT\ \ automatically injected into services or devcontainers." title: api_only type: boolean containerRegistryBasicAuthHost: description: container_registry_basic_auth_host is the hostname of the container registry that supports basic auth title: container_registry_basic_auth_host type: string credentialProxy: $ref: '#/components/schemas/gitpod.v1.EnvironmentSpec.Secret.CredentialProxy' description: "credential_proxy configures transparent credential injection via the\n credential proxy. When set,\ \ the credential proxy intercepts HTTPS\n traffic to the target hosts and replaces the dummy secret value with\n\ \ the real value in the specified HTTP header. The real secret value is\n never exposed in the environment.\n\ \ This field is orthogonal to mount — a secret can be both mounted (e.g.\n as a git credential) and proxied at\ \ the same time." title: credential_proxy environmentVariable: title: environment_variable type: string filePath: description: file_path is the path inside the devcontainer where the secret is mounted title: file_path type: string gitCredentialHost: title: git_credential_host type: string id: description: id is the unique identifier of the secret. title: id type: string name: description: name is the human readable description of the secret title: name type: string scope: $ref: '#/components/schemas/gitpod.v1.EnvironmentSpec.Secret.Scope' description: "scope indicates where this secret originated from.\n Used to filter secrets during build (only org\ \ and project secrets are injected)." title: scope session: description: "session indicated the current session of the secret.\n When the session does not change, secrets are\ \ not reloaded in the environment." title: session type: string source: description: source is the source of the secret, for now control-plane or runner title: source type: string sourceRef: description: source_ref into the source, in case of control-plane this is uuid of the secret title: source_ref type: string title: Secret type: object gitpod.v1.EnvironmentSpec.Secret.CredentialProxy: additionalProperties: false description: "CredentialProxy describes how the credential proxy should inject this\n secret into outgoing HTTPS requests." properties: format: $ref: '#/components/schemas/gitpod.v1.EnvironmentSpec.Secret.CredentialProxy.Format' description: "format describes how the secret value is encoded. The proxy uses\n this to decode the value before\ \ injecting it into the header." title: format header: description: header is the HTTP header name to inject (e.g. "Authorization"). title: header type: string targetHosts: description: "target_hosts lists the hostnames to intercept (for example\n \"github.com\" or \"*.github.com\").\ \ Wildcards are subdomain-only and\n do not match the apex domain." items: type: string title: target_hosts type: array title: CredentialProxy type: object gitpod.v1.EnvironmentSpec.Secret.CredentialProxy.Format: enum: - FORMAT_UNSPECIFIED - FORMAT_PLAIN - FORMAT_BASE64 title: Format type: string gitpod.v1.EnvironmentSpec.Secret.Scope: description: Scope indicates the origin of the secret for filtering purposes. enum: - SCOPE_UNSPECIFIED - SCOPE_ORGANIZATION - SCOPE_PROJECT - SCOPE_USER - SCOPE_SERVICE_ACCOUNT - SCOPE_RUNNER title: Scope type: string gitpod.v1.EnvironmentSpec.Timeout: additionalProperties: false description: Timeout configures the environment timeout properties: disconnected: $ref: '#/components/schemas/google.protobuf.Duration' description: "inacitivity is the maximum time of disconnection before the environment is\n stopped or paused. Minimum\ \ duration is 30 minutes. Set to 0 to disable.\nvalue must be 0s (disabled) or at least 1800s (30 minutes):\n\ ```\nthis == duration('0s') || this >= duration('1800s')\n```\n\n" title: disconnected title: Timeout type: object gitpod.v1.EnvironmentStatus: additionalProperties: false description: EnvironmentStatus describes an environment status properties: activitySignal: $ref: '#/components/schemas/gitpod.v1.EnvironmentActivitySignal' description: activity_signal is the last activity signal for the environment. title: activity_signal automationsFile: $ref: '#/components/schemas/gitpod.v1.EnvironmentStatus.AutomationsFile' description: automations_file contains the status of the automations file. title: automations_file content: $ref: '#/components/schemas/gitpod.v1.EnvironmentStatus.Content' description: content contains the status of the environment content. title: content devcontainer: $ref: '#/components/schemas/gitpod.v1.EnvironmentStatus.DevContainer' description: devcontainer contains the status of the devcontainer. title: devcontainer environmentUrls: $ref: '#/components/schemas/gitpod.v1.EnvironmentStatus.EnvironmentURLs' description: "environment_url contains the URL at which the environment can be accessed.\n This field is only set\ \ if the environment is running." title: environment_urls failureMessage: description: "failure_message summarises why the environment failed to operate. If this is non-empty\n the environment\ \ has failed to operate and will likely transition to a stopped state." items: type: string title: failure_message type: array machine: $ref: '#/components/schemas/gitpod.v1.EnvironmentStatus.Machine' description: machine contains the status of the environment machine title: machine phase: $ref: '#/components/schemas/gitpod.v1.EnvironmentPhase' description: "the phase of an environment is a simple, high-level summary of where the\n environment is in its lifecycle" title: phase runnerAck: $ref: '#/components/schemas/gitpod.v1.EnvironmentStatus.RunnerACK' description: "runner_ack contains the acknowledgement from the runner that is has\n received the environment spec." title: runner_ack secrets: description: secrets contains the status of the environment secrets items: $ref: '#/components/schemas/gitpod.v1.EnvironmentStatus.Secret' title: secrets type: array sshPublicKeys: description: ssh_public_keys contains the status of the environment ssh public keys items: $ref: '#/components/schemas/gitpod.v1.EnvironmentStatus.SSHPublicKey' title: ssh_public_keys type: array statusVersion: description: "version of the status update. Environment instances themselves are\n unversioned, but their status\ \ has different versions. The value of this\n field has no semantic meaning (e.g. don't interpret it as as a timestamp),\n\ \ but it can be used to impose a partial order. If a.status_version <\n b.status_version then a was the status\ \ before b." title: status_version type: string warningMessage: description: warning_message contains warnings, e.g. when the environment is present but not in the expected state. items: type: string title: warning_message type: array title: EnvironmentStatus type: object gitpod.v1.EnvironmentStatus.AutomationsFile: additionalProperties: false properties: automationsFilePath: description: automations_file_path is the path to the automations file relative to the repo root. title: automations_file_path type: string automationsFilePresence: $ref: '#/components/schemas/gitpod.v1.EnvironmentStatus.AutomationsFile.Presence' description: automations_file_presence indicates how an automations file is present in the environment. title: automations_file_presence failureMessage: description: "failure_message contains the reason the automations file failed to be applied.\n This is only set\ \ if the phase is FAILED." title: failure_message type: string phase: $ref: '#/components/schemas/gitpod.v1.EnvironmentStatus.ContentPhase' description: phase is the current phase of the automations file. title: phase session: description: session is the automations file session that is currently applied in the environment. title: session type: string warningMessage: description: warning_message contains warnings, e.g. when no triggers are defined in the automations file. title: warning_message type: string title: AutomationsFile type: object gitpod.v1.EnvironmentStatus.AutomationsFile.Presence: enum: - PRESENCE_UNSPECIFIED - PRESENCE_ABSENT - PRESENCE_DISCOVERED - PRESENCE_SPECIFIED title: Presence type: string gitpod.v1.EnvironmentStatus.Content: additionalProperties: false properties: contentLocationInMachine: description: content_location_in_machine is the location of the content in the machine title: content_location_in_machine type: string failureMessage: description: failure_message contains the reason the content initialization failed. title: failure_message type: string git: $ref: '#/components/schemas/gitpod.v1.EnvironmentGitStatus' description: "git is the Git working copy status of the environment.\n Note: this is a best-effort field and more\ \ often than not will not be\n present. Its absence does not indicate the absence of a working copy." title: git phase: $ref: '#/components/schemas/gitpod.v1.EnvironmentStatus.ContentPhase' description: phase is the current phase of the environment content title: phase session: description: session is the session that is currently active in the environment. title: session type: string warningMessage: description: warning_message contains warnings, e.g. when the content is present but not in the expected state. title: warning_message type: string title: Content type: object gitpod.v1.EnvironmentStatus.ContentPhase: enum: - CONTENT_PHASE_UNSPECIFIED - CONTENT_PHASE_CREATING - CONTENT_PHASE_INITIALIZING - CONTENT_PHASE_READY - CONTENT_PHASE_UPDATING - CONTENT_PHASE_FAILED - CONTENT_PHASE_UNAVAILABLE title: ContentPhase type: string gitpod.v1.EnvironmentStatus.DevContainer: additionalProperties: false properties: containerId: description: container_id is the ID of the container. title: container_id type: string containerName: description: container_name is the name of the container that is used to connect to the devcontainer title: container_name type: string devcontainerFilePath: description: devcontainer_file_path is the path to the devcontainer file relative to the repo root title: devcontainer_file_path type: string devcontainerFilePresence: $ref: '#/components/schemas/gitpod.v1.EnvironmentStatus.DevContainer.Presence' description: devcontainer_file_presence indicates how the devcontainer file is present in the repo. title: devcontainer_file_presence devcontainerconfigInSync: description: devcontainerconfig_in_sync indicates if the devcontainer is up to date w.r.t. the devcontainer config file. title: devcontainerconfig_in_sync type: boolean failureMessage: description: failure_message contains the reason the devcontainer failed to operate. title: failure_message type: string phase: $ref: '#/components/schemas/gitpod.v1.EnvironmentStatus.DevContainer.Phase' description: phase is the current phase of the devcontainer title: phase remoteUser: description: remote_user is the user that is used to connect to the devcontainer title: remote_user type: string remoteWorkspaceFolder: description: remote_workspace_folder is the folder that is used to connect to the devcontainer title: remote_workspace_folder type: string secretsInSync: description: secrets_in_sync indicates if the secrets are up to date w.r.t. the running devcontainer. title: secrets_in_sync type: boolean session: description: session is the session that is currently active in the devcontainer. title: session type: string warningMessage: description: warning_message contains warnings, e.g. when the devcontainer is present but not in the expected state. title: warning_message type: string title: DevContainer type: object gitpod.v1.EnvironmentStatus.DevContainer.Phase: enum: - PHASE_UNSPECIFIED - PHASE_CREATING - PHASE_RUNNING - PHASE_STOPPED - PHASE_FAILED title: Phase type: string gitpod.v1.EnvironmentStatus.DevContainer.Presence: enum: - PRESENCE_UNSPECIFIED - PRESENCE_GENERATED - PRESENCE_DISCOVERED - PRESENCE_SPECIFIED title: Presence type: string gitpod.v1.EnvironmentStatus.EnvironmentPortURL: additionalProperties: false properties: port: description: port is the port number of the environment port format: int32 maximum: 65535 minimum: 1024 title: port type: integer url: description: url is the URL at which the environment port can be accessed title: url type: string title: EnvironmentPortURL type: object gitpod.v1.EnvironmentStatus.EnvironmentSSHURL: additionalProperties: false properties: url: title: url type: string title: EnvironmentSSHURL type: object gitpod.v1.EnvironmentStatus.EnvironmentURLs: additionalProperties: false properties: logs: description: logs is the URL at which the environment logs can be accessed. title: logs type: string ops: description: ops is the URL at which the environment ops service can be accessed. title: ops type: string ports: items: $ref: '#/components/schemas/gitpod.v1.EnvironmentStatus.EnvironmentPortURL' title: ports type: array ssh: $ref: '#/components/schemas/gitpod.v1.EnvironmentStatus.EnvironmentSSHURL' description: SSH is the URL at which the environment can be accessed via SSH. title: ssh supportBundle: description: support_bundle is the URL at which the environment support bundle can be accessed. title: support_bundle type: string vmLiveUsage: description: vm_live_usage is the URL at which the environment's live VM resource usage can be accessed. title: vm_live_usage type: string x-stainless-skip: true title: EnvironmentURLs type: object gitpod.v1.EnvironmentStatus.Machine: additionalProperties: false properties: dualDisk: description: "dual_disk indicates the environment is running with a dual-disk layout\n (separate system and data\ \ disks). Set by the runner based on actual\n machine configuration." title: dual_disk type: boolean x-stainless-skip: true failureMessage: description: failure_message contains the reason the machine failed to operate. title: failure_message type: string phase: $ref: '#/components/schemas/gitpod.v1.EnvironmentStatus.Machine.Phase' description: phase is the current phase of the environment machine title: phase session: description: session is the session that is currently active in the machine. title: session type: string timeout: description: "timeout contains the reason the environment has timed out. If this field is\n empty, the environment\ \ has not timed out." title: timeout type: string versions: $ref: '#/components/schemas/gitpod.v1.EnvironmentStatus.Machine.Versions' description: versions contains the versions of components in the machine. title: versions warningMessage: description: warning_message contains warnings, e.g. when the machine is present but not in the expected state. title: warning_message type: string title: Machine type: object gitpod.v1.EnvironmentStatus.Machine.Phase: enum: - PHASE_UNSPECIFIED - PHASE_CREATING - PHASE_STARTING - PHASE_RUNNING - PHASE_STOPPING - PHASE_STOPPED - PHASE_DELETING - PHASE_DELETED title: Phase type: string gitpod.v1.EnvironmentStatus.Machine.Versions: additionalProperties: false properties: amiId: title: ami_id type: string supervisorCommit: title: supervisor_commit type: string supervisorVersion: title: supervisor_version type: string title: Versions type: object gitpod.v1.EnvironmentStatus.RunnerACK: additionalProperties: false description: "RunnerACK is the acknowledgement from the runner that is has received the\n environment spec." properties: message: title: message type: string specVersion: title: spec_version type: string statusCode: $ref: '#/components/schemas/gitpod.v1.EnvironmentStatus.RunnerACK.StatusCode' title: status_code title: RunnerACK type: object gitpod.v1.EnvironmentStatus.RunnerACK.StatusCode: enum: - STATUS_CODE_UNSPECIFIED - STATUS_CODE_OK - STATUS_CODE_INVALID_RESOURCE - STATUS_CODE_FAILED_PRECONDITION title: StatusCode type: string gitpod.v1.EnvironmentStatus.SSHPublicKey: additionalProperties: false properties: id: description: id is the unique identifier of the public key title: id type: string phase: $ref: '#/components/schemas/gitpod.v1.EnvironmentStatus.ContentPhase' description: phase is the current phase of the public key title: phase title: SSHPublicKey type: object gitpod.v1.EnvironmentStatus.Secret: additionalProperties: false properties: failureMessage: description: failure_message contains the reason the secret failed to be materialize. title: failure_message type: string id: description: id is the unique identifier of the secret. title: id type: string phase: $ref: '#/components/schemas/gitpod.v1.EnvironmentStatus.ContentPhase' title: phase secretName: title: secret_name type: string session: description: session is the session that is currently active in the environment. title: session type: string warningMessage: description: warning_message contains warnings, e.g. when the secret is present but not in the expected state. title: warning_message type: string title: Secret type: object gitpod.v1.EnvironmentUsageRecord: additionalProperties: false description: EnvironmentUsageRecord represents a record of an environment from start to stop. properties: createdAt: $ref: '#/components/schemas/google.protobuf.Timestamp' description: Time when the environment was created. title: created_at environmentClassId: description: Environment class ID associated with the record. title: environment_class_id type: string environmentId: description: Environment ID associated with the record. title: environment_id type: string id: description: Environment usage record ID. title: id type: string projectId: description: Project ID associated with the environment (if available). title: project_id type: string runnerId: description: Runner ID associated with the environment. title: runner_id type: string stoppedAt: $ref: '#/components/schemas/google.protobuf.Timestamp' description: Time when the environment was stopped. title: stopped_at userId: description: User ID is the ID of the user who created the environment associated with the record. title: user_id type: string title: EnvironmentUsageRecord type: object gitpod.v1.EnvironmentVariableItem: additionalProperties: false description: "EnvironmentVariableItem represents an environment variable that can be set\n either from a literal value\ \ or from a secret reference." oneOf: - not: anyOf: - required: - valueFrom required: - value - not: anyOf: - required: - value required: - valueFrom properties: name: description: name is the environment variable name. minLength: 1 title: name type: string value: description: value is a literal string value. title: value type: string valueFrom: $ref: '#/components/schemas/gitpod.v1.EnvironmentVariableSource' description: value_from specifies a source for the value. title: value_from title: EnvironmentVariableItem type: object gitpod.v1.EnvironmentVariableSource: additionalProperties: false description: EnvironmentVariableSource specifies a source for an environment variable value. oneOf: - required: - secretRef properties: secretRef: $ref: '#/components/schemas/gitpod.v1.SecretRef' description: secret_ref references a secret by ID. title: secret_ref title: EnvironmentVariableSource type: object gitpod.v1.ErrorAction: additionalProperties: false description: ErrorAction describes a single action a user can take to resolve an error. oneOf: - not: anyOf: - required: - externalUrl required: - dashboardPath - not: anyOf: - required: - dashboardPath required: - externalUrl properties: actionId: description: Machine-readable action identifier (e.g. "configure_git_auth", "view_docs"). title: action_id type: string dashboardPath: description: Internal dashboard route (e.g. "/settings/git-authentication"). title: dashboard_path type: string externalUrl: description: External URL (e.g. "https://ona.com/docs/..."). title: external_url type: string label: description: Human-readable button label (e.g. "Configure Git Authentication"). title: label type: string title: ErrorAction type: object gitpod.v1.ErrorEvent: additionalProperties: false description: ErrorEvent contains comprehensive error information (Sentry-compatible) properties: breadcrumbs: description: Breadcrumbs leading up to the error items: $ref: '#/components/schemas/gitpod.v1.Breadcrumb' maxItems: 100 title: breadcrumbs type: array environment: description: Environment (e.g., "production", "staging", "development") maxLength: 100 title: environment type: string eventId: description: Unique event identifier (required by Sentry) maxLength: 32 minLength: 32 pattern: ^[a-f0-9]{32}$ title: event_id type: string exceptions: description: Exception information (primary error data) items: $ref: '#/components/schemas/gitpod.v1.ExceptionInfo' maxItems: 10 minItems: 1 title: exceptions type: array extra: additionalProperties: maxLength: 1000 title: value type: string description: Additional arbitrary metadata maxProperties: 50 title: extra type: object fingerprint: description: Custom fingerprint for grouping items: maxItems: 10 maxLength: 200 minLength: 1 type: string maxItems: 10 title: fingerprint type: array identityId: description: Identity ID of the user (UUID) pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$ title: identity_id type: string level: $ref: '#/components/schemas/gitpod.v1.ErrorLevel' description: Error severity level title: level logger: description: Logger name maxLength: 200 title: logger type: string modules: additionalProperties: maxLength: 100 title: value type: string description: Modules/dependencies information maxProperties: 100 title: modules type: object platform: description: Platform identifier (required by Sentry) maxLength: 100 minLength: 1 title: platform type: string release: description: Release version maxLength: 200 title: release type: string request: $ref: '#/components/schemas/gitpod.v1.RequestInfo' description: Request information title: request sdk: additionalProperties: maxLength: 200 title: value type: string description: SDK information maxProperties: 10 title: sdk type: object serverName: description: Server/host name maxLength: 200 title: server_name type: string tags: additionalProperties: maxLength: 200 title: value type: string description: Tags for filtering and grouping maxProperties: 50 title: tags type: object timestamp: $ref: '#/components/schemas/google.protobuf.Timestamp' description: When the event occurred (required by Sentry) title: timestamp transaction: description: Transaction name (e.g., route name, function name) maxLength: 200 title: transaction type: string title: ErrorEvent type: object gitpod.v1.ErrorEvent.ExtraEntry: additionalProperties: false properties: key: title: key type: string value: title: value type: string title: ExtraEntry type: object gitpod.v1.ErrorEvent.ModulesEntry: additionalProperties: false properties: key: title: key type: string value: title: value type: string title: ModulesEntry type: object gitpod.v1.ErrorEvent.SdkEntry: additionalProperties: false properties: key: title: key type: string value: title: value type: string title: SdkEntry type: object gitpod.v1.ErrorEvent.TagsEntry: additionalProperties: false properties: key: title: key type: string value: title: value type: string title: TagsEntry type: object gitpod.v1.ErrorLevel: description: Error severity levels (aligned with Sentry levels) enum: - ERROR_LEVEL_UNSPECIFIED - ERROR_LEVEL_DEBUG - ERROR_LEVEL_INFO - ERROR_LEVEL_WARNING - ERROR_LEVEL_ERROR - ERROR_LEVEL_FATAL title: ErrorLevel type: string gitpod.v1.EventAgentExecutionSpecChange: additionalProperties: false properties: agentExecutionId: description: The agent execution's ID format: uuid title: agent_execution_id type: string title: EventAgentExecutionSpecChange type: object gitpod.v1.EventEnvironmentMarkedActive: additionalProperties: false properties: environmentId: description: The environment's ID format: uuid title: environment_id type: string title: EventEnvironmentMarkedActive type: object gitpod.v1.EventEnvironmentSpecChange: additionalProperties: false properties: environmentId: description: The environment's ID format: uuid title: environment_id type: string title: EventEnvironmentSpecChange type: object gitpod.v1.EventHostAuthenticationTokenDeleted: additionalProperties: false properties: host: description: The host authentication token's host. title: host type: string principalId: description: The principal ID of the deleted token. format: uuid title: principal_id type: string title: EventHostAuthenticationTokenDeleted type: object gitpod.v1.EventIntegrationChange: additionalProperties: false properties: integrationId: description: The integration's ID format: uuid title: integration_id type: string title: EventIntegrationChange type: object gitpod.v1.EventLLMIntegrationChange: additionalProperties: false properties: llmIntegrationId: description: The LLM integration's ID format: uuid title: llm_integration_id type: string title: EventLLMIntegrationChange type: object gitpod.v1.EventRunnerConfigurationChange: additionalProperties: false title: EventRunnerConfigurationChange type: object gitpod.v1.EventSCMIntegrationChange: additionalProperties: false properties: scmIntegrationId: description: The SCM integration's ID format: uuid title: scm_integration_id type: string title: EventSCMIntegrationChange type: object gitpod.v1.EventSnapshotSpecChange: additionalProperties: false properties: snapshotId: description: The snapshot's ID format: uuid title: snapshot_id type: string title: EventSnapshotSpecChange type: object gitpod.v1.EventWarmPoolSpecChange: additionalProperties: false properties: warmPoolId: description: The warm pool's ID format: uuid title: warm_pool_id type: string title: EventWarmPoolSpecChange type: object gitpod.v1.ExceptionInfo: additionalProperties: false description: Exception information (Sentry-compatible) properties: mechanism: $ref: '#/components/schemas/gitpod.v1.ExceptionMechanism' description: Exception mechanism title: mechanism module: description: Module or package where the exception type is defined maxLength: 200 title: module type: string stacktrace: description: Stack trace frames items: $ref: '#/components/schemas/gitpod.v1.StackFrame' maxItems: 100 title: stacktrace type: array threadId: description: Thread ID if applicable maxLength: 100 title: thread_id type: string type: description: Exception type/class name maxLength: 200 minLength: 1 title: type type: string value: description: Exception message/value maxLength: 10000 title: value type: string title: ExceptionInfo type: object gitpod.v1.ExceptionMechanism: additionalProperties: false description: Exception mechanism information (Sentry-compatible) properties: data: additionalProperties: maxLength: 1000 title: value type: string description: Additional mechanism-specific data maxProperties: 20 title: data type: object description: description: Human-readable description of the mechanism maxLength: 1000 title: description type: string handled: description: Whether the exception was handled by user code title: handled type: boolean synthetic: description: Whether this is a synthetic exception (created by SDK) title: synthetic type: boolean type: description: Type of mechanism (e.g., "generic", "promise", "onerror") maxLength: 100 minLength: 1 title: type type: string title: ExceptionMechanism type: object gitpod.v1.ExceptionMechanism.DataEntry: additionalProperties: false properties: key: title: key type: string value: title: value type: string title: DataEntry type: object gitpod.v1.ExchangeTokenRequest: additionalProperties: false properties: exchangeToken: description: exchange_token is the token to exchange title: exchange_token type: string title: ExchangeTokenRequest type: object gitpod.v1.ExchangeTokenResponse: additionalProperties: false properties: accessToken: description: access_token is the new access token title: access_token type: string title: ExchangeTokenResponse type: object gitpod.v1.FieldValidationError: additionalProperties: false properties: error: title: error type: string key: title: key type: string title: FieldValidationError type: object gitpod.v1.FieldValue: additionalProperties: false properties: key: title: key type: string value: title: value type: string title: FieldValue type: object gitpod.v1.FieldValueUpdate: additionalProperties: false properties: key: description: key is the field key to update. If the field does not exist, it will be created. title: key type: string value: description: value is the new value for the field. If value is empty, the field will be removed. nullable: true title: value type: string title: FieldValueUpdate type: object gitpod.v1.FileChange: additionalProperties: false properties: changeType: $ref: '#/components/schemas/gitpod.v1.FileChange.ChangeType' title: change_type path: description: path is the path of the file maxLength: 255 title: path type: string title: FileChange type: object gitpod.v1.FileChange.ChangeType: description: ChangeType is the type of change that happened to the file enum: - CHANGE_TYPE_UNSPECIFIED - CHANGE_TYPE_ADDED - CHANGE_TYPE_MODIFIED - CHANGE_TYPE_DELETED - CHANGE_TYPE_RENAMED - CHANGE_TYPE_COPIED - CHANGE_TYPE_UPDATED_BUT_UNMERGED - CHANGE_TYPE_UNTRACKED title: ChangeType type: string gitpod.v1.Gateway: additionalProperties: false description: Gateway represents a system gateway that provides access to services properties: name: description: name is the human-readable name of the gateway. name is unique across all gateways. title: name type: string region: description: region is the geographical region where the gateway is located title: region type: string url: description: url of the gateway title: url type: string required: - name - url title: Gateway type: object gitpod.v1.GatewayInfo: additionalProperties: false properties: gateway: $ref: '#/components/schemas/gitpod.v1.Gateway' title: gateway latency: $ref: '#/components/schemas/google.protobuf.Duration' description: latency is the round-trip time of the runner to the gateway in milliseconds. title: latency title: GatewayInfo type: object gitpod.v1.GetAccountRequest: additionalProperties: false properties: empty: type: boolean title: GetAccountRequest type: object gitpod.v1.GetAccountResponse: additionalProperties: false properties: account: $ref: '#/components/schemas/gitpod.v1.Account' title: account required: - account title: GetAccountResponse type: object gitpod.v1.GetActiveEnvironmentsCountRequest: additionalProperties: false properties: dateRange: $ref: '#/components/schemas/gitpod.v1.DateRange' description: Date range to query metrics within. title: date_range projectId: description: Optional project ID to filter metrics by. title: project_id type: string required: - dateRange title: GetActiveEnvironmentsCountRequest type: object gitpod.v1.GetActiveEnvironmentsCountResponse: additionalProperties: false properties: count: description: Count of active environments in the date range. title: count type: string trend: description: "Fractional change in active environments vs previous period.\n Computed as (current - previous) /\ \ previous." format: double title: trend type: number title: GetActiveEnvironmentsCountResponse type: object gitpod.v1.GetActiveEnvironmentsTimeSeriesRequest: additionalProperties: false properties: dateRange: $ref: '#/components/schemas/gitpod.v1.DateRange' description: Date range to query metrics within. title: date_range projectId: description: Optional project ID to filter metrics by. title: project_id type: string resolution: $ref: '#/components/schemas/gitpod.v1.Resolution' description: Time resolution for the series data. title: resolution required: - dateRange title: GetActiveEnvironmentsTimeSeriesRequest type: object gitpod.v1.GetActiveEnvironmentsTimeSeriesResponse: additionalProperties: false properties: activeEnvironments: description: Active environments time series items: $ref: '#/components/schemas/gitpod.v1.TimeSeriesPoint' title: active_environments type: array title: GetActiveEnvironmentsTimeSeriesResponse type: object gitpod.v1.GetActiveUsersCountRequest: additionalProperties: false properties: dateRange: $ref: '#/components/schemas/gitpod.v1.DateRange' description: Date range to query metrics within. title: date_range projectId: description: Optional project ID to filter metrics by. title: project_id type: string required: - dateRange title: GetActiveUsersCountRequest type: object gitpod.v1.GetActiveUsersCountResponse: additionalProperties: false properties: count: description: Count of active users in the date range. title: count type: string trend: description: "Fractional change in active users vs previous period.\n Computed as (current - previous) / previous." format: double title: trend type: number title: GetActiveUsersCountResponse type: object gitpod.v1.GetActiveUsersTimeSeriesRequest: additionalProperties: false properties: dateRange: $ref: '#/components/schemas/gitpod.v1.DateRange' description: Date range to query metrics within. title: date_range projectId: description: Optional project ID to filter metrics by. title: project_id type: string resolution: $ref: '#/components/schemas/gitpod.v1.Resolution' description: Time resolution for the series data. title: resolution required: - dateRange title: GetActiveUsersTimeSeriesRequest type: object gitpod.v1.GetActiveUsersTimeSeriesResponse: additionalProperties: false properties: weeklyActiveReturningUsers: description: Weekly active returning users time series [WAU2+] items: $ref: '#/components/schemas/gitpod.v1.TimeSeriesPoint' title: weekly_active_returning_users type: array weeklyActiveUsers: description: Weekly active users time series [WAU] items: $ref: '#/components/schemas/gitpod.v1.TimeSeriesPoint' title: weekly_active_users type: array title: GetActiveUsersTimeSeriesResponse type: object gitpod.v1.GetAdoptionUsageSummaryRequest: additionalProperties: false properties: dateRange: $ref: '#/components/schemas/gitpod.v1.DateRange' description: Date range to query metrics within. title: date_range projectId: description: Optional project ID to filter metrics by. title: project_id type: string userId: description: Optional user ID to filter metrics for a specific user (personal insights view). title: user_id type: string required: - dateRange title: GetAdoptionUsageSummaryRequest type: object gitpod.v1.GetAdoptionUsageSummaryResponse: additionalProperties: false properties: activeUsersCount: description: Count of active users in the date range. title: active_users_count type: string activeUsersTrend: description: "Fractional change in active_users_count vs previous period.\n Computed as (current - previous) / previous." format: double title: active_users_trend type: number envRuntimePerUserSeconds: description: Average environment runtime in seconds per active user. format: double title: env_runtime_per_user_seconds type: number envRuntimePerUserTrend: description: "Fractional change in env_runtime_per_user_seconds vs previous period.\n Computed as (current - previous)\ \ / previous." format: double title: env_runtime_per_user_trend type: number powerUsersCount: description: Count of power users in the date range. title: power_users_count type: string powerUsersThresholdSeconds: description: "Threshold in seconds used to determine power users.\n Displayed to users so they understand the definition." title: power_users_threshold_seconds type: string powerUsersTrend: description: "Fractional change in power_users_count vs previous period.\n Computed as (current - previous) / previous." format: double title: power_users_trend type: number sessionsCount: description: Count of environment sessions (total starts) in the date range. title: sessions_count type: string sessionsTrend: description: "Fractional change in sessions_count vs previous period.\n Computed as (current - previous) / previous." format: double title: sessions_trend type: number sparkline: description: Sparkline data for the card's trend line (typically ~4 weekly points). items: $ref: '#/components/schemas/gitpod.v1.TimeSeriesPoint' title: sparkline type: array title: GetAdoptionUsageSummaryResponse type: object gitpod.v1.GetAgentExecutionRequest: additionalProperties: false properties: agentExecutionId: format: uuid title: agent_execution_id type: string title: GetAgentExecutionRequest type: object gitpod.v1.GetAgentExecutionResponse: additionalProperties: false properties: agentExecution: $ref: '#/components/schemas/gitpod.v1.AgentExecution' title: agent_execution title: GetAgentExecutionResponse type: object gitpod.v1.GetAgentRequest: additionalProperties: false properties: agentId: format: uuid title: agent_id type: string title: GetAgentRequest type: object gitpod.v1.GetAgentResponse: additionalProperties: false properties: agent: $ref: '#/components/schemas/gitpod.v1.Agent' title: agent title: GetAgentResponse type: object gitpod.v1.GetAgentTraceStatsRequest: additionalProperties: false description: "GetAgentTraceStatsRequest is used by the dashboard to read aggregated agent trace stats.\n When project_id\ \ is set, returns stats for that project only.\n When project_id is empty, aggregates across all projects in the org." properties: dateRange: $ref: '#/components/schemas/gitpod.v1.DateRange' description: Date range to query within. title: date_range organizationId: description: Organization to query stats for. format: uuid title: organization_id type: string projectId: description: "Optional. When set, scopes stats to this project only.\n When empty, aggregates across all projects\ \ in the org." title: project_id type: string resolution: $ref: '#/components/schemas/gitpod.v1.Resolution' description: Time resolution for the time series. Defaults to WEEKLY if unspecified. title: resolution required: - dateRange title: GetAgentTraceStatsRequest type: object gitpod.v1.GetAgentTraceStatsResponse: additionalProperties: false properties: summary: $ref: '#/components/schemas/gitpod.v1.AgentTraceSummary' description: Summary totals for the requested date range. title: summary timeSeries: description: Time series of agent trace stats, bucketed by the requested resolution. items: $ref: '#/components/schemas/gitpod.v1.AgentTraceTimeBucket' title: time_series type: array title: GetAgentTraceStatsResponse type: object gitpod.v1.GetAgentTraceSummaryRequest: additionalProperties: false properties: dateRange: $ref: '#/components/schemas/gitpod.v1.DateRange' description: Date range to query within. title: date_range projectId: description: Optional project ID to scope results. title: project_id type: string teamId: description: "Optional team ID to scope results to a specific team.\n Mutually exclusive with user_id." title: team_id type: string userId: description: "Optional user ID to scope results to a specific user.\n Mutually exclusive with team_id." title: user_id type: string required: - dateRange title: GetAgentTraceSummaryRequest type: object gitpod.v1.GetAgentTraceSummaryResponse: additionalProperties: false properties: sparkline: description: Sparkline data for card rendering. items: $ref: '#/components/schemas/gitpod.v1.TimeSeriesPoint' title: sparkline type: array summary: $ref: '#/components/schemas/gitpod.v1.AgentTraceSummary' description: Summary totals and trends for the requested date range. title: summary title: GetAgentTraceSummaryResponse type: object gitpod.v1.GetAgentTraceTimeSeriesRequest: additionalProperties: false properties: dateRange: $ref: '#/components/schemas/gitpod.v1.DateRange' description: Date range to query within. title: date_range projectId: description: Optional project ID to scope results. title: project_id type: string resolution: $ref: '#/components/schemas/gitpod.v1.Resolution' description: Time resolution for the series data. title: resolution teamId: description: "Optional team ID to scope results to a specific team.\n Mutually exclusive with user_id." title: team_id type: string userId: description: "Optional user ID to scope results to a specific user.\n Mutually exclusive with team_id." title: user_id type: string required: - dateRange title: GetAgentTraceTimeSeriesRequest type: object gitpod.v1.GetAgentTraceTimeSeriesResponse: additionalProperties: false properties: timeSeries: description: Time series of agent trace stats, bucketed by the requested resolution. items: $ref: '#/components/schemas/gitpod.v1.AgentTraceTimeBucket' title: time_series type: array title: GetAgentTraceTimeSeriesResponse type: object gitpod.v1.GetAnnouncementBannerRequest: additionalProperties: false properties: organizationId: description: organization_id is the ID of the organization format: uuid title: organization_id type: string required: - organizationId title: GetAnnouncementBannerRequest type: object gitpod.v1.GetAnnouncementBannerResponse: additionalProperties: false properties: banner: $ref: '#/components/schemas/gitpod.v1.AnnouncementBanner' description: banner is the announcement banner configuration title: banner required: - banner title: GetAnnouncementBannerResponse type: object gitpod.v1.GetAuthenticatedIdentityRequest: additionalProperties: false properties: empty: type: boolean title: GetAuthenticatedIdentityRequest type: object gitpod.v1.GetAuthenticatedIdentityResponse: additionalProperties: false properties: organizationId: title: organization_id type: string organizationTier: title: organization_tier type: string subject: $ref: '#/components/schemas/gitpod.v1.Subject' description: subject is the identity of the current user title: subject title: GetAuthenticatedIdentityResponse type: object gitpod.v1.GetAuthenticatedUserRequest: additionalProperties: false properties: empty: type: boolean title: GetAuthenticatedUserRequest type: object gitpod.v1.GetAuthenticatedUserResponse: additionalProperties: false properties: user: $ref: '#/components/schemas/gitpod.v1.User' title: user required: - user title: GetAuthenticatedUserResponse type: object gitpod.v1.GetAutoTopupSettingsRequest: additionalProperties: false properties: organizationId: description: organization_id is the ID of the organization to get auto-topup settings for format: uuid title: organization_id type: string required: - organizationId title: GetAutoTopupSettingsRequest type: object gitpod.v1.GetAutoTopupSettingsResponse: additionalProperties: false properties: settings: $ref: '#/components/schemas/gitpod.v1.AutoTopupSettings' description: settings contains the current auto-topup configuration title: settings title: GetAutoTopupSettingsResponse type: object gitpod.v1.GetBillingInfoRequest: additionalProperties: false properties: organizationId: description: organization_id is the ID of the organization to get billing info for format: uuid title: organization_id type: string required: - organizationId title: GetBillingInfoRequest type: object gitpod.v1.GetBillingInfoResponse: additionalProperties: false properties: autoTopupSettings: $ref: '#/components/schemas/gitpod.v1.AutoTopupSettings' description: auto_topup_settings contains the current auto-topup configuration title: auto_topup_settings availableCredits: description: available_credits is the remaining credits available for use format: double title: available_credits type: number creditGrant: description: "credit_grant is the contracted credit grant for the organization, in whole credits.\n Only set for\ \ enterprise UBB organizations. 0 means no grant has been configured." title: credit_grant type: string creditStatus: $ref: '#/components/schemas/gitpod.v1.CreditStatus' description: credit_status indicates the status of the credit balance title: credit_status lastAutoTopupAt: $ref: '#/components/schemas/google.protobuf.Timestamp' description: last_auto_topup_at is the timestamp of the most recent automatic top-up, if any. title: last_auto_topup_at monthlyCommitmentCents: description: "monthly_commitment_cents is the monthly subscription amount in USD cents.\n 0 means the organization\ \ is on a free Core plan. Only set for Core tier organizations\n with an active contract." title: monthly_commitment_cents type: string paymentFailure: $ref: '#/components/schemas/gitpod.v1.PaymentFailureInfo' description: payment_failure contains information about payment failures if any title: payment_failure paymentMethodStatus: $ref: '#/components/schemas/gitpod.v1.PaymentMethodStatus' description: payment_method_status indicates the status of the payment method title: payment_method_status recoveryCreditGrantedAt: $ref: '#/components/schemas/google.protobuf.Timestamp' description: "recovery_credit_granted_at is set when the one-time recovery credit grant has been used.\n Nil means\ \ the organization is still eligible for a recovery credit grant." title: recovery_credit_granted_at topupPaymentFailure: $ref: '#/components/schemas/gitpod.v1.TopupPaymentFailureInfo' description: topup_payment_failure contains information about topup payment failures if any title: topup_payment_failure totalCredits: description: total_credits is the total amount of credits granted to the organization format: double title: total_credits type: number usedCredits: description: used_credits is the amount of credits already consumed format: double title: used_credits type: number title: GetBillingInfoResponse type: object gitpod.v1.GetBillingRecordRequest: additionalProperties: false properties: billingRecordId: description: billing_record_id specifies the billing record identifier format: uuid title: billing_record_id type: string title: GetBillingRecordRequest type: object gitpod.v1.GetBillingRecordResponse: additionalProperties: false properties: billingRecord: $ref: '#/components/schemas/gitpod.v1.BillingRecord' title: billing_record title: GetBillingRecordResponse type: object gitpod.v1.GetChatIdentityTokenRequest: additionalProperties: false properties: empty: type: boolean title: GetChatIdentityTokenRequest type: object gitpod.v1.GetChatIdentityTokenResponse: additionalProperties: false properties: emailHash: description: "email_hash is the HMAC-SHA256 hash of the account's email address,\n used for chat widget identity\ \ verification" title: email_hash type: string required: - emailHash title: GetChatIdentityTokenResponse type: object gitpod.v1.GetCoAuthorStatsRequest: additionalProperties: false description: "GetCoAuthorStatsRequest is used by the dashboard to read aggregated stats.\n When project_id is set, returns\ \ stats for that project only.\n When project_id is empty, aggregates across all projects in the org." properties: dateRange: $ref: '#/components/schemas/gitpod.v1.DateRange' description: Date range to query within. title: date_range organizationId: description: Organization to query stats for. format: uuid title: organization_id type: string projectId: description: "Optional. When set, scopes stats to this project only.\n When empty, aggregates across all projects\ \ in the org." title: project_id type: string resolution: $ref: '#/components/schemas/gitpod.v1.Resolution' description: Time resolution for the time series. Defaults to WEEKLY if unspecified. title: resolution required: - dateRange title: GetCoAuthorStatsRequest type: object gitpod.v1.GetCoAuthorStatsResponse: additionalProperties: false properties: summary: $ref: '#/components/schemas/gitpod.v1.CoAuthorSummary' description: Summary totals for the requested date range. title: summary timeSeries: description: Time series of contribution stats, bucketed by the requested resolution. items: $ref: '#/components/schemas/gitpod.v1.CoAuthorTimeBucket' title: time_series type: array title: GetCoAuthorStatsResponse type: object gitpod.v1.GetCoAuthorSummaryRequest: additionalProperties: false properties: dateRange: $ref: '#/components/schemas/gitpod.v1.DateRange' description: Date range to query within. title: date_range projectId: description: Optional project ID to scope results. title: project_id type: string teamId: description: "Optional team ID to scope results to a specific team.\n Mutually exclusive with user_id." title: team_id type: string userId: description: "Optional user ID to scope results to a specific user.\n Mutually exclusive with team_id." title: user_id type: string required: - dateRange title: GetCoAuthorSummaryRequest type: object gitpod.v1.GetCoAuthorSummaryResponse: additionalProperties: false properties: sparkline: description: Sparkline data for card rendering. items: $ref: '#/components/schemas/gitpod.v1.TimeSeriesPoint' title: sparkline type: array summary: $ref: '#/components/schemas/gitpod.v1.CoAuthorSummary' description: Summary totals and trends for the requested date range. title: summary title: GetCoAuthorSummaryResponse type: object gitpod.v1.GetCoAuthorTimeSeriesRequest: additionalProperties: false properties: dateRange: $ref: '#/components/schemas/gitpod.v1.DateRange' description: Date range to query within. title: date_range projectId: description: Optional project ID to scope results. title: project_id type: string resolution: $ref: '#/components/schemas/gitpod.v1.Resolution' description: Time resolution for the series data. title: resolution teamId: description: "Optional team ID to scope results to a specific team.\n Mutually exclusive with user_id." title: team_id type: string userId: description: "Optional user ID to scope results to a specific user.\n Mutually exclusive with team_id." title: user_id type: string required: - dateRange title: GetCoAuthorTimeSeriesRequest type: object gitpod.v1.GetCoAuthorTimeSeriesResponse: additionalProperties: false properties: timeSeries: description: Time series of contribution stats, bucketed by the requested resolution. items: $ref: '#/components/schemas/gitpod.v1.CoAuthorTimeBucket' title: time_series type: array title: GetCoAuthorTimeSeriesResponse type: object gitpod.v1.GetCouponRequest: additionalProperties: false properties: couponCode: description: coupon_code is the code of the coupon to retrieve maxLength: 50 minLength: 3 title: coupon_code type: string organizationId: description: organization_id is the organization context for per-organization validation format: uuid title: organization_id type: string required: - couponCode - organizationId title: GetCouponRequest type: object gitpod.v1.GetCouponResponse: additionalProperties: false properties: coupon: $ref: '#/components/schemas/gitpod.v1.Coupon' title: coupon title: GetCouponResponse type: object gitpod.v1.GetCreditConsumptionTimeSeriesRequest: additionalProperties: false properties: dateRange: $ref: '#/components/schemas/gitpod.v1.DateRange' description: "Date range for the consumption query. Optional; defaults to the last 7 days.\n The range must not\ \ exceed 30 days, and end_time must not be in the future." title: date_range organizationId: format: uuid title: organization_id type: string required: - organizationId title: GetCreditConsumptionTimeSeriesRequest type: object gitpod.v1.GetCreditConsumptionTimeSeriesResponse: additionalProperties: false properties: metrics: description: Per-metric OCU consumption time series, plus a total entry with kind ALL. items: $ref: '#/components/schemas/gitpod.v1.MetricConsumptionTimeSeries' title: metrics type: array title: GetCreditConsumptionTimeSeriesResponse type: object gitpod.v1.GetCreditUsageExportRequest: additionalProperties: false properties: dateRange: $ref: '#/components/schemas/gitpod.v1.DateRange' description: Month to export. Same semantics as GetCreditUsageReport.date_range. title: date_range organizationId: format: uuid title: organization_id type: string required: - organizationId - dateRange title: GetCreditUsageExportRequest type: object gitpod.v1.GetCreditUsageExportResponse: additionalProperties: false properties: downloadUrl: description: Signed download URL for the CSV export. Short-lived (5 minutes). title: download_url type: string title: GetCreditUsageExportResponse type: object gitpod.v1.GetCreditUsageReportRequest: additionalProperties: false properties: dateRange: $ref: '#/components/schemas/gitpod.v1.DateRange' description: "Date range for the report. Both start and end dates are inclusive.\n Time-of-day is ignored; dates\ \ are truncated to midnight in the specified timezone.\n The range must not exceed 31 days." title: date_range organizationId: format: uuid title: organization_id type: string timezone: description: "IANA timezone name (e.g. \"America/New_York\", \"Europe/Berlin\") used to\n bucket daily usage. When\ \ empty, defaults to \"UTC\"." title: timezone type: string required: - organizationId - dateRange title: GetCreditUsageReportRequest type: object gitpod.v1.GetCreditUsageReportResponse: additionalProperties: false properties: dailyUsage: description: One entry per day in the requested date range. items: $ref: '#/components/schemas/gitpod.v1.DailyCreditUsage' title: daily_usage type: array periodStart: $ref: '#/components/schemas/google.protobuf.Timestamp' description: "Start of the billing period for this organization.\n Used by the frontend to filter out months before\ \ usage tracking began." nullable: true title: period_start updatedAt: $ref: '#/components/schemas/google.protobuf.Timestamp' description: When the report data was last computed. title: updated_at title: GetCreditUsageReportResponse type: object gitpod.v1.GetCumulativeCreditUsageRequest: additionalProperties: false properties: asOf: $ref: '#/components/schemas/google.protobuf.Timestamp' description: "as_of is the point in time to compute cumulative usage up to.\n Defaults to now if not set." nullable: true title: as_of organizationId: description: organization_id is the ID of the organization to get cumulative usage for. format: uuid title: organization_id type: string required: - organizationId title: GetCumulativeCreditUsageRequest type: object gitpod.v1.GetCumulativeCreditUsageResponse: additionalProperties: false properties: orgUsage: $ref: '#/components/schemas/gitpod.v1.CumulativeCreditUsage' description: Org-wide cumulative usage, broken down by type and total. title: org_usage periodStart: $ref: '#/components/schemas/google.protobuf.Timestamp' description: "Start of the cumulative calculation period.\n Cumulative totals are computed from this date forward." title: period_start teamUsage: description: "Per-team cumulative usage with credit allocation comparison.\n Returns all teams (no top-N limit)." items: $ref: '#/components/schemas/gitpod.v1.TeamCumulativeCreditUsage' title: team_usage type: array unteamedUsage: $ref: '#/components/schemas/gitpod.v1.CumulativeCreditUsage' description: Usage by members not assigned to any team. title: unteamed_usage title: GetCumulativeCreditUsageResponse type: object gitpod.v1.GetCustomDomainRequest: additionalProperties: false description: GetCustomDomainRequest is the request message for getting a custom domain properties: organizationId: description: organization_id is the ID of the organization to retrieve custom domain for format: uuid title: organization_id type: string required: - organizationId title: GetCustomDomainRequest type: object gitpod.v1.GetCustomDomainResponse: additionalProperties: false properties: customDomain: $ref: '#/components/schemas/gitpod.v1.CustomDomain' title: custom_domain required: - customDomain title: GetCustomDomainResponse type: object gitpod.v1.GetDomainVerificationRequest: additionalProperties: false properties: domainVerificationId: format: uuid title: domain_verification_id type: string required: - domainVerificationId title: GetDomainVerificationRequest type: object gitpod.v1.GetDomainVerificationResponse: additionalProperties: false properties: domainVerification: $ref: '#/components/schemas/gitpod.v1.DomainVerification' title: domain_verification required: - domainVerification title: GetDomainVerificationResponse type: object gitpod.v1.GetDotfilesConfigurationRequest: additionalProperties: false properties: empty: type: boolean title: GetDotfilesConfigurationRequest type: object gitpod.v1.GetDotfilesConfigurationResponse: additionalProperties: false properties: dotfilesConfiguration: $ref: '#/components/schemas/gitpod.v1.DotfilesConfiguration' title: dotfiles_configuration required: - dotfilesConfiguration title: GetDotfilesConfigurationResponse type: object gitpod.v1.GetEditorRequest: additionalProperties: false properties: id: description: id is the ID of the editor to get title: id type: string required: - id title: GetEditorRequest type: object gitpod.v1.GetEditorResponse: additionalProperties: false properties: editor: $ref: '#/components/schemas/gitpod.v1.Editor' description: editor contains the editor title: editor required: - editor title: GetEditorResponse type: object gitpod.v1.GetEnterpriseBillingInfoRequest: additionalProperties: false properties: organizationId: format: uuid title: organization_id type: string required: - organizationId title: GetEnterpriseBillingInfoRequest type: object gitpod.v1.GetEnterpriseBillingInfoResponse: additionalProperties: false properties: creditUsageEnabled: title: credit_usage_enabled type: boolean title: GetEnterpriseBillingInfoResponse type: object gitpod.v1.GetEnvironmentClassRequest: additionalProperties: false properties: environmentClassId: format: uuid title: environment_class_id type: string title: GetEnvironmentClassRequest type: object gitpod.v1.GetEnvironmentClassResponse: additionalProperties: false properties: environmentClass: $ref: '#/components/schemas/gitpod.v1.EnvironmentClass' title: environment_class title: GetEnvironmentClassResponse type: object gitpod.v1.GetEnvironmentRequest: additionalProperties: false properties: environmentId: description: environment_id specifies the environment to get format: uuid title: environment_id type: string required: - environmentId title: GetEnvironmentRequest type: object gitpod.v1.GetEnvironmentResponse: additionalProperties: false properties: environment: $ref: '#/components/schemas/gitpod.v1.Environment' title: environment required: - environment title: GetEnvironmentResponse type: object gitpod.v1.GetEnvironmentRuntimeRequest: additionalProperties: false properties: dateRange: $ref: '#/components/schemas/gitpod.v1.DateRange' description: Date range to query metrics within. title: date_range projectId: description: Optional project ID to filter metrics by. title: project_id type: string required: - dateRange title: GetEnvironmentRuntimeRequest type: object gitpod.v1.GetEnvironmentRuntimeResponse: additionalProperties: false properties: totalRuntimeSeconds: description: Total runtime in seconds. title: total_runtime_seconds type: string trend: description: "Fractional change in total runtime vs previous period.\n Computed as (current - previous) / previous." format: double title: trend type: number title: GetEnvironmentRuntimeResponse type: object gitpod.v1.GetEnvironmentRuntimeTimeSeriesRequest: additionalProperties: false properties: dateRange: $ref: '#/components/schemas/gitpod.v1.DateRange' description: Date range to query metrics within. title: date_range projectId: description: Optional project ID to filter metrics by. title: project_id type: string resolution: $ref: '#/components/schemas/gitpod.v1.Resolution' description: Time resolution for the series data. title: resolution required: - dateRange title: GetEnvironmentRuntimeTimeSeriesRequest type: object gitpod.v1.GetEnvironmentRuntimeTimeSeriesResponse: additionalProperties: false properties: totalRuntime: description: Total runtime time series items: $ref: '#/components/schemas/gitpod.v1.TimeSeriesPoint' title: total_runtime type: array title: GetEnvironmentRuntimeTimeSeriesResponse type: object gitpod.v1.GetEnvironmentSessionsTimeSeriesRequest: additionalProperties: false properties: dateRange: $ref: '#/components/schemas/gitpod.v1.DateRange' description: Date range to query metrics within. title: date_range projectId: description: Optional project ID to filter metrics by. title: project_id type: string resolution: $ref: '#/components/schemas/gitpod.v1.Resolution' description: Time resolution for the series data. title: resolution required: - dateRange title: GetEnvironmentSessionsTimeSeriesRequest type: object gitpod.v1.GetEnvironmentSessionsTimeSeriesResponse: additionalProperties: false properties: sessions: description: "Environment sessions time series. Counts total environment starts per time bucket,\n as opposed to\ \ GetActiveEnvironmentsTimeSeries which counts distinct environment IDs." items: $ref: '#/components/schemas/gitpod.v1.TimeSeriesPoint' title: sessions type: array title: GetEnvironmentSessionsTimeSeriesResponse type: object gitpod.v1.GetGroupRequest: additionalProperties: false description: GetGroup messages oneOf: - not: anyOf: - required: - name required: - id - not: anyOf: - required: - id required: - name properties: groupId: deprecated: true description: 'Deprecated: use the group oneof instead.' title: group_id type: string id: description: id looks up the group by its unique ID. format: uuid title: id type: string name: description: name looks up the group by its name within the caller's organization. maxLength: 80 minLength: 3 title: name type: string title: GetGroupRequest type: object gitpod.v1.GetGroupResponse: additionalProperties: false properties: group: $ref: '#/components/schemas/gitpod.v1.Group' title: group title: GetGroupResponse type: object gitpod.v1.GetHostAuthenticationTokenRequest: additionalProperties: false properties: id: format: uuid title: id type: string title: GetHostAuthenticationTokenRequest type: object gitpod.v1.GetHostAuthenticationTokenResponse: additionalProperties: false properties: token: $ref: '#/components/schemas/gitpod.v1.HostAuthenticationToken' title: token required: - token title: GetHostAuthenticationTokenResponse type: object gitpod.v1.GetHostAuthenticationTokenValueRequest: additionalProperties: false properties: host: description: The host to get the authentication token for title: host type: string principalId: description: The principal's ID to get the authentication token for format: uuid title: principal_id type: string runnerId: description: The runner's identity format: uuid title: runner_id type: string title: GetHostAuthenticationTokenValueRequest type: object gitpod.v1.GetHostAuthenticationTokenValueResponse: additionalProperties: false properties: expiresAt: $ref: '#/components/schemas/google.protobuf.Timestamp' description: The host authentication token's expiry title: expires_at refreshToken: description: The host authentication token's refresh token encrypted as NaCL anonymous sealed box using the runner's public key format: byte title: refresh_token type: string source: $ref: '#/components/schemas/gitpod.v1.HostAuthenticationTokenSource' description: The host authentication token's source title: source tokenId: description: The host authentication token's ID title: token_id type: string value: description: The authentication token encrypted as NaCL anonymous sealed box using the runner's public key format: byte title: value type: string title: GetHostAuthenticationTokenValueResponse type: object gitpod.v1.GetIDTokenRequest: additionalProperties: false properties: audience: items: minItems: 1 type: string minItems: 1 title: audience type: array version: $ref: '#/components/schemas/gitpod.v1.IDTokenVersion' description: version is the version of the ID token. title: version title: GetIDTokenRequest type: object gitpod.v1.GetIDTokenResponse: additionalProperties: false properties: token: title: token type: string title: GetIDTokenResponse type: object gitpod.v1.GetInsightsSummaryRequest: additionalProperties: false description: GetInsightsSummaryRequest returns project-level insights adoption for the org. properties: organizationId: description: Organization to query. format: uuid title: organization_id type: string title: GetInsightsSummaryRequest type: object gitpod.v1.GetInsightsSummaryResponse: additionalProperties: false properties: enabledProjectCount: description: Number of projects with insights enabled. title: enabled_project_count type: string totalProjectCount: description: Total number of projects in the organization. title: total_project_count type: string title: GetInsightsSummaryResponse type: object gitpod.v1.GetIntegrationDefinitionRequest: additionalProperties: false properties: id: minLength: 1 title: id type: string title: GetIntegrationDefinitionRequest type: object gitpod.v1.GetIntegrationDefinitionResponse: additionalProperties: false properties: definition: $ref: '#/components/schemas/gitpod.v1.IntegrationDefinition' title: definition required: - definition title: GetIntegrationDefinitionResponse type: object gitpod.v1.GetIntegrationRequest: additionalProperties: false properties: id: format: uuid title: id type: string title: GetIntegrationRequest type: object gitpod.v1.GetIntegrationResponse: additionalProperties: false properties: integration: $ref: '#/components/schemas/gitpod.v1.Integration' title: integration required: - integration title: GetIntegrationResponse type: object gitpod.v1.GetLLMIntegrationRequest: additionalProperties: false properties: id: format: uuid title: id type: string title: GetLLMIntegrationRequest type: object gitpod.v1.GetLLMIntegrationResponse: additionalProperties: false properties: integration: $ref: '#/components/schemas/gitpod.v1.LLMIntegration' title: integration title: GetLLMIntegrationResponse type: object gitpod.v1.GetLatestVersionRequest: additionalProperties: false properties: currentVersion: description: The current version of the runner title: current_version type: string infrastructureVersion: description: The version of the infrastructure title: infrastructure_version type: string runnerId: description: The runner's identity format: uuid title: runner_id type: string required: - runnerId title: GetLatestVersionRequest type: object gitpod.v1.GetLatestVersionResponse: additionalProperties: false oneOf: - not: anyOf: - required: - gcp - required: - linuxHost required: - awsEc2 - not: anyOf: - required: - awsEc2 - required: - linuxHost required: - gcp - not: anyOf: - required: - awsEc2 - required: - gcp required: - linuxHost properties: autoUpdate: description: auto-update indicates if the runner should be updated automatically title: auto_update type: boolean awsEc2: $ref: '#/components/schemas/gitpod.v1.GetLatestVersionResponse.AwsEc2Manifest' title: aws_ec2 gcp: $ref: '#/components/schemas/gitpod.v1.GetLatestVersionResponse.GcpManifest' title: gcp gitpodCliDownloadUrl: description: gitpod_cli_download_url is the URL to download the gitpod CLI title: gitpod_cli_download_url type: string hotfix: description: hotfix indicates this release should bypass update windows and be applied immediately. title: hotfix type: boolean linuxHost: $ref: '#/components/schemas/gitpod.v1.GetLatestVersionResponse.LinuxHostManifest' title: linux_host runnerImage: description: 'deprecated: aws-specific field, use manifest.aws_ec2.runner_image instead' title: runner_image type: string supervisorDownloadUrl: description: supervisor_download_url is the URL to download the supervisor title: supervisor_download_url type: string version: description: The latest version of the runner title: version type: string required: - version - autoUpdate title: GetLatestVersionResponse type: object gitpod.v1.GetLatestVersionResponse.AwsEc2Manifest: additionalProperties: false properties: amiImageMap: additionalProperties: title: value type: string deprecated: true description: 'Deprecated: AMI image maps are no longer sent to runners.' title: ami_image_map type: object proxyImage: description: "The container image of the proxy.\n Will only be set if the latest release in the release channel\ \ has the same infrastructure version as the runner." title: proxy_image type: string runnerImage: description: "The container image of the runner.\n Will only be set if the latest release in the release channel\ \ has the same infrastructure version as the runner." title: runner_image type: string title: AwsEc2Manifest type: object gitpod.v1.GetLatestVersionResponse.AwsEc2Manifest.AmiImageMapEntry: additionalProperties: false properties: key: title: key type: string value: title: value type: string title: AmiImageMapEntry type: object gitpod.v1.GetLatestVersionResponse.GcpManifest: additionalProperties: false properties: downloadUrl: description: Download URL for the terraform files. title: download_url type: string proxyImage: description: "The container image of the proxy.\n Will only be set if the latest release in the release channel\ \ has the same infrastructure version as the runner." title: proxy_image type: string runnerImage: description: "The container image of the runner.\n Will only be set if the latest release in the release channel\ \ has the same infrastructure version as the runner." title: runner_image type: string terraformFiles: description: Terraform files to be used to create the runner. items: type: string title: terraform_files type: array title: GcpManifest type: object gitpod.v1.GetLatestVersionResponse.LinuxHostManifest: additionalProperties: false properties: chRemoteStaticUrl: title: ch_remote_static_url type: string cloudHypervisorUrl: title: cloud_hypervisor_url type: string kernelImageUrl: title: kernel_image_url type: string linuxRunnerUrl: title: linux_runner_url type: string rootfsDiskImageUrl: title: rootfs_disk_image_url type: string sharedDiskImageUrl: title: shared_disk_image_url type: string zstdUrl: title: zstd_url type: string required: - linuxRunnerUrl - kernelImageUrl - rootfsDiskImageUrl - sharedDiskImageUrl - cloudHypervisorUrl - chRemoteStaticUrl - zstdUrl title: LinuxHostManifest type: object gitpod.v1.GetManagedRunnerRequest: additionalProperties: false properties: runnerId: format: uuid title: runner_id type: string title: GetManagedRunnerRequest type: object gitpod.v1.GetManagedRunnerResponse: additionalProperties: false properties: runner: $ref: '#/components/schemas/gitpod.v1.ManagedRunner' title: runner title: GetManagedRunnerResponse type: object gitpod.v1.GetMembershipRequest: additionalProperties: false description: GetMembership messages properties: groupId: format: uuid title: group_id type: string subject: $ref: '#/components/schemas/gitpod.v1.Subject' description: Subject to check membership for title: subject required: - subject title: GetMembershipRequest type: object gitpod.v1.GetMembershipResponse: additionalProperties: false properties: member: $ref: '#/components/schemas/gitpod.v1.GroupMembership' description: The membership if found, nil if subject is not a member title: member title: GetMembershipResponse type: object gitpod.v1.GetOIDCConfigRequest: additionalProperties: false description: GetOIDCConfigRequest is the request message for retrieving OIDC token configuration. properties: organizationId: description: organization_id is the ID of the organization. format: uuid title: organization_id type: string required: - organizationId title: GetOIDCConfigRequest type: object gitpod.v1.GetOIDCConfigResponse: additionalProperties: false description: GetOIDCConfigResponse is the response message for retrieving OIDC token configuration. properties: oidcConfig: $ref: '#/components/schemas/gitpod.v1.OIDCConfig' description: oidc_config is the current OIDC token configuration. title: oidc_config required: - oidcConfig title: GetOIDCConfigResponse type: object gitpod.v1.GetOrganizationInviteRequest: additionalProperties: false properties: organizationId: format: uuid title: organization_id type: string required: - organizationId title: GetOrganizationInviteRequest type: object gitpod.v1.GetOrganizationInviteResponse: additionalProperties: false properties: invite: $ref: '#/components/schemas/gitpod.v1.OrganizationInvite' title: invite required: - invite title: GetOrganizationInviteResponse type: object gitpod.v1.GetOrganizationInviteSummaryRequest: additionalProperties: false properties: inviteId: format: uuid title: invite_id type: string required: - inviteId title: GetOrganizationInviteSummaryRequest type: object gitpod.v1.GetOrganizationInviteSummaryResponse: additionalProperties: false properties: organizationId: format: uuid title: organization_id type: string organizationMemberCount: format: int32 title: organization_member_count type: integer organizationName: title: organization_name type: string required: - organizationId title: GetOrganizationInviteSummaryResponse type: object gitpod.v1.GetOrganizationLLMConfigurationRequest: additionalProperties: false properties: organizationId: description: organization_id is the ID of the organization to query format: uuid title: organization_id type: string title: GetOrganizationLLMConfigurationRequest type: object gitpod.v1.GetOrganizationLLMConfigurationResponse: additionalProperties: false properties: configuration: $ref: '#/components/schemas/gitpod.v1.OrganizationLLMConfiguration' description: configuration contains metadata about the stored configuration title: configuration title: GetOrganizationLLMConfigurationResponse type: object gitpod.v1.GetOrganizationLLMUsageRequest: additionalProperties: false description: "The organization is inferred from the caller's identity.\n No parameters required." properties: empty: type: boolean title: GetOrganizationLLMUsageRequest type: object gitpod.v1.GetOrganizationLLMUsageResponse: additionalProperties: false properties: lastCalculatedAt: $ref: '#/components/schemas/google.protobuf.Timestamp' description: "last_calculated_at is when this usage data was last fetched and calculated\n Helps users understand\ \ data freshness (typically 5-10 minutes behind real-time)" title: last_calculated_at thisMonth: $ref: '#/components/schemas/gitpod.v1.LLMUsageSummary' description: this_month contains usage summary for the last 30 days title: this_month thisWeek: $ref: '#/components/schemas/gitpod.v1.LLMUsageSummary' description: this_week contains usage summary for the last 7 days title: this_week thisYear: $ref: '#/components/schemas/gitpod.v1.LLMUsageSummary' description: this_year contains usage summary from Ona Intelligence activation to now (max 365 days) title: this_year usageDataFrom: $ref: '#/components/schemas/google.protobuf.Timestamp' description: "usage_data_from is when usage tracking started for this organization\n Typically when Ona Intelligence\ \ was enabled (organization_llm_integration.created_at)" title: usage_data_from title: GetOrganizationLLMUsageResponse type: object gitpod.v1.GetOrganizationPoliciesRequest: additionalProperties: false properties: organizationId: description: organization_id is the ID of the organization to retrieve policies for format: uuid title: organization_id type: string required: - organizationId title: GetOrganizationPoliciesRequest type: object gitpod.v1.GetOrganizationPoliciesResponse: additionalProperties: false properties: policies: $ref: '#/components/schemas/gitpod.v1.OrganizationPolicies' title: policies required: - policies title: GetOrganizationPoliciesResponse type: object gitpod.v1.GetOrganizationRequest: additionalProperties: false properties: organizationId: description: organization_id is the unique identifier of the Organization to retreive. format: uuid title: organization_id type: string required: - organizationId title: GetOrganizationRequest type: object gitpod.v1.GetOrganizationResponse: additionalProperties: false properties: organization: $ref: '#/components/schemas/gitpod.v1.Organization' description: organization is the requested organization title: organization required: - organization title: GetOrganizationResponse type: object gitpod.v1.GetPersonalAccessTokenRequest: additionalProperties: false properties: personalAccessTokenId: format: uuid title: personal_access_token_id type: string title: GetPersonalAccessTokenRequest type: object gitpod.v1.GetPersonalAccessTokenResponse: additionalProperties: false properties: pat: $ref: '#/components/schemas/gitpod.v1.PersonalAccessToken' title: pat required: - pat title: GetPersonalAccessTokenResponse type: object gitpod.v1.GetPrStatsSummaryRequest: additionalProperties: false description: GetPrStatsSummaryRequest is used by the dashboard to read aggregated PR speed metrics. properties: dateRange: $ref: '#/components/schemas/gitpod.v1.DateRange' description: Date range to query within. PRs are filtered by merged_at. title: date_range projectId: description: Project to query stats for. format: uuid title: project_id type: string required: - dateRange title: GetPrStatsSummaryRequest type: object gitpod.v1.GetPrStatsSummaryResponse: additionalProperties: false properties: deploymentFrequency: description: 'Deployment frequency: PRs merged to the default branch per week.' format: double title: deployment_frequency type: number deploymentFrequencyTrend: description: "Fractional change in deployment_frequency vs previous period.\n Computed as (current - previous) /\ \ previous." format: double title: deployment_frequency_trend type: number leadTimeSeconds: description: Median lead time for changes in seconds (first commit → merge). format: double title: lead_time_seconds type: number leadTimeTrend: description: "Fractional change in lead_time_seconds vs previous period.\n Computed as (current - previous) / previous." format: double title: lead_time_trend type: number prsMergedCount: description: Total number of PRs merged in the date range. title: prs_merged_count type: string prsMergedTrend: description: "Fractional change in prs_merged_count vs previous period.\n Computed as (current - previous) / previous." format: double title: prs_merged_trend type: number sparkline: description: "Sparkline data for the card's trend line (typically ~4 weekly points).\n Values represent PRs merged\ \ per bucket." items: $ref: '#/components/schemas/gitpod.v1.TimeSeriesPoint' title: sparkline type: array timeToFirstApprovalSeconds: description: "Median time to first approval in seconds (PR opened → first approving review).\n Zero when no PRs\ \ in the range had approvals." format: double title: time_to_first_approval_seconds type: number timeToFirstApprovalTrend: description: "Fractional change in time_to_first_approval_seconds vs previous period.\n Computed as (current - previous)\ \ / previous." format: double title: time_to_first_approval_trend type: number title: GetPrStatsSummaryResponse type: object gitpod.v1.GetPrSummaryRequest: additionalProperties: false properties: dateRange: $ref: '#/components/schemas/gitpod.v1.DateRange' description: Date range to query within. title: date_range projectId: description: Optional project ID to scope results. title: project_id type: string teamId: description: "Optional team ID to scope results to a specific team.\n Mutually exclusive with user_id." title: team_id type: string userId: description: "Optional user ID to scope results to a specific user.\n Mutually exclusive with team_id." title: user_id type: string required: - dateRange title: GetPrSummaryRequest type: object gitpod.v1.GetPrSummaryResponse: additionalProperties: false properties: sparkline: description: Sparkline data for card rendering. items: $ref: '#/components/schemas/gitpod.v1.TimeSeriesPoint' title: sparkline type: array summary: $ref: '#/components/schemas/gitpod.v1.PrSummary' description: Summary totals and trends for the requested date range. title: summary title: GetPrSummaryResponse type: object gitpod.v1.GetPrTimeSeriesRequest: additionalProperties: false properties: dateRange: $ref: '#/components/schemas/gitpod.v1.DateRange' description: Date range to query within. title: date_range projectId: description: Optional project ID to scope results. title: project_id type: string resolution: $ref: '#/components/schemas/gitpod.v1.Resolution' description: Time resolution for the series data. title: resolution teamId: description: "Optional team ID to scope results to a specific team.\n Mutually exclusive with user_id." title: team_id type: string userId: description: "Optional user ID to scope results to a specific user.\n Mutually exclusive with team_id." title: user_id type: string required: - dateRange title: GetPrTimeSeriesRequest type: object gitpod.v1.GetPrTimeSeriesResponse: additionalProperties: false properties: timeSeries: description: Time series of PR speed metrics, bucketed by the requested resolution. items: $ref: '#/components/schemas/gitpod.v1.PrTimeBucket' title: time_series type: array title: GetPrTimeSeriesResponse type: object gitpod.v1.GetPrebuildRequest: additionalProperties: false properties: prebuildId: description: prebuild_id specifies the prebuild to retrieve format: uuid title: prebuild_id type: string required: - prebuildId title: GetPrebuildRequest type: object gitpod.v1.GetPrebuildResponse: additionalProperties: false properties: prebuild: $ref: '#/components/schemas/gitpod.v1.Prebuild' title: prebuild required: - prebuild title: GetPrebuildResponse type: object gitpod.v1.GetPreferenceRequest: additionalProperties: false oneOf: - not: anyOf: - required: - preferenceKey required: - preferenceId - not: anyOf: - required: - preferenceId required: - preferenceKey properties: preferenceId: title: preference_id type: string preferenceKey: maxLength: 255 minLength: 1 title: preference_key type: string userPreferenceId: deprecated: true title: user_preference_id type: string title: GetPreferenceRequest type: object gitpod.v1.GetPreferenceResponse: additionalProperties: false properties: preference: $ref: '#/components/schemas/gitpod.v1.UserPreference' title: preference title: GetPreferenceResponse type: object gitpod.v1.GetProjectInsightsStatusRequest: additionalProperties: false description: GetProjectInsightsStatusRequest checks whether insights is enabled for a project. properties: projectId: description: Project to check. format: uuid title: project_id type: string title: GetProjectInsightsStatusRequest type: object gitpod.v1.GetProjectInsightsStatusResponse: additionalProperties: false properties: enabled: description: Whether co-author insights is enabled for the project. title: enabled type: boolean lastRanAt: $ref: '#/components/schemas/google.protobuf.Timestamp' description: "When the insights workflow last completed successfully.\n Nil when enabled is true but no data has\ \ been collected yet (pending state)." title: last_ran_at title: GetProjectInsightsStatusResponse type: object gitpod.v1.GetProjectRequest: additionalProperties: false properties: projectId: description: project_id specifies the project identifier format: uuid title: project_id type: string title: GetProjectRequest type: object gitpod.v1.GetProjectResponse: additionalProperties: false properties: project: $ref: '#/components/schemas/gitpod.v1.Project' title: project title: GetProjectResponse type: object gitpod.v1.GetPromptRequest: additionalProperties: false properties: promptId: format: uuid title: prompt_id type: string title: GetPromptRequest type: object gitpod.v1.GetPromptResponse: additionalProperties: false properties: prompt: $ref: '#/components/schemas/gitpod.v1.Prompt' title: prompt title: GetPromptResponse type: object gitpod.v1.GetRunnerAgentExecutionRequest: additionalProperties: false properties: agentExecutionId: format: uuid title: agent_execution_id type: string runnerId: format: uuid title: runner_id type: string title: GetRunnerAgentExecutionRequest type: object gitpod.v1.GetRunnerAgentExecutionResponse: additionalProperties: false properties: agentExecution: $ref: '#/components/schemas/gitpod.v1.RunnerAgentExecution' title: agent_execution title: GetRunnerAgentExecutionResponse type: object gitpod.v1.GetRunnerConfigurationRequest: additionalProperties: false properties: runnerId: format: uuid title: runner_id type: string title: GetRunnerConfigurationRequest type: object gitpod.v1.GetRunnerConfigurationResponse: additionalProperties: false properties: configuration: $ref: '#/components/schemas/gitpod.v1.GetRunnerConfigurationResponse.RunnerConfiguration' title: configuration title: GetRunnerConfigurationResponse type: object gitpod.v1.GetRunnerConfigurationResponse.RunnerConfiguration: additionalProperties: false properties: autoUpdate: title: auto_update type: boolean continuousProfiling: description: continuous_profiling indicates whether continuous profiling is enabled. title: continuous_profiling type: boolean devcontainerImageCacheEnabled: title: devcontainer_image_cache_enabled type: boolean encryptedHoneycombApiKey: description: encrypted_honeycomb_api_key is the Honeycomb API key encrypted with the runner's public key. format: byte title: encrypted_honeycomb_api_key type: string logLevel: $ref: '#/components/schemas/gitpod.v1.LogLevel' title: log_level metrics: $ref: '#/components/schemas/gitpod.v1.RunnerMetricsConfiguration' title: metrics region: title: region type: string releaseChannel: $ref: '#/components/schemas/gitpod.v1.RunnerReleaseChannel' title: release_channel updateWindow: $ref: '#/components/schemas/gitpod.v1.UpdateWindow' description: "update_window defines the daily time window (UTC) during which auto-updates are allowed.\n If not\ \ set, updates are allowed at any time." title: update_window title: RunnerConfiguration type: object gitpod.v1.GetRunnerConfigurationSchemaRequest: additionalProperties: false properties: runnerId: format: uuid title: runner_id type: string title: GetRunnerConfigurationSchemaRequest type: object gitpod.v1.GetRunnerConfigurationSchemaResponse: additionalProperties: false properties: schema: $ref: '#/components/schemas/gitpod.v1.RunnerConfigurationSchema' title: schema title: GetRunnerConfigurationSchemaResponse type: object gitpod.v1.GetRunnerEnvironmentRequest: additionalProperties: false properties: environmentId: description: The environment's ID format: uuid title: environment_id type: string runnerId: description: The runner's identity format: uuid title: runner_id type: string title: GetRunnerEnvironmentRequest type: object gitpod.v1.GetRunnerEnvironmentResponse: additionalProperties: false properties: environment: $ref: '#/components/schemas/gitpod.v1.RunnerEnvironment' title: environment title: GetRunnerEnvironmentResponse type: object gitpod.v1.GetRunnerEnvironmentSnapshotRequest: additionalProperties: false properties: runnerId: description: The runner's identity format: uuid title: runner_id type: string snapshotId: description: snapshot_id specifies the snapshot to retrieve format: uuid title: snapshot_id type: string required: - runnerId - snapshotId title: GetRunnerEnvironmentSnapshotRequest type: object gitpod.v1.GetRunnerEnvironmentSnapshotResponse: additionalProperties: false properties: snapshot: $ref: '#/components/schemas/gitpod.v1.RunnerEnvironmentSnapshot' title: snapshot required: - snapshot title: GetRunnerEnvironmentSnapshotResponse type: object gitpod.v1.GetRunnerLLMIntegrationRequest: additionalProperties: false properties: llmIntegrationId: description: The LLM integration's ID format: uuid title: llm_integration_id type: string runnerId: description: The runner's identity format: uuid title: runner_id type: string title: GetRunnerLLMIntegrationRequest type: object gitpod.v1.GetRunnerLLMIntegrationResponse: additionalProperties: false properties: llmIntegration: $ref: '#/components/schemas/gitpod.v1.LLMIntegration' title: llm_integration title: GetRunnerLLMIntegrationResponse type: object gitpod.v1.GetRunnerManagerRequest: additionalProperties: false properties: runnerManagerId: minLength: 1 title: runner_manager_id type: string title: GetRunnerManagerRequest type: object gitpod.v1.GetRunnerManagerResponse: additionalProperties: false properties: runnerManager: $ref: '#/components/schemas/gitpod.v1.RunnerManager' title: runner_manager required: - runnerManager title: GetRunnerManagerResponse type: object gitpod.v1.GetRunnerRequest: additionalProperties: false properties: runnerId: format: uuid title: runner_id type: string title: GetRunnerRequest type: object gitpod.v1.GetRunnerResponse: additionalProperties: false properties: runner: $ref: '#/components/schemas/gitpod.v1.Runner' title: runner required: - runner title: GetRunnerResponse type: object gitpod.v1.GetRunnerWarmPoolRequest: additionalProperties: false properties: runnerId: description: The runner's identity format: uuid title: runner_id type: string warmPoolId: description: warm_pool_id specifies the warm pool to retrieve format: uuid title: warm_pool_id type: string required: - runnerId - warmPoolId title: GetRunnerWarmPoolRequest type: object gitpod.v1.GetRunnerWarmPoolResponse: additionalProperties: false properties: warmPool: $ref: '#/components/schemas/gitpod.v1.WarmPool' title: warm_pool required: - warmPool title: GetRunnerWarmPoolResponse type: object gitpod.v1.GetSCIMConfigurationRequest: additionalProperties: false properties: scimConfigurationId: description: scim_configuration_id is the ID of the SCIM configuration to get format: uuid title: scim_configuration_id type: string required: - scimConfigurationId title: GetSCIMConfigurationRequest type: object gitpod.v1.GetSCIMConfigurationResponse: additionalProperties: false properties: scimConfiguration: $ref: '#/components/schemas/gitpod.v1.SCIMConfiguration' description: scim_configuration is the SCIM configuration identified by the ID title: scim_configuration required: - scimConfiguration title: GetSCIMConfigurationResponse type: object gitpod.v1.GetSCMIntegrationRequest: additionalProperties: false properties: id: format: uuid title: id type: string title: GetSCMIntegrationRequest type: object gitpod.v1.GetSCMIntegrationResponse: additionalProperties: false properties: integration: $ref: '#/components/schemas/gitpod.v1.SCMIntegration' title: integration title: GetSCMIntegrationResponse type: object gitpod.v1.GetSSOConfigurationRequest: additionalProperties: false properties: ssoConfigurationId: description: sso_configuration_id is the ID of the SSO configuration to get format: uuid title: sso_configuration_id type: string required: - ssoConfigurationId title: GetSSOConfigurationRequest type: object gitpod.v1.GetSSOConfigurationResponse: additionalProperties: false properties: ssoConfiguration: $ref: '#/components/schemas/gitpod.v1.SSOConfiguration' description: sso_configuration is the SSO configuration identified by the ID title: sso_configuration required: - ssoConfiguration title: GetSSOConfigurationResponse type: object gitpod.v1.GetSSOLoginURLRequest: additionalProperties: false properties: email: description: email is the email the user wants to login with format: email title: email type: string returnTo: description: return_to is the URL the user will be redirected to after login format: uri nullable: true title: return_to type: string required: - email title: GetSSOLoginURLRequest type: object gitpod.v1.GetSSOLoginURLResponse: additionalProperties: false properties: loginUrl: description: login_url is the URL to redirect the user to for SSO login title: login_url type: string required: - loginUrl title: GetSSOLoginURLResponse type: object gitpod.v1.GetSecretValueRequest: additionalProperties: false properties: secretId: format: uuid title: secret_id type: string title: GetSecretValueRequest type: object gitpod.v1.GetSecretValueResponse: additionalProperties: false properties: value: title: value type: string title: GetSecretValueResponse type: object gitpod.v1.GetServiceAccountRequest: additionalProperties: false properties: serviceAccountId: format: uuid title: service_account_id type: string title: GetServiceAccountRequest type: object gitpod.v1.GetServiceAccountResponse: additionalProperties: false properties: serviceAccount: $ref: '#/components/schemas/gitpod.v1.ServiceAccount' title: service_account required: - serviceAccount title: GetServiceAccountResponse type: object gitpod.v1.GetServiceAccountTokenRequest: additionalProperties: false properties: serviceAccountTokenId: format: uuid title: service_account_token_id type: string title: GetServiceAccountTokenRequest type: object gitpod.v1.GetServiceAccountTokenResponse: additionalProperties: false properties: token: $ref: '#/components/schemas/gitpod.v1.ServiceAccountToken' title: token required: - token title: GetServiceAccountTokenResponse type: object gitpod.v1.GetServiceRequest: additionalProperties: false properties: id: format: uuid title: id type: string title: GetServiceRequest type: object gitpod.v1.GetServiceResponse: additionalProperties: false properties: service: $ref: '#/components/schemas/gitpod.v1.Service' title: service required: - service title: GetServiceResponse type: object gitpod.v1.GetSessionRequest: additionalProperties: false properties: sessionId: format: uuid title: session_id type: string title: GetSessionRequest type: object gitpod.v1.GetSessionResponse: additionalProperties: false properties: session: $ref: '#/components/schemas/gitpod.v1.Session' title: session title: GetSessionResponse type: object gitpod.v1.GetStripePortalUrlRequest: additionalProperties: false properties: organizationId: description: organization_id is the ID of the organization to get the Stripe portal URL for format: uuid title: organization_id type: string required: - organizationId title: GetStripePortalUrlRequest type: object gitpod.v1.GetStripePortalUrlResponse: additionalProperties: false properties: portalUrl: description: portal_url is the URL to the Stripe Customer Portal for billing management title: portal_url type: string required: - portalUrl title: GetStripePortalUrlResponse type: object gitpod.v1.GetStripePublishableKeyRequest: additionalProperties: false properties: organizationId: description: organization_id is the ID of the organization to get the publishable key for format: uuid title: organization_id type: string required: - organizationId title: GetStripePublishableKeyRequest type: object gitpod.v1.GetStripePublishableKeyResponse: additionalProperties: false properties: publishableKey: description: publishable_key is the Stripe publishable key for the organization's billing realm title: publishable_key type: string required: - publishableKey title: GetStripePublishableKeyResponse type: object gitpod.v1.GetTaskExecutionRequest: additionalProperties: false properties: id: format: uuid title: id type: string title: GetTaskExecutionRequest type: object gitpod.v1.GetTaskExecutionResponse: additionalProperties: false properties: taskExecution: $ref: '#/components/schemas/gitpod.v1.TaskExecution' title: task_execution required: - taskExecution title: GetTaskExecutionResponse type: object gitpod.v1.GetTaskRequest: additionalProperties: false properties: id: format: uuid title: id type: string title: GetTaskRequest type: object gitpod.v1.GetTaskResponse: additionalProperties: false properties: task: $ref: '#/components/schemas/gitpod.v1.Task' title: task required: - task title: GetTaskResponse type: object gitpod.v1.GetTeamCreditAllocationRequest: additionalProperties: false properties: organizationId: format: uuid title: organization_id type: string teamId: format: uuid title: team_id type: string required: - organizationId - teamId title: GetTeamCreditAllocationRequest type: object gitpod.v1.GetTeamCreditAllocationResponse: additionalProperties: false properties: allocation: $ref: '#/components/schemas/gitpod.v1.TeamCreditAllocationInfo' title: allocation title: GetTeamCreditAllocationResponse type: object gitpod.v1.GetTeamRequest: additionalProperties: false properties: teamId: format: uuid title: team_id type: string title: GetTeamRequest type: object gitpod.v1.GetTeamResponse: additionalProperties: false properties: team: $ref: '#/components/schemas/gitpod.v1.Team' title: team title: GetTeamResponse type: object gitpod.v1.GetTopActiveUsersRequest: additionalProperties: false properties: dateRange: $ref: '#/components/schemas/gitpod.v1.DateRange' description: Date range to query metrics within. title: date_range pagination: $ref: '#/components/schemas/gitpod.v1.PaginationRequest' title: pagination projectId: description: Optional project ID to filter metrics by. title: project_id type: string required: - dateRange title: GetTopActiveUsersRequest type: object gitpod.v1.GetTopActiveUsersResponse: additionalProperties: false properties: pagination: $ref: '#/components/schemas/gitpod.v1.PaginationResponse' title: pagination users: description: List of users sorted by total runtime (descending). items: $ref: '#/components/schemas/gitpod.v1.GetTopActiveUsersResponse.UserRuntimeInfo' title: users type: array title: GetTopActiveUsersResponse type: object gitpod.v1.GetTopActiveUsersResponse.UserRuntimeInfo: additionalProperties: false properties: totalRuntimeSeconds: description: Total environment runtime in seconds. format: double title: total_runtime_seconds type: number userAvatarUrl: description: User avatar if available. title: user_avatar_url type: string userId: description: User ID. title: user_id type: string userName: description: User name if available. title: user_name type: string title: UserRuntimeInfo type: object gitpod.v1.GetTopEnvironmentClassesRequest: additionalProperties: false properties: dateRange: $ref: '#/components/schemas/gitpod.v1.DateRange' description: Date range to query metrics within. title: date_range pagination: $ref: '#/components/schemas/gitpod.v1.PaginationRequest' description: Pagination options. title: pagination projectId: description: Optional project ID to filter metrics by. title: project_id type: string required: - dateRange title: GetTopEnvironmentClassesRequest type: object gitpod.v1.GetTopEnvironmentClassesResponse: additionalProperties: false properties: environmentClasses: description: List of environment classes sorted by total runtime (descending). All environment classes belonging to local runners are grouped together. items: $ref: '#/components/schemas/gitpod.v1.GetTopEnvironmentClassesResponse.EnvironmentClassRuntimeInfo' title: environment_classes type: array pagination: $ref: '#/components/schemas/gitpod.v1.PaginationResponse' title: pagination title: GetTopEnvironmentClassesResponse type: object gitpod.v1.GetTopEnvironmentClassesResponse.EnvironmentClassRuntimeInfo: additionalProperties: false properties: environmentClassId: description: Environment class ID. Not set for local runners. title: environment_class_id type: string environmentClassName: description: Environment class name if available. title: environment_class_name type: string runnerKind: $ref: '#/components/schemas/gitpod.v1.RunnerKind' description: Type of runner that created the environment class. title: runner_kind runnerName: description: Name of the runner that created the environment class. title: runner_name type: string totalRuntimeSeconds: description: Total runtime in seconds. title: total_runtime_seconds type: string title: EnvironmentClassRuntimeInfo type: object gitpod.v1.GetTopProjectsRequest: additionalProperties: false properties: dateRange: $ref: '#/components/schemas/gitpod.v1.DateRange' description: Date range to query metrics within. title: date_range pagination: $ref: '#/components/schemas/gitpod.v1.PaginationRequest' description: Pagination options. title: pagination required: - dateRange title: GetTopProjectsRequest type: object gitpod.v1.GetTopProjectsResponse: additionalProperties: false properties: pagination: $ref: '#/components/schemas/gitpod.v1.PaginationResponse' description: Pagination response. title: pagination projects: description: List of projects sorted by total runtime (descending). items: $ref: '#/components/schemas/gitpod.v1.GetTopProjectsResponse.ProjectRuntimeInfo' title: projects type: array title: GetTopProjectsResponse type: object gitpod.v1.GetTopProjectsResponse.ProjectRuntimeInfo: additionalProperties: false properties: projectId: description: Project ID. title: project_id type: string projectName: description: Project name if available. title: project_name type: string totalRuntimeSeconds: description: Total runtime in seconds. title: total_runtime_seconds type: string title: ProjectRuntimeInfo type: object gitpod.v1.GetUserRequest: additionalProperties: false properties: userId: format: uuid title: user_id type: string title: GetUserRequest type: object gitpod.v1.GetUserResponse: additionalProperties: false properties: user: $ref: '#/components/schemas/gitpod.v1.User' title: user required: - user title: GetUserResponse type: object gitpod.v1.GetWarmPoolRequest: additionalProperties: false properties: warmPoolId: description: warm_pool_id specifies the warm pool to retrieve format: uuid title: warm_pool_id type: string required: - warmPoolId title: GetWarmPoolRequest type: object gitpod.v1.GetWarmPoolResponse: additionalProperties: false properties: warmPool: $ref: '#/components/schemas/gitpod.v1.WarmPool' title: warm_pool required: - warmPool title: GetWarmPoolResponse type: object gitpod.v1.GetWebhookRequest: additionalProperties: false description: GetWebhookRequest gets details about a specific webhook. properties: webhookId: format: uuid title: webhook_id type: string title: GetWebhookRequest type: object gitpod.v1.GetWebhookResponse: additionalProperties: false properties: webhook: $ref: '#/components/schemas/gitpod.v1.Webhook' title: webhook title: GetWebhookResponse type: object gitpod.v1.GetWebhookSecretRequest: additionalProperties: false description: GetWebhookSecretRequest retrieves the webhook secret. properties: webhookId: format: uuid title: webhook_id type: string title: GetWebhookSecretRequest type: object gitpod.v1.GetWebhookSecretResponse: additionalProperties: false properties: secret: description: The decrypted webhook secret title: secret type: string title: GetWebhookSecretResponse type: object gitpod.v1.GetWorkflowExecutionActionRequest: additionalProperties: false description: GetWorkflowExecutionActionRequest gets details about a specific workflow execution action. properties: workflowExecutionActionId: format: uuid title: workflow_execution_action_id type: string title: GetWorkflowExecutionActionRequest type: object gitpod.v1.GetWorkflowExecutionActionResponse: additionalProperties: false properties: workflowExecutionAction: $ref: '#/components/schemas/gitpod.v1.WorkflowExecutionAction' title: workflow_execution_action title: GetWorkflowExecutionActionResponse type: object gitpod.v1.GetWorkflowExecutionRequest: additionalProperties: false description: GetWorkflowExecutionRequest gets details about a specific workflow execution. properties: workflowExecutionId: format: uuid title: workflow_execution_id type: string title: GetWorkflowExecutionRequest type: object gitpod.v1.GetWorkflowExecutionResponse: additionalProperties: false properties: workflowExecution: $ref: '#/components/schemas/gitpod.v1.WorkflowExecution' title: workflow_execution title: GetWorkflowExecutionResponse type: object gitpod.v1.GetWorkflowExecutionSummaryRequest: additionalProperties: false description: GetWorkflowExecutionSummaryRequest returns aggregate counts of workflow executions. properties: filter: $ref: '#/components/schemas/gitpod.v1.GetWorkflowExecutionSummaryRequest.Filter' title: filter required: - filter title: GetWorkflowExecutionSummaryRequest type: object gitpod.v1.GetWorkflowExecutionSummaryRequest.Filter: additionalProperties: false properties: dateRange: $ref: '#/components/schemas/gitpod.v1.DateRange' description: Date range to query executions within. title: date_range workflowIds: description: Optional workflow IDs to scope the summary to specific workflows. items: format: uuid maxItems: 25 type: string maxItems: 25 title: workflow_ids type: array required: - dateRange title: Filter type: object gitpod.v1.GetWorkflowExecutionSummaryResponse: additionalProperties: false properties: failedCount: description: "Number of failed executions: COMPLETED with failed_action_count > 0, or STOPPED with\n failed_action_count\ \ > 0 or a non-empty failure_message (matches dashboard \"Failed\" labeling)." title: failed_count type: string successfulCount: description: Number of executions in COMPLETED phase with no failed actions (failed_action_count == 0). title: successful_count type: string totalCount: description: Total number of executions in the time range, regardless of phase. title: total_count type: string totalWorkflowsInOrganization: description: "Total number of workflows that exist in the organization.\n This count is independent of the date\ \ range filter." title: total_workflows_in_organization type: string title: GetWorkflowExecutionSummaryResponse 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 gitpod.v1.GetWorkflowResponse: additionalProperties: false properties: workflow: $ref: '#/components/schemas/gitpod.v1.Workflow' title: workflow title: GetWorkflowResponse type: object gitpod.v1.GetWorkflowWebhookSecretRequest: additionalProperties: false description: GetWorkflowWebhookSecretRequest retrieves the webhook secret for a workflow. properties: workflowId: format: uuid title: workflow_id type: string title: GetWorkflowWebhookSecretRequest type: object gitpod.v1.GetWorkflowWebhookSecretResponse: additionalProperties: false properties: secret: description: The decrypted webhook secret title: secret type: string title: GetWorkflowWebhookSecretResponse type: object gitpod.v1.GitInitializer: additionalProperties: false properties: checkoutLocation: description: "a path relative to the environment root in which the code will be checked out\n to" title: checkout_location type: string cloneTarget: description: the value for the clone target mode - use depends on the target mode title: clone_target type: string remoteUri: description: remote_uri is the Git remote origin title: remote_uri type: string targetMode: $ref: '#/components/schemas/gitpod.v1.GitInitializer.CloneTargetMode' description: the target mode determines what gets checked out title: target_mode upstreamRemoteUri: description: upstream_Remote_uri is the fork upstream of a repository title: upstream_remote_uri type: string title: GitInitializer type: object gitpod.v1.GitInitializer.CloneTargetMode: description: "CloneTargetMode is the target state in which we want to leave a\n GitEnvironment" enum: - CLONE_TARGET_MODE_UNSPECIFIED - CLONE_TARGET_MODE_REMOTE_HEAD - CLONE_TARGET_MODE_REMOTE_COMMIT - CLONE_TARGET_MODE_REMOTE_BRANCH - CLONE_TARGET_MODE_LOCAL_BRANCH - CLONE_TARGET_MODE_REMOTE_TAG title: CloneTargetMode type: string gitpod.v1.GrantCreditsRequest: additionalProperties: false properties: creditsAmount: description: credits_amount is the amount of credits to grant (must be >= 40) format: double minimum: 40 title: credits_amount type: number organizationId: description: organization_id is the ID of the organization to grant credits to format: uuid title: organization_id type: string required: - organizationId - creditsAmount title: GrantCreditsRequest type: object gitpod.v1.GrantCreditsResponse: additionalProperties: false title: GrantCreditsResponse type: object gitpod.v1.Group: additionalProperties: false properties: createdAt: $ref: '#/components/schemas/google.protobuf.Timestamp' title: created_at description: maxLength: 255 title: description type: string directShare: description: "direct_share indicates that this group is used for direct user sharing on resources.\n These groups\ \ are hidden from regular group listings." title: direct_share type: boolean id: format: uuid title: id type: string memberCount: description: member_count is the total number of members in this group format: int32 title: member_count type: integer name: maxLength: 80 minLength: 3 title: name type: string organizationId: format: uuid title: organization_id type: string systemManaged: description: system_managed indicates that this group is created by the system automatically title: system_managed type: boolean updatedAt: $ref: '#/components/schemas/google.protobuf.Timestamp' title: updated_at title: Group type: object gitpod.v1.GroupMembership: additionalProperties: false description: GroupMembership represents a subject's membership in a group properties: avatarUrl: description: Subject's avatar URL title: avatar_url type: string groupId: description: Group identifier format: uuid title: group_id type: string id: description: Unique identifier for the group membership format: uuid title: id type: string name: description: Subject's display name title: name type: string subject: $ref: '#/components/schemas/gitpod.v1.Subject' description: Subject (user, runner, environment, service account, etc.) title: subject title: GroupMembership type: object gitpod.v1.HostAuthenticationToken: additionalProperties: false properties: expiresAt: $ref: '#/components/schemas/google.protobuf.Timestamp' title: expires_at host: title: host type: string id: title: id type: string integrationId: description: links to integration instance title: integration_id type: string runnerId: title: runner_id type: string scopes: description: token permissions items: type: string title: scopes type: array source: $ref: '#/components/schemas/gitpod.v1.HostAuthenticationTokenSource' description: auth_type title: source subject: $ref: '#/components/schemas/gitpod.v1.Subject' description: 'Subject identifies the principal (user or service account) for the token Note: actual token and refresh_token values are retrieved via GetHostAuthenticationTokenValue API' title: subject userId: deprecated: true description: 'Deprecated: Use principal_id and principal_type instead principal (user)' title: user_id type: string required: - id title: HostAuthenticationToken type: object gitpod.v1.HostAuthenticationTokenSource: enum: - HOST_AUTHENTICATION_TOKEN_SOURCE_UNSPECIFIED - HOST_AUTHENTICATION_TOKEN_SOURCE_OAUTH - HOST_AUTHENTICATION_TOKEN_SOURCE_PAT title: HostAuthenticationTokenSource type: string gitpod.v1.IDTokenVersion: enum: - ID_TOKEN_VERSION_UNSPECIFIED - ID_TOKEN_VERSION_V1 - ID_TOKEN_VERSION_V2 title: IDTokenVersion type: string gitpod.v1.ImprovePromptForAgentRequest: additionalProperties: false properties: agentId: format: uuid title: agent_id type: string prompt: title: prompt type: string title: ImprovePromptForAgentRequest type: object gitpod.v1.ImprovePromptForAgentResponse: additionalProperties: false properties: improvedPrompt: title: improved_prompt type: string title: ImprovePromptForAgentResponse type: object gitpod.v1.InEnvironmentAgentSpec: additionalProperties: false properties: requiredModels: description: The list of models supported by this in-environment agent items: $ref: '#/components/schemas/gitpod.v1.SupportedModel' title: required_models type: array service: $ref: '#/components/schemas/gitpod.v1.ServiceSpec' title: service title: InEnvironmentAgentSpec type: object gitpod.v1.InsertUsageEventsRequest: additionalProperties: false properties: events: description: Events to insert. items: $ref: '#/components/schemas/gitpod.v1.UsageEventInput' maxItems: 1000 minItems: 1 title: events type: array ignoreAgeCheck: description: "If true, allow events with timestamps older than 35 days.\n By default, old events are rejected because\ \ Stripe cannot accept them." title: ignore_age_check type: boolean reason: description: Why these events are being inserted (stored in audit log and event payload). minLength: 1 title: reason type: string title: InsertUsageEventsRequest type: object gitpod.v1.InsertUsageEventsResponse: additionalProperties: false properties: errorCount: format: int32 title: error_count type: integer insertedCount: description: Summary counts. format: int32 title: inserted_count type: integer results: description: "One result per input event, in the same order as the request.\n Each result echoes the original input\ \ fields plus status columns,\n so the CLI can write the response directly to stdout as CSV." items: $ref: '#/components/schemas/gitpod.v1.UsageEventInsertResult' title: results type: array skippedCount: format: int32 title: skipped_count type: integer title: InsertUsageEventsResponse type: object gitpod.v1.Integration: additionalProperties: false description: Integration represents an instantiated integration within an organization properties: auth: $ref: '#/components/schemas/gitpod.v1.IntegrationAuthentication' description: auth defines which authentication methods are enabled for this integration title: auth capabilities: $ref: '#/components/schemas/gitpod.v1.IntegrationCapabilities' description: capabilities defines which capabilities are enabled for this integration title: capabilities enabled: description: enabled indicates if this integration is currently enabled title: enabled type: boolean host: description: host is the hostname for this integration (e.g., "linear.app") - optional, inherits from definition title: host type: string id: description: id is the unique identifier for this integration instance title: id type: string integrationDefinitionId: description: integration_definition_id references the integration definition ID title: integration_definition_id type: string organizationId: description: organization_id is the organization this integration belongs to title: organization_id type: string runnerId: description: runner_id - if set, restricts integration to specific runner title: runner_id type: string required: - id - organizationId - integrationDefinitionId title: Integration type: object gitpod.v1.IntegrationAPIKeyConfig: additionalProperties: false description: IntegrationAPIKeyConfig defines API key authentication configuration Additional API key configuration can be added here title: IntegrationAPIKeyConfig type: object gitpod.v1.IntegrationAgentClientCapability: additionalProperties: false description: "IntegrationAgentClientCapability indicates the integration supports agent client functionality.\n The\ \ webhook signing secret is stored in IntegrationProprietaryAppConfig.webhook_secret. Empty - presence of this capability\ \ indicates agent client support" title: IntegrationAgentClientCapability type: object gitpod.v1.IntegrationAuthentication: additionalProperties: false description: IntegrationAuthentication defines authentication requirements and options properties: apiKey: $ref: '#/components/schemas/gitpod.v1.IntegrationAPIKeyConfig' description: api_key configuration if API key authentication is supported title: api_key oauth: $ref: '#/components/schemas/gitpod.v1.IntegrationOAuthConfig' description: oauth configuration if OAuth authentication is supported title: oauth proprietaryApp: $ref: '#/components/schemas/gitpod.v1.IntegrationProprietaryAppConfig' description: proprietary configuration if supported title: proprietary_app requiresAuth: description: requires_auth indicates if authentication is required for this integration title: requires_auth type: boolean title: IntegrationAuthentication type: object gitpod.v1.IntegrationCapabilities: additionalProperties: false description: IntegrationCapabilities defines what an integration can do properties: agentClient: $ref: '#/components/schemas/gitpod.v1.IntegrationAgentClientCapability' description: agent_client configuration for agent client functionality support title: agent_client contextParsing: $ref: '#/components/schemas/gitpod.v1.IntegrationContextParsingCapability' description: context_parsing configuration for context parsing support title: context_parsing login: $ref: '#/components/schemas/gitpod.v1.IntegrationLoginCapability' description: login configuration for login/authentication support title: login mcp: $ref: '#/components/schemas/gitpod.v1.IntegrationMCPCapability' description: mcp configuration for Model Context Protocol support title: mcp sourceCodeAccess: $ref: '#/components/schemas/gitpod.v1.IntegrationSourceCodeAccessCapability' description: source_code_access configuration for source code access support title: source_code_access title: IntegrationCapabilities type: object gitpod.v1.IntegrationContextParsingCapability: additionalProperties: false description: IntegrationContextParsingCapability defines context parsing capability Additional context parsing configuration can be added here title: IntegrationContextParsingCapability type: object gitpod.v1.IntegrationDefinition: additionalProperties: false description: "IntegrationDefinition defines a service that can be integrated with\n (e.g. Linear, GitHub, etc.)" properties: auth: $ref: '#/components/schemas/gitpod.v1.IntegrationAuthentication' description: auth defines the authentication requirements for this integration title: auth capabilities: $ref: '#/components/schemas/gitpod.v1.IntegrationCapabilities' description: capabilities defines what this integration can do title: capabilities description: description: description provides a human-readable description of the integration title: description type: string experimental: description: experimental indicates if this integration is experimental and requires feature flag title: experimental type: boolean host: description: host is the hostname for this integration (e.g., "linear.app") title: host type: string iconUrl: description: icon_url is the URL for this integration's icon title: icon_url type: string id: description: id is the unique identifier for this integration definition title: id type: string name: description: name is the human-readable name for this integration type title: name type: string required: - id - name title: IntegrationDefinition type: object gitpod.v1.IntegrationLoginCapability: additionalProperties: false description: IntegrationLoginCapability defines login/authentication capability Additional login configuration can be added here title: IntegrationLoginCapability type: object gitpod.v1.IntegrationMCPCapability: additionalProperties: false description: IntegrationMCPCapability defines Model Context Protocol capability properties: url: description: url is the remote server URL for the MCP server title: url type: string title: IntegrationMCPCapability type: object gitpod.v1.IntegrationOAuthConfig: additionalProperties: false description: IntegrationOAuthConfig defines OAuth-specific configuration properties: authParams: additionalProperties: title: value type: string description: "auth_params are additional query parameters to include in the OAuth\n authorization URL. Use comma-separated\ \ values for multi-value params\n (e.g., \"search:read,chat:write\" for Slack's user_scope)." title: auth_params type: object authUrl: description: auth_url is the OAuth authorization endpoint URL title: auth_url type: string clientId: description: client_id is the OAuth client ID (optional if dynamic_registration is enabled) title: client_id type: string clientSecret: description: client_secret is the OAuth client secret (optional for public clients) title: client_secret type: string dynamicRegistration: description: "dynamic_registration enables RFC 7591 OAuth 2.0 Dynamic Client Registration.\n When enabled, client\ \ credentials are obtained automatically from the authorization\n server's registration endpoint (discovered via\ \ RFC 8414 metadata).\n When disabled (default), client_id and client_secret must be pre-configured." title: dynamic_registration type: boolean redirectUrl: description: redirect_url is the OAuth callback/redirect URL title: redirect_url type: string scopes: description: scopes are the OAuth scopes to request items: type: string title: scopes type: array tokenUrl: description: token_url is the OAuth token endpoint URL title: token_url type: string title: IntegrationOAuthConfig type: object gitpod.v1.IntegrationOAuthConfig.AuthParamsEntry: additionalProperties: false properties: key: title: key type: string value: title: value type: string title: AuthParamsEntry type: object gitpod.v1.IntegrationProprietaryAppConfig: additionalProperties: false description: "IntegrationProprietaryAppConfig defines proprietary application integration configuration.\n Used for\ \ app installations that interact with Ona (e.g., GitHub Apps, Linear agent apps)." properties: appId: description: "app_id is the application identifier assigned by the provider (e.g., GitHub App ID).\n Used to authenticate\ \ as the application itself." title: app_id type: string appScopes: description: "app_scopes are OAuth scopes to request when using app installation flows.\n If not set, falls back\ \ to the standard OAuth scopes." items: type: string title: app_scopes type: array appSlug: description: "app_slug is the URL-friendly identifier assigned by the provider (e.g., GitHub App slug).\n Used to\ \ construct installation URLs like https://github.com/apps/{app_slug}/installations/new." title: app_slug type: string authParams: additionalProperties: title: value type: string description: "auth_params are additional OAuth authorization parameters to include in the auth URL.\n Example: {\"\ actor\": \"app\"} for Linear agent installations." title: auth_params type: object clientId: description: client_id is the app client ID title: client_id type: string clientSecret: description: client_secret is the app client secret title: client_secret type: string privateKey: description: "private_key is the PEM-encoded private key used to sign JWTs for app authentication.\n This is sensitive\ \ and will be censored in API responses." title: private_key type: string tokenUrl: description: "token_url is the OAuth token exchange endpoint for app installation flows.\n If not set, falls back\ \ to the standard oauth.token_url.\n Slack requires a different token endpoint for app-level vs user-level flows." title: token_url type: string webhookSecret: description: webhook_secret is the secret used to verify webhook signatures from the app provider title: webhook_secret type: string title: IntegrationProprietaryAppConfig type: object gitpod.v1.IntegrationProprietaryAppConfig.AuthParamsEntry: additionalProperties: false properties: key: title: key type: string value: title: value type: string title: AuthParamsEntry type: object gitpod.v1.IntegrationSourceCodeAccessCapability: additionalProperties: false description: IntegrationSourceCodeAccessCapability defines source code access capability Additional source code access configuration can be added here title: IntegrationSourceCodeAccessCapability type: object gitpod.v1.InviteDomains: additionalProperties: false properties: domains: description: domains is the list of domains that are allowed to join the organization items: maxLength: 253 minLength: 4 pattern: ^(?:[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?\.)+[a-zA-Z]{2,}$ type: string uniqueItems: true title: domains type: array uniqueItems: true title: InviteDomains type: object gitpod.v1.JoinOrganizationRequest: additionalProperties: false oneOf: - not: anyOf: - required: - organizationId required: - inviteId - not: anyOf: - required: - inviteId required: - organizationId properties: inviteId: description: invite_id is the unique identifier of the invite to join the organization. format: uuid title: invite_id type: string organizationId: description: organization_id is the unique identifier of the Organization to join. format: uuid title: organization_id type: string title: JoinOrganizationRequest type: object gitpod.v1.JoinOrganizationResponse: additionalProperties: false properties: member: $ref: '#/components/schemas/gitpod.v1.OrganizationMember' description: member is the member that was created by joining the organization. title: member required: - member title: JoinOrganizationResponse type: object gitpod.v1.JoinableOrganization: additionalProperties: false properties: organizationId: description: organization_id is the id of the organization the user can join format: uuid title: organization_id type: string organizationMemberCount: description: organization_member_count is the member count of the organization the user can join format: int32 title: organization_member_count type: integer organizationName: description: organization_name is the name of the organization the user can join title: organization_name type: string required: - organizationId - organizationName title: JoinableOrganization type: object gitpod.v1.KernelControlsAction: description: KernelControlsAction defines how a kernel-level policy violation is handled. enum: - KERNEL_CONTROLS_ACTION_UNSPECIFIED - KERNEL_CONTROLS_ACTION_BLOCK - KERNEL_CONTROLS_ACTION_AUDIT title: KernelControlsAction type: string gitpod.v1.KernelControlsConfig: additionalProperties: false description: KernelControlsConfig configures kernel-level controls for the environment properties: bpfDebugLevel: $ref: '#/components/schemas/gitpod.v1.BPFDebugLevel' description: "bpf_debug_level controls the verbosity of BPF trace_pipe output\n for all BPF-based agents in this\ \ environment." title: bpf_debug_level x-stainless-skip: true veto: $ref: '#/components/schemas/gitpod.v1.Veto' description: veto controls blocking mechanisms title: veto title: KernelControlsConfig type: object gitpod.v1.LLMIntegration: additionalProperties: false properties: encryptedApiKey: description: encrypted_api_key is the LLM provider's API key encrypted with the runner's public key. format: byte title: encrypted_api_key type: string endpoint: title: endpoint type: string id: description: id is the unique identifier of the LLM integration title: id type: string maxTokens: description: the maximum number of tokens to generate before stopping. 0 is a model default. title: max_tokens type: string models: description: models represents the supported LLM models for this integration items: $ref: '#/components/schemas/gitpod.v1.SupportedModel' title: models type: array phase: $ref: '#/components/schemas/gitpod.v1.LLMIntegrationPhase' description: phase represents the current status/phase of the LLM integration title: phase phaseReason: description: phase_reason provides explanation for the current phase (e.g., "insufficient funds", "user disabled") title: phase_reason type: string requestHeaders: description: request_headers contains optional headers for the LLM integration. items: $ref: '#/components/schemas/gitpod.v1.LLMIntegrationRequestHeader' title: request_headers type: array runnerId: title: runner_id type: string title: LLMIntegration type: object gitpod.v1.LLMIntegrationPhase: description: LLMIntegrationPhase represents the current status/phase of an LLM integration enum: - LLM_INTEGRATION_PHASE_UNSPECIFIED - LLM_INTEGRATION_PHASE_AVAILABLE - LLM_INTEGRATION_PHASE_UNAVAILABLE - LLM_INTEGRATION_PHASE_DISABLED title: LLMIntegrationPhase type: string gitpod.v1.LLMIntegrationRequestHeader: additionalProperties: false description: "LLMIntegrationRequestHeader represents a custom header to be passed to LLM requests.\n The value field\ \ contains:\n - Plain text values in update requests (will be encrypted server-side).\n - Encrypted binary values\ \ on read requests (decrypt directly to get original value)." properties: key: title: key type: string value: format: byte title: value type: string title: LLMIntegrationRequestHeader type: object gitpod.v1.LLMUsage: additionalProperties: false properties: cacheInputCreationTokens: description: Number of tokens used for cache input creation title: cache_input_creation_tokens type: string cachedInputTokens: description: Number of cached input tokens used title: cached_input_tokens type: string ephemeral1hInputTokens: description: Number of ephemeral 1-hour input tokens used title: ephemeral_1h_input_tokens type: string ephemeral5mInputTokens: description: Number of ephemeral 5-minute input tokens used title: ephemeral_5m_input_tokens type: string inputTokens: description: Number of input tokens consumed title: input_tokens type: string outputTokens: description: Number of output tokens generated title: output_tokens type: string title: LLMUsage type: object gitpod.v1.LLMUsageSummary: additionalProperties: false description: LLMUsageSummary contains aggregated LLM usage data for a specific time period properties: creditsConsumed: description: credits_consumed is the total Ona credits consumed in this period format: double title: credits_consumed type: number dailyBreakdown: description: daily_breakdown contains per-day usage data for charting items: $ref: '#/components/schemas/gitpod.v1.DailyUsage' title: daily_breakdown type: array title: LLMUsageSummary type: object gitpod.v1.LeaveOrganizationRequest: additionalProperties: false properties: userId: format: uuid title: user_id type: string required: - userId title: LeaveOrganizationRequest type: object gitpod.v1.LeaveOrganizationResponse: additionalProperties: false title: LeaveOrganizationResponse type: object gitpod.v1.ListAgentExecutionsRequest: additionalProperties: false properties: filter: $ref: '#/components/schemas/gitpod.v1.ListAgentExecutionsRequest.Filter' title: filter pagination: $ref: '#/components/schemas/gitpod.v1.PaginationRequest' title: pagination title: ListAgentExecutionsRequest type: object gitpod.v1.ListAgentExecutionsRequest.Filter: additionalProperties: false properties: agentIds: items: maxItems: 25 type: string maxItems: 25 title: agent_ids type: array annotations: additionalProperties: title: value type: string description: "annotations filters by key-value pairs. Only executions containing\n all specified annotations (with\ \ matching values) are returned." title: annotations type: object creatorIds: items: maxItems: 25 type: string maxItems: 25 title: creator_ids type: array environmentIds: items: maxItems: 25 type: string maxItems: 25 title: environment_ids type: array projectIds: items: format: uuid maxItems: 25 type: string maxItems: 25 title: project_ids type: array roles: items: $ref: '#/components/schemas/gitpod.v1.AgentExecutionRole' maxItems: 25 title: roles type: array sessionIds: description: session_ids filters the response to only executions belonging to the specified sessions items: format: uuid maxItems: 25 type: string maxItems: 25 title: session_ids type: array statusPhases: items: $ref: '#/components/schemas/gitpod.v1.AgentExecution.Phase' maxItems: 25 title: status_phases type: array title: Filter type: object gitpod.v1.ListAgentExecutionsRequest.Filter.AnnotationsEntry: additionalProperties: false properties: key: title: key type: string value: title: value type: string title: AnnotationsEntry type: object gitpod.v1.ListAgentExecutionsResponse: additionalProperties: false properties: agentExecutions: items: $ref: '#/components/schemas/gitpod.v1.AgentExecution' title: agent_executions type: array pagination: $ref: '#/components/schemas/gitpod.v1.PaginationResponse' title: pagination title: ListAgentExecutionsResponse type: object gitpod.v1.ListAgentsRequest: additionalProperties: false properties: pagination: $ref: '#/components/schemas/gitpod.v1.PaginationRequest' title: pagination title: ListAgentsRequest type: object gitpod.v1.ListAgentsResponse: additionalProperties: false properties: agents: items: $ref: '#/components/schemas/gitpod.v1.Agent' title: agents type: array pagination: $ref: '#/components/schemas/gitpod.v1.PaginationResponse' title: pagination title: ListAgentsResponse type: object gitpod.v1.ListAuditLogsRequest: additionalProperties: false properties: filter: $ref: '#/components/schemas/gitpod.v1.ListAuditLogsRequest.Filter' title: filter pagination: $ref: '#/components/schemas/gitpod.v1.PaginationRequest' description: pagination contains the pagination options for listing audit logs title: pagination sort: $ref: '#/components/schemas/gitpod.v1.Sort' description: "sort specifies the order of results. When unspecified, results are sorted\n by creation time descending\ \ (newest first).\n Supported sort fields: createdAt." title: sort title: ListAuditLogsRequest type: object gitpod.v1.ListAuditLogsRequest.Filter: additionalProperties: false properties: actorIds: items: format: uuid maxItems: 25 type: string maxItems: 25 title: actor_ids type: array actorPrincipals: items: $ref: '#/components/schemas/gitpod.v1.Principal' maxItems: 25 title: actor_principals type: array from: $ref: '#/components/schemas/google.protobuf.Timestamp' description: from filters audit logs created at or after this timestamp (inclusive). nullable: true title: from subjectIds: items: format: uuid maxItems: 25 type: string maxItems: 25 title: subject_ids type: array subjectTypes: items: $ref: '#/components/schemas/gitpod.v1.ResourceType' maxItems: 25 title: subject_types type: array to: $ref: '#/components/schemas/google.protobuf.Timestamp' description: to filters audit logs created before this timestamp (exclusive). nullable: true title: to title: Filter type: object gitpod.v1.ListAuditLogsResponse: additionalProperties: false properties: entries: items: $ref: '#/components/schemas/gitpod.v1.ListAuditLogsResponse.AuditLogEntry' title: entries type: array pagination: $ref: '#/components/schemas/gitpod.v1.PaginationResponse' description: pagination contains the pagination options for listing environments title: pagination title: ListAuditLogsResponse type: object gitpod.v1.ListAuditLogsResponse.AuditLogEntry: additionalProperties: false properties: action: title: action type: string actorId: title: actor_id type: string actorPrincipal: $ref: '#/components/schemas/gitpod.v1.Principal' title: actor_principal createdAt: $ref: '#/components/schemas/google.protobuf.Timestamp' title: created_at id: title: id type: string subjectId: title: subject_id type: string subjectType: $ref: '#/components/schemas/gitpod.v1.ResourceType' title: subject_type title: AuditLogEntry type: object gitpod.v1.ListAvailableRunnerManagersRequest: additionalProperties: false properties: pagination: $ref: '#/components/schemas/gitpod.v1.PaginationRequest' description: pagination contains the pagination options for listing available runner managers title: pagination title: ListAvailableRunnerManagersRequest type: object gitpod.v1.ListAvailableRunnerManagersResponse: additionalProperties: false properties: pagination: $ref: '#/components/schemas/gitpod.v1.PaginationResponse' description: pagination contains the pagination options for listing available runner managers title: pagination runnerManagers: description: The runner managers available for the organization items: $ref: '#/components/schemas/gitpod.v1.AvailableRunnerManager' title: runner_managers type: array title: ListAvailableRunnerManagersResponse type: object gitpod.v1.ListCouponsRequest: additionalProperties: false properties: filter: $ref: '#/components/schemas/gitpod.v1.ListCouponsRequest.Filter' title: filter pagination: $ref: '#/components/schemas/gitpod.v1.PaginationRequest' description: pagination contains the pagination options for listing coupons title: pagination title: ListCouponsRequest type: object gitpod.v1.ListCouponsRequest.Filter: additionalProperties: false properties: code: description: code filters coupons by exact code match nullable: true title: code type: string couponIds: description: coupon_ids filters the response to only coupons with these IDs items: format: uuid maxItems: 25 type: string maxItems: 25 title: coupon_ids type: array expiresAfter: $ref: '#/components/schemas/google.protobuf.Timestamp' description: expires_after filters coupons that expire after this timestamp nullable: true title: expires_after expiresBefore: $ref: '#/components/schemas/google.protobuf.Timestamp' description: expires_before filters coupons that expire before this timestamp nullable: true title: expires_before title: Filter type: object gitpod.v1.ListCouponsResponse: additionalProperties: false properties: coupons: items: $ref: '#/components/schemas/gitpod.v1.Coupon' title: coupons type: array pagination: $ref: '#/components/schemas/gitpod.v1.PaginationResponse' description: pagination contains the pagination response title: pagination title: ListCouponsResponse type: object gitpod.v1.ListDomainVerificationsRequest: additionalProperties: false properties: organizationId: format: uuid title: organization_id type: string pagination: $ref: '#/components/schemas/gitpod.v1.PaginationRequest' title: pagination required: - organizationId title: ListDomainVerificationsRequest type: object gitpod.v1.ListDomainVerificationsResponse: additionalProperties: false properties: domainVerifications: items: $ref: '#/components/schemas/gitpod.v1.DomainVerification' title: domain_verifications type: array pagination: $ref: '#/components/schemas/gitpod.v1.PaginationResponse' title: pagination required: - pagination title: ListDomainVerificationsResponse type: object gitpod.v1.ListEditorsRequest: additionalProperties: false properties: filter: $ref: '#/components/schemas/gitpod.v1.ListEditorsRequest.Filter' description: filter contains the filter options for listing editors title: filter pagination: $ref: '#/components/schemas/gitpod.v1.PaginationRequest' description: pagination contains the pagination options for listing environments title: pagination title: ListEditorsRequest type: object gitpod.v1.ListEditorsRequest.Filter: additionalProperties: false properties: allowedByPolicy: description: allowed_by_policy filters the response to only editors that are allowed by the policies enforced in the organization title: allowed_by_policy type: boolean title: Filter type: object gitpod.v1.ListEditorsResponse: additionalProperties: false properties: editors: description: editors contains the list of editors items: $ref: '#/components/schemas/gitpod.v1.Editor' title: editors type: array pagination: $ref: '#/components/schemas/gitpod.v1.PaginationResponse' description: pagination contains the pagination options for listing environments title: pagination required: - editors title: ListEditorsResponse type: object gitpod.v1.ListEnvironmentClassesRequest: additionalProperties: false properties: filter: $ref: '#/components/schemas/gitpod.v1.ListEnvironmentClassesRequest.Filter' title: filter pagination: $ref: '#/components/schemas/gitpod.v1.PaginationRequest' description: pagination contains the pagination options for listing environment classes title: pagination title: ListEnvironmentClassesRequest type: object gitpod.v1.ListEnvironmentClassesRequest.Filter: additionalProperties: false properties: canCreateEnvironments: description: "can_create_environments filters the response to only environment classes that can be used to create\ \ new environments\n by the caller. Unlike enabled, which indicates general availability, this ensures the caller\ \ only sees environment classes\n they are allowed to use." nullable: true title: can_create_environments type: boolean enabled: description: "enabled filters the response to only enabled or disabled environment classes.\n If not set, all environment\ \ classes are returned." nullable: true title: enabled type: boolean runnerIds: description: runner_ids filters the response to only EnvironmentClasses of these Runner IDs items: format: uuid maxItems: 25 type: string maxItems: 25 title: runner_ids type: array runnerKinds: description: runner_kind filters the response to only environment classes from runners of these kinds. items: $ref: '#/components/schemas/gitpod.v1.RunnerKind' maxItems: 25 title: runner_kinds type: array runnerProviders: description: runner_providers filters the response to only environment classes from runners of these providers. items: $ref: '#/components/schemas/gitpod.v1.RunnerProvider' maxItems: 25 title: runner_providers type: array title: Filter type: object gitpod.v1.ListEnvironmentClassesResponse: additionalProperties: false properties: environmentClasses: items: $ref: '#/components/schemas/gitpod.v1.EnvironmentClass' title: environment_classes type: array pagination: $ref: '#/components/schemas/gitpod.v1.PaginationResponse' description: pagination contains the pagination options for listing environment classes title: pagination title: ListEnvironmentClassesResponse type: object gitpod.v1.ListEnvironmentUsageRecordsRequest: additionalProperties: false properties: filter: $ref: '#/components/schemas/gitpod.v1.ListEnvironmentUsageRecordsRequest.Filter' description: Filter options. title: filter pagination: $ref: '#/components/schemas/gitpod.v1.PaginationRequest' description: Pagination options. title: pagination title: ListEnvironmentUsageRecordsRequest type: object gitpod.v1.ListEnvironmentUsageRecordsRequest.Filter: additionalProperties: false properties: dateRange: $ref: '#/components/schemas/gitpod.v1.DateRange' description: Date range to query runtime records within. title: date_range projectId: description: Optional project ID to filter runtime records by. title: project_id type: string required: - dateRange title: Filter type: object gitpod.v1.ListEnvironmentUsageRecordsResponse: additionalProperties: false properties: pagination: $ref: '#/components/schemas/gitpod.v1.PaginationResponse' description: Pagination response. title: pagination records: description: List of environment runtime records. items: $ref: '#/components/schemas/gitpod.v1.EnvironmentUsageRecord' title: records type: array title: ListEnvironmentUsageRecordsResponse type: object gitpod.v1.ListEnvironmentsRequest: additionalProperties: false properties: count: $ref: '#/components/schemas/gitpod.v1.CountRequest' description: count controls whether the response includes a bounded total count. title: count x-stainless-skip: true filter: $ref: '#/components/schemas/gitpod.v1.ListEnvironmentsRequest.Filter' title: filter pagination: $ref: '#/components/schemas/gitpod.v1.PaginationRequest' description: pagination contains the pagination options for listing environments title: pagination title: ListEnvironmentsRequest type: object gitpod.v1.ListEnvironmentsRequest.ArchivalStatus: enum: - ARCHIVAL_STATUS_UNSPECIFIED - ARCHIVAL_STATUS_ACTIVE - ARCHIVAL_STATUS_ARCHIVED - ARCHIVAL_STATUS_ALL title: ArchivalStatus type: string gitpod.v1.ListEnvironmentsRequest.Filter: additionalProperties: false properties: archivalStatus: $ref: '#/components/schemas/gitpod.v1.ListEnvironmentsRequest.ArchivalStatus' description: archival_status filters the response based on environment archive status nullable: true title: archival_status createdBefore: $ref: '#/components/schemas/google.protobuf.Timestamp' description: created_before filters environments created before this timestamp nullable: true title: created_before creatorIds: description: creator_ids filters the response to only Environments created by specified members items: format: uuid maxItems: 25 type: string maxItems: 25 title: creator_ids type: array lockdownBefore: $ref: '#/components/schemas/google.protobuf.Timestamp' description: "lockdown_before filters environments whose lockdown_at is before this timestamp.\n Only environments\ \ with lockdown_at set are matched." nullable: true title: lockdown_before x-stainless-skip: true projectIds: description: project_ids filters the response to only Environments associated with the specified projects items: format: uuid maxItems: 25 type: string maxItems: 25 title: project_ids type: array roles: description: roles filters the response to only Environments with the specified roles items: $ref: '#/components/schemas/gitpod.v1.EnvironmentRole' maxItems: 25 title: roles type: array runnerIds: description: runner_ids filters the response to only Environments running on these Runner IDs items: format: uuid maxItems: 25 type: string maxItems: 25 title: runner_ids type: array runnerKinds: description: runner_kinds filters the response to only Environments running on these Runner Kinds items: $ref: '#/components/schemas/gitpod.v1.RunnerKind' maxItems: 25 title: runner_kinds type: array search: description: search performs case-insensitive search across environment ID, name, repository URL, and branch maxLength: 256 title: search type: string x-stainless-skip: true sessionIds: description: session_ids filters the response to only environments belonging to the specified sessions items: format: uuid maxItems: 25 type: string maxItems: 25 title: session_ids type: array statusPhases: description: actual_phases is a list of phases the environment must be in for it to be returned in the API call items: $ref: '#/components/schemas/gitpod.v1.EnvironmentPhase' maxItems: 25 title: status_phases type: array title: Filter type: object gitpod.v1.ListEnvironmentsResponse: additionalProperties: false properties: count: $ref: '#/components/schemas/gitpod.v1.CountResponse' description: "count is the bounded total count of matching environments, present only\n when requested via CountRequest.include\ \ on the first page." title: count x-stainless-skip: true environments: description: environments are the environments that matched the query items: $ref: '#/components/schemas/gitpod.v1.Environment' title: environments type: array pagination: $ref: '#/components/schemas/gitpod.v1.PaginationResponse' description: pagination contains the pagination options for listing environments title: pagination title: ListEnvironmentsResponse type: object gitpod.v1.ListGatewaysRequest: additionalProperties: false properties: pagination: $ref: '#/components/schemas/gitpod.v1.PaginationRequest' description: pagination contains the pagination options for listing gateways title: pagination title: ListGatewaysRequest type: object gitpod.v1.ListGatewaysResponse: additionalProperties: false properties: gateways: description: gateways contains the list of gateways items: $ref: '#/components/schemas/gitpod.v1.Gateway' title: gateways type: array pagination: $ref: '#/components/schemas/gitpod.v1.PaginationResponse' description: pagination contains the pagination response title: pagination required: - gateways title: ListGatewaysResponse type: object gitpod.v1.ListGroupsRequest: additionalProperties: false properties: filter: $ref: '#/components/schemas/gitpod.v1.ListGroupsRequest.Filter' description: filter contains options for filtering the list of groups. title: filter pagination: $ref: '#/components/schemas/gitpod.v1.PaginationRequest' description: pagination contains the pagination options for listing groups title: pagination title: ListGroupsRequest type: object gitpod.v1.ListGroupsRequest.Filter: additionalProperties: false properties: directShare: description: "direct_share filters groups by their direct_share flag.\n When set, only groups matching this value\ \ are returned." nullable: true title: direct_share type: boolean groupIds: description: group_ids filters the response to only groups with the specified IDs items: format: uuid maxItems: 25 type: string maxItems: 25 title: group_ids type: array search: description: search performs case-insensitive search across group name, description, and ID maxLength: 256 title: search type: string systemManaged: description: "system_managed filters groups by their system_managed flag.\n When set, only groups matching this\ \ value are returned." nullable: true title: system_managed type: boolean title: Filter type: object gitpod.v1.ListGroupsResponse: additionalProperties: false properties: groups: items: $ref: '#/components/schemas/gitpod.v1.Group' title: groups type: array pagination: $ref: '#/components/schemas/gitpod.v1.PaginationResponse' title: pagination title: ListGroupsResponse type: object gitpod.v1.ListHostAuthenticationTokensRequest: additionalProperties: false properties: filter: $ref: '#/components/schemas/gitpod.v1.ListHostAuthenticationTokensRequest.Filter' title: filter pagination: $ref: '#/components/schemas/gitpod.v1.PaginationRequest' title: pagination title: ListHostAuthenticationTokensRequest type: object gitpod.v1.ListHostAuthenticationTokensRequest.Filter: additionalProperties: false properties: runnerId: format: uuid nullable: true title: runner_id type: string subjectId: description: Filter by subject (user or service account) format: uuid nullable: true title: subject_id type: string userId: deprecated: true description: 'Deprecated: Use principal_id instead' format: uuid nullable: true title: user_id type: string title: Filter type: object gitpod.v1.ListHostAuthenticationTokensResponse: additionalProperties: false properties: pagination: $ref: '#/components/schemas/gitpod.v1.PaginationResponse' title: pagination tokens: items: $ref: '#/components/schemas/gitpod.v1.HostAuthenticationToken' title: tokens type: array title: ListHostAuthenticationTokensResponse type: object gitpod.v1.ListIntegrationDefinitionsRequest: additionalProperties: false properties: pagination: $ref: '#/components/schemas/gitpod.v1.PaginationRequest' title: pagination title: ListIntegrationDefinitionsRequest type: object gitpod.v1.ListIntegrationDefinitionsResponse: additionalProperties: false properties: definitions: items: $ref: '#/components/schemas/gitpod.v1.IntegrationDefinition' title: definitions type: array pagination: $ref: '#/components/schemas/gitpod.v1.PaginationResponse' title: pagination required: - pagination title: ListIntegrationDefinitionsResponse type: object gitpod.v1.ListIntegrationsRequest: additionalProperties: false properties: pagination: $ref: '#/components/schemas/gitpod.v1.PaginationRequest' title: pagination title: ListIntegrationsRequest type: object gitpod.v1.ListIntegrationsResponse: additionalProperties: false properties: integrations: items: $ref: '#/components/schemas/gitpod.v1.Integration' title: integrations type: array pagination: $ref: '#/components/schemas/gitpod.v1.PaginationResponse' title: pagination required: - pagination title: ListIntegrationsResponse type: object gitpod.v1.ListJoinableOrganizationsRequest: additionalProperties: false properties: pagination: $ref: '#/components/schemas/gitpod.v1.PaginationRequest' description: pagination contains the pagination options for listing joinable organizations title: pagination title: ListJoinableOrganizationsRequest type: object gitpod.v1.ListJoinableOrganizationsResponse: additionalProperties: false properties: joinableOrganizations: items: $ref: '#/components/schemas/gitpod.v1.JoinableOrganization' title: joinable_organizations type: array pagination: $ref: '#/components/schemas/gitpod.v1.PaginationResponse' title: pagination required: - pagination title: ListJoinableOrganizationsResponse type: object gitpod.v1.ListLLMIntegrationsRequest: additionalProperties: false properties: filter: $ref: '#/components/schemas/gitpod.v1.ListLLMIntegrationsRequest.Filter' title: filter pagination: $ref: '#/components/schemas/gitpod.v1.PaginationRequest' description: pagination contains the pagination options for listing scm integrations title: pagination title: ListLLMIntegrationsRequest type: object gitpod.v1.ListLLMIntegrationsRequest.Filter: additionalProperties: false properties: runnerIds: description: runner_ids filters the response to only LLM integrations of these Runner IDs items: format: uuid maxItems: 25 type: string maxItems: 25 title: runner_ids type: array title: Filter type: object gitpod.v1.ListLLMIntegrationsResponse: additionalProperties: false properties: integrations: items: $ref: '#/components/schemas/gitpod.v1.LLMIntegration' title: integrations type: array llmManagedByOna: description: llm_managed_by_ona indicates if LLM integrations are managed by Ona Intelligence. title: llm_managed_by_ona type: boolean pagination: $ref: '#/components/schemas/gitpod.v1.PaginationResponse' description: pagination contains the pagination options for listing llm integrations title: pagination title: ListLLMIntegrationsResponse type: object gitpod.v1.ListLoginProvidersRequest: additionalProperties: false properties: filter: $ref: '#/components/schemas/gitpod.v1.ListLoginProvidersRequest.Filter' description: filter contains the filter options for listing login methods title: filter pagination: $ref: '#/components/schemas/gitpod.v1.PaginationRequest' description: pagination contains the pagination options for listing login methods title: pagination title: ListLoginProvidersRequest type: object gitpod.v1.ListLoginProvidersRequest.Filter: additionalProperties: false properties: email: description: email is the email address to filter SSO providers by nullable: true title: email type: string inviteId: description: invite_id is the ID of the invite URL the user wants to login with format: uuid nullable: true title: invite_id type: string title: Filter type: object gitpod.v1.ListLoginProvidersResponse: additionalProperties: false properties: allowCustom: description: allow_custom indicates whether custom SSO is allowed for this domain title: allow_custom type: boolean loginProviders: items: $ref: '#/components/schemas/gitpod.v1.LoginProvider' title: login_providers type: array pagination: $ref: '#/components/schemas/gitpod.v1.PaginationResponse' title: pagination required: - pagination title: ListLoginProvidersResponse type: object gitpod.v1.ListMCPIntegrationsRequest: additionalProperties: false properties: pagination: $ref: '#/components/schemas/gitpod.v1.PaginationRequest' title: pagination title: ListMCPIntegrationsRequest type: object gitpod.v1.ListMCPIntegrationsResponse: additionalProperties: false properties: mcpIntegrations: items: $ref: '#/components/schemas/gitpod.v1.MCPIntegration' title: mcp_integrations type: array pagination: $ref: '#/components/schemas/gitpod.v1.PaginationResponse' title: pagination title: ListMCPIntegrationsResponse type: object gitpod.v1.ListManagedRunnersRequest: additionalProperties: false properties: bigPagination: $ref: '#/components/schemas/gitpod.v1.BigPaginationRequest' description: pagination contains the pagination options for listing managed runners (allowing up to 10000 per page) title: big_pagination pagination: $ref: '#/components/schemas/gitpod.v1.PaginationRequest' deprecated: true description: pagination contains the pagination options for listing managed runners title: pagination title: ListManagedRunnersRequest type: object gitpod.v1.ListManagedRunnersResponse: additionalProperties: false properties: pagination: $ref: '#/components/schemas/gitpod.v1.PaginationResponse' description: pagination contains the pagination options for listing managed runners title: pagination runners: description: The managed runners items: $ref: '#/components/schemas/gitpod.v1.ManagedRunner' title: runners type: array title: ListManagedRunnersResponse type: object gitpod.v1.ListMembersRequest: additionalProperties: false properties: count: $ref: '#/components/schemas/gitpod.v1.CountRequest' description: count controls whether the response includes a bounded total count. title: count x-stainless-skip: true filter: $ref: '#/components/schemas/gitpod.v1.ListMembersRequest.Filter' title: filter organizationId: description: organization_id is the ID of the organization to list members for format: uuid title: organization_id type: string pagination: $ref: '#/components/schemas/gitpod.v1.PaginationRequest' description: pagination contains the pagination options for listing members title: pagination sort: $ref: '#/components/schemas/gitpod.v1.ListMembersRequest.Sort' description: "sort specifies the order of results. When unspecified, the authenticated user is\n returned first,\ \ followed by other members sorted by name ascending. When an explicit\n sort is specified, results are sorted\ \ purely by the requested field without any\n special handling for the authenticated user." title: sort required: - organizationId title: ListMembersRequest type: object gitpod.v1.ListMembersRequest.Filter: additionalProperties: false properties: excludeGroupIds: description: exclude_group_ids excludes members who are already in any of the specified groups items: format: uuid maxItems: 25 type: string maxItems: 25 title: exclude_group_ids type: array excludeMembersInAnyTeam: description: exclude_members_in_any_team excludes members who belong to any team in the organization title: exclude_members_in_any_team type: boolean roles: description: roles filters members by their organization role items: $ref: '#/components/schemas/gitpod.v1.OrganizationRole' title: roles type: array search: description: search performs case-insensitive search across member name and email maxLength: 256 title: search type: string statuses: description: status filters members by their user status items: $ref: '#/components/schemas/gitpod.v1.UserStatus' title: statuses type: array userIds: description: user_ids filters the response to only members with the specified user IDs items: format: uuid maxItems: 25 type: string maxItems: 25 title: user_ids type: array title: Filter type: object gitpod.v1.ListMembersRequest.Sort: additionalProperties: false properties: field: $ref: '#/components/schemas/gitpod.v1.ListMembersRequest.SortField' title: field order: $ref: '#/components/schemas/gitpod.v1.SortOrder' title: order title: Sort type: object gitpod.v1.ListMembersRequest.SortField: enum: - SORT_FIELD_UNSPECIFIED - SORT_FIELD_NAME - SORT_FIELD_DATE_JOINED title: SortField type: string gitpod.v1.ListMembersResponse: additionalProperties: false properties: count: $ref: '#/components/schemas/gitpod.v1.CountResponse' description: "count is the bounded total count of matching members, present only when\n requested via CountRequest.include\ \ on the first page." title: count x-stainless-skip: true members: description: members are the members of the organization items: $ref: '#/components/schemas/gitpod.v1.OrganizationMember' title: members type: array pagination: $ref: '#/components/schemas/gitpod.v1.PaginationResponse' description: pagination contains the pagination options for listing members title: pagination required: - pagination - members title: ListMembersResponse type: object gitpod.v1.ListMembershipsRequest: additionalProperties: false description: ListMemberships messages properties: filter: $ref: '#/components/schemas/gitpod.v1.ListMembershipsRequest.Filter' description: filter contains options for filtering the list of memberships. title: filter groupId: format: uuid title: group_id type: string pagination: $ref: '#/components/schemas/gitpod.v1.PaginationRequest' description: pagination contains the pagination options for listing memberships title: pagination title: ListMembershipsRequest type: object gitpod.v1.ListMembershipsRequest.Filter: additionalProperties: false properties: search: description: "search performs case-insensitive search across member name, email, ID,\n and service account name\ \ and description" maxLength: 256 title: search type: string title: Filter type: object gitpod.v1.ListMembershipsResponse: additionalProperties: false properties: members: items: $ref: '#/components/schemas/gitpod.v1.GroupMembership' title: members type: array pagination: $ref: '#/components/schemas/gitpod.v1.PaginationResponse' title: pagination title: ListMembershipsResponse type: object gitpod.v1.ListNotificationsRequest: additionalProperties: false properties: pagination: $ref: '#/components/schemas/gitpod.v1.PaginationRequest' title: pagination read: description: Filter by read status. If not set, returns all notifications. nullable: true title: read type: boolean types: description: Filter by notification types. If empty, returns all types. items: $ref: '#/components/schemas/gitpod.v1.NotificationType' maxItems: 20 title: types type: array title: ListNotificationsRequest type: object gitpod.v1.ListNotificationsResponse: additionalProperties: false properties: notifications: items: $ref: '#/components/schemas/gitpod.v1.Notification' title: notifications type: array pagination: $ref: '#/components/schemas/gitpod.v1.PaginationResponse' title: pagination totalCount: format: int32 title: total_count type: integer unreadCount: description: Counts for the inbox badge. Always returned regardless of filters. format: int32 title: unread_count type: integer title: ListNotificationsResponse type: object gitpod.v1.ListOrganizationLLMConfigurationsRequest: additionalProperties: false properties: empty: type: boolean title: ListOrganizationLLMConfigurationsRequest type: object gitpod.v1.ListOrganizationLLMConfigurationsResponse: additionalProperties: false properties: configurations: description: configurations is the list of organization LLM configurations items: $ref: '#/components/schemas/gitpod.v1.OrganizationLLMConfiguration' title: configurations type: array title: ListOrganizationLLMConfigurationsResponse type: object gitpod.v1.ListPersonalAccessTokensRequest: additionalProperties: false properties: filter: $ref: '#/components/schemas/gitpod.v1.ListPersonalAccessTokensRequest.Filter' title: filter pagination: $ref: '#/components/schemas/gitpod.v1.PaginationRequest' title: pagination title: ListPersonalAccessTokensRequest type: object gitpod.v1.ListPersonalAccessTokensRequest.Filter: additionalProperties: false properties: userIds: description: creator_ids filters the response to only Environments created by specified members items: format: uuid maxItems: 25 type: string maxItems: 25 title: user_ids type: array title: Filter type: object gitpod.v1.ListPersonalAccessTokensResponse: additionalProperties: false properties: pagination: $ref: '#/components/schemas/gitpod.v1.PaginationResponse' title: pagination personalAccessTokens: items: $ref: '#/components/schemas/gitpod.v1.PersonalAccessToken' title: personal_access_tokens type: array title: ListPersonalAccessTokensResponse type: object gitpod.v1.ListPrebuildsRequest: additionalProperties: false properties: filter: $ref: '#/components/schemas/gitpod.v1.ListPrebuildsRequest.Filter' description: filter contains the filter options for listing prebuilds title: filter pagination: $ref: '#/components/schemas/gitpod.v1.PaginationRequest' description: pagination contains the pagination options for listing prebuilds title: pagination title: ListPrebuildsRequest type: object gitpod.v1.ListPrebuildsRequest.Filter: additionalProperties: false properties: creatorIds: description: creator_ids filters prebuilds by who created them items: format: uuid maxItems: 25 type: string maxItems: 25 title: creator_ids type: array executorIds: description: executor_ids filters prebuilds by whose credentials were used to run them items: format: uuid maxItems: 25 type: string maxItems: 25 title: executor_ids type: array phases: description: phases filters prebuilds by their current phase items: $ref: '#/components/schemas/gitpod.v1.PrebuildPhase' maxItems: 10 title: phases type: array projectIds: description: project_ids filters prebuilds to specific projects items: format: uuid maxItems: 25 type: string maxItems: 25 title: project_ids type: array triggeredBy: description: triggered_by filters prebuilds by how they were triggered items: $ref: '#/components/schemas/gitpod.v1.PrebuildMetadata.PrebuildTrigger' maxItems: 5 title: triggered_by type: array title: Filter type: object gitpod.v1.ListPrebuildsResponse: additionalProperties: false properties: pagination: $ref: '#/components/schemas/gitpod.v1.PaginationResponse' description: pagination contains the pagination response title: pagination prebuilds: description: prebuilds are the prebuilds that matched the query items: $ref: '#/components/schemas/gitpod.v1.Prebuild' title: prebuilds type: array title: ListPrebuildsResponse type: object gitpod.v1.ListPreferencesRequest: additionalProperties: false properties: pagination: $ref: '#/components/schemas/gitpod.v1.PaginationRequest' title: pagination title: ListPreferencesRequest type: object gitpod.v1.ListPreferencesResponse: additionalProperties: false properties: pagination: $ref: '#/components/schemas/gitpod.v1.PaginationResponse' title: pagination preferences: items: $ref: '#/components/schemas/gitpod.v1.UserPreference' title: preferences type: array title: ListPreferencesResponse type: object gitpod.v1.ListProjectEnvironmentClassesRequest: additionalProperties: false description: ListProjectEnvironmentClassesRequest lists environment classes of a project. properties: pagination: $ref: '#/components/schemas/gitpod.v1.PaginationRequest' description: pagination contains the pagination options for listing project policies title: pagination projectId: description: project_id specifies the project identifier format: uuid title: project_id type: string title: ListProjectEnvironmentClassesRequest type: object gitpod.v1.ListProjectEnvironmentClassesResponse: additionalProperties: false properties: pagination: $ref: '#/components/schemas/gitpod.v1.PaginationResponse' title: pagination projectEnvironmentClasses: items: $ref: '#/components/schemas/gitpod.v1.ProjectEnvironmentClass' title: project_environment_classes type: array title: ListProjectEnvironmentClassesResponse type: object gitpod.v1.ListProjectPoliciesRequest: additionalProperties: false description: ListProjectPoliciesRequest lists policies for a project. properties: pagination: $ref: '#/components/schemas/gitpod.v1.PaginationRequest' description: pagination contains the pagination options for listing project policies title: pagination projectId: description: project_id specifies the project identifier format: uuid title: project_id type: string title: ListProjectPoliciesRequest type: object gitpod.v1.ListProjectPoliciesResponse: additionalProperties: false properties: pagination: $ref: '#/components/schemas/gitpod.v1.PaginationResponse' title: pagination policies: items: $ref: '#/components/schemas/gitpod.v1.ProjectPolicy' title: policies type: array title: ListProjectPoliciesResponse type: object gitpod.v1.ListProjectsRequest: additionalProperties: false properties: count: $ref: '#/components/schemas/gitpod.v1.CountRequest' description: count controls whether the response includes a bounded total count. title: count x-stainless-skip: true filter: $ref: '#/components/schemas/gitpod.v1.ListProjectsRequest.Filter' title: filter pagination: $ref: '#/components/schemas/gitpod.v1.PaginationRequest' description: pagination contains the pagination options for listing organizations title: pagination sort: $ref: '#/components/schemas/gitpod.v1.Sort' description: "sort specifies the order of results. Defaults to popularity descending.\n\n Supported fields:\n \ \ - \"id\": Sort by project ID (UUID v7, effectively creation order).\n Produces a stable, deterministic result\ \ set suitable for consistent pagination.\n - \"popularity\": Sort by popularity — a precomputed score based\ \ on recent\n environment creation activity. Updated periodically by a background job." title: sort title: ListProjectsRequest type: object gitpod.v1.ListProjectsRequest.Filter: additionalProperties: false properties: projectIds: description: project_ids filters the response to only projects with these IDs items: format: uuid maxItems: 25 type: string maxItems: 25 title: project_ids type: array runnerIds: description: runner_ids filters the response to only projects that use environment classes from these runners items: format: uuid maxItems: 25 type: string maxItems: 25 title: runner_ids type: array runnerKinds: description: runner_kinds filters the response to only projects that use environment classes from runners of these kinds items: $ref: '#/components/schemas/gitpod.v1.RunnerKind' maxItems: 25 title: runner_kinds type: array search: description: search performs case-insensitive search across project name, project ID, and repository name maxLength: 256 title: search type: string title: Filter type: object gitpod.v1.ListProjectsResponse: additionalProperties: false properties: count: $ref: '#/components/schemas/gitpod.v1.CountResponse' description: "count is the bounded total count of matching projects, present only when\n requested via CountRequest.include\ \ on the first page." title: count x-stainless-skip: true pagination: $ref: '#/components/schemas/gitpod.v1.PaginationResponse' description: pagination contains the pagination options for listing organizations title: pagination projects: items: $ref: '#/components/schemas/gitpod.v1.Project' title: projects type: array title: ListProjectsResponse type: object gitpod.v1.ListPromptsRequest: additionalProperties: false properties: filter: $ref: '#/components/schemas/gitpod.v1.ListPromptsRequest.Filter' title: filter pagination: $ref: '#/components/schemas/gitpod.v1.PaginationRequest' title: pagination title: ListPromptsRequest type: object gitpod.v1.ListPromptsRequest.Filter: additionalProperties: false properties: command: title: command type: string commandPrefix: maxLength: 50 title: command_prefix type: string excludePromptContent: description: "exclude_prompt_content omits the large spec.prompt text from the response.\n Other spec fields (is_template,\ \ is_command, command, is_skill) are still returned.\n Use GetPrompt to retrieve the full prompt content when\ \ needed." title: exclude_prompt_content type: boolean isCommand: title: is_command type: boolean isSkill: title: is_skill type: boolean isTemplate: title: is_template type: boolean search: description: search performs case-insensitive search across prompt name, description, and command. maxLength: 256 title: search type: string title: Filter type: object gitpod.v1.ListPromptsResponse: additionalProperties: false properties: pagination: $ref: '#/components/schemas/gitpod.v1.PaginationResponse' title: pagination prompts: items: $ref: '#/components/schemas/gitpod.v1.Prompt' title: prompts type: array title: ListPromptsResponse type: object gitpod.v1.ListRoleAssignmentsRequest: additionalProperties: false description: ListRoleAssignments messages properties: filter: $ref: '#/components/schemas/gitpod.v1.ListRoleAssignmentsRequest.Filter' description: Filter parameters title: filter pagination: $ref: '#/components/schemas/gitpod.v1.PaginationRequest' description: Pagination parameters title: pagination title: ListRoleAssignmentsRequest type: object gitpod.v1.ListRoleAssignmentsRequest.Filter: additionalProperties: false properties: groupId: description: "group_id filters the response to only role assignments for this specific group\n Empty string is allowed\ \ and means no filtering by group" title: group_id type: string resourceId: description: "Filters by a single resource. Non-admin callers with :grant permission\n on the resource can see role\ \ assignments from groups they don't belong to.\n Mutually exclusive with resource_ids." title: resource_id type: string resourceIds: description: "Filters by multiple resources in a single request. Non-admin callers with\n :grant permission on a\ \ resource can see all role assignments for that\n resource, even from groups they don't belong to. The :grant\ \ check is\n applied per-resource within the batch.\n Mutually exclusive with resource_id." items: format: uuid maxItems: 25 type: string maxItems: 25 title: resource_ids type: array resourceRoles: description: resource_roles filters the response to only role assignments with these specific roles items: $ref: '#/components/schemas/gitpod.v1.ResourceRole' title: resource_roles type: array resourceTypes: description: resource_types filters the response to only role assignments for these resource types items: $ref: '#/components/schemas/gitpod.v1.ResourceType' title: resource_types type: array userId: description: "user_id filters the response to only role assignments for groups that this user is a member of\n Empty\ \ string is allowed and means no filtering by user" title: user_id type: string title: Filter type: object gitpod.v1.ListRoleAssignmentsResponse: additionalProperties: false properties: assignments: items: $ref: '#/components/schemas/gitpod.v1.RoleAssignment' title: assignments type: array pagination: $ref: '#/components/schemas/gitpod.v1.PaginationResponse' title: pagination title: ListRoleAssignmentsResponse type: object gitpod.v1.ListRunnerAgentExecutionsRequest: additionalProperties: false properties: filter: $ref: '#/components/schemas/gitpod.v1.ListRunnerAgentExecutionsRequest.Filter' title: filter pagination: $ref: '#/components/schemas/gitpod.v1.PaginationRequest' description: pagination contains the pagination options for listing agent executions title: pagination runnerId: format: uuid title: runner_id type: string title: ListRunnerAgentExecutionsRequest type: object gitpod.v1.ListRunnerAgentExecutionsRequest.Filter: additionalProperties: false properties: activeOnly: description: "When true, only return agent executions that require processing.\n Excludes executions where phase\ \ is terminal (stopped/waiting_for_input)\n and spec.session matches status.session (no new user input)." title: active_only type: boolean agentExecutionIds: description: When set, only return agent executions matching these IDs. items: format: uuid maxItems: 500 type: string maxItems: 500 title: agent_execution_ids type: array idsOnly: description: "When true, return only execution IDs without full content\n (no spec, status, metadata, or access\ \ token)." title: ids_only type: boolean title: Filter type: object gitpod.v1.ListRunnerAgentExecutionsResponse: additionalProperties: false properties: agentExecutions: description: The agent ListRunnerAgentExecutionsRequest on the runner items: $ref: '#/components/schemas/gitpod.v1.RunnerAgentExecution' title: agent_executions type: array pagination: $ref: '#/components/schemas/gitpod.v1.PaginationResponse' description: pagination contains the pagination options for listing agent executions title: pagination title: ListRunnerAgentExecutionsResponse type: object gitpod.v1.ListRunnerEnvironmentClassesRequest: additionalProperties: false properties: filter: $ref: '#/components/schemas/gitpod.v1.ListRunnerEnvironmentClassesRequest.Filter' title: filter pagination: $ref: '#/components/schemas/gitpod.v1.PaginationRequest' description: pagination contains the pagination options for listing environment classes title: pagination runnerId: description: The runner's identity format: uuid title: runner_id type: string title: ListRunnerEnvironmentClassesRequest type: object gitpod.v1.ListRunnerEnvironmentClassesRequest.Filter: additionalProperties: false properties: environmentClassIds: description: environment_class_ids filters the response to only environment classes with these IDs items: format: uuid maxItems: 25 type: string maxItems: 25 title: environment_class_ids type: array title: Filter type: object gitpod.v1.ListRunnerEnvironmentClassesResponse: additionalProperties: false properties: environmentClasses: description: The environment classes configured for the runner items: $ref: '#/components/schemas/gitpod.v1.EnvironmentClass' title: environment_classes type: array pagination: $ref: '#/components/schemas/gitpod.v1.PaginationResponse' description: pagination contains the pagination options for listing environment classes title: pagination title: ListRunnerEnvironmentClassesResponse type: object gitpod.v1.ListRunnerEnvironmentSnapshotsRequest: additionalProperties: false properties: filter: $ref: '#/components/schemas/gitpod.v1.ListRunnerEnvironmentSnapshotsRequest.Filter' description: filter contains the filter options for listing snapshots title: filter pagination: $ref: '#/components/schemas/gitpod.v1.PaginationRequest' description: pagination contains the pagination options for listing snapshots title: pagination runnerId: description: The runner's identifier format: uuid title: runner_id type: string title: ListRunnerEnvironmentSnapshotsRequest type: object gitpod.v1.ListRunnerEnvironmentSnapshotsRequest.Filter: additionalProperties: false properties: snapshotIds: items: format: uuid maxItems: 25 type: string maxItems: 25 title: snapshot_ids type: array title: Filter type: object gitpod.v1.ListRunnerEnvironmentSnapshotsResponse: additionalProperties: false properties: pagination: $ref: '#/components/schemas/gitpod.v1.PaginationResponse' description: pagination contains the pagination response title: pagination snapshots: description: snapshots are the snapshots that matched the query items: $ref: '#/components/schemas/gitpod.v1.RunnerEnvironmentSnapshot' title: snapshots type: array title: ListRunnerEnvironmentSnapshotsResponse type: object gitpod.v1.ListRunnerEnvironmentsRequest: additionalProperties: false properties: environmentIds: description: "An optional list of environment IDs to fetch. If this list is empty/not provided\n all environments\ \ that ought to run on the runner are returned." items: format: uuid type: string title: environment_ids type: array pagination: $ref: '#/components/schemas/gitpod.v1.PaginationRequest' description: pagination contains the pagination options for listing environments title: pagination runnerId: description: The runner's identifier format: uuid title: runner_id type: string title: ListRunnerEnvironmentsRequest type: object gitpod.v1.ListRunnerEnvironmentsResponse: additionalProperties: false properties: environments: description: The environments running on the runner items: $ref: '#/components/schemas/gitpod.v1.RunnerEnvironment' title: environments type: array pagination: $ref: '#/components/schemas/gitpod.v1.PaginationResponse' description: pagination contains the pagination options for listing environments title: pagination title: ListRunnerEnvironmentsResponse type: object gitpod.v1.ListRunnerIntegrationsRequest: additionalProperties: false properties: filter: $ref: '#/components/schemas/gitpod.v1.ListRunnerIntegrationsRequest.Filter' title: filter pagination: $ref: '#/components/schemas/gitpod.v1.PaginationRequest' description: pagination contains the pagination options for listing integrations title: pagination runnerId: description: The runner's identity format: uuid title: runner_id type: string title: ListRunnerIntegrationsRequest type: object gitpod.v1.ListRunnerIntegrationsRequest.Filter: additionalProperties: false properties: integrationIds: description: integration_ids filters the response to only integrations with these IDs items: format: uuid maxItems: 25 type: string maxItems: 25 title: integration_ids type: array title: Filter type: object gitpod.v1.ListRunnerIntegrationsResponse: additionalProperties: false properties: integrations: description: The integrations configured for the runner items: $ref: '#/components/schemas/gitpod.v1.Integration' title: integrations type: array pagination: $ref: '#/components/schemas/gitpod.v1.PaginationResponse' description: pagination contains the pagination options for listing integrations title: pagination title: ListRunnerIntegrationsResponse type: object gitpod.v1.ListRunnerLLMIntegrationsRequest: additionalProperties: false properties: filter: $ref: '#/components/schemas/gitpod.v1.ListRunnerLLMIntegrationsRequest.Filter' title: filter pagination: $ref: '#/components/schemas/gitpod.v1.PaginationRequest' description: pagination contains the pagination options for listing LLM integrations title: pagination runnerId: description: The runner's identity format: uuid title: runner_id type: string title: ListRunnerLLMIntegrationsRequest type: object gitpod.v1.ListRunnerLLMIntegrationsRequest.Filter: additionalProperties: false properties: supportedModels: description: supported_models filters the response to only LLM integrations with these models items: $ref: '#/components/schemas/gitpod.v1.SupportedModel' maxItems: 25 title: supported_models type: array title: Filter type: object gitpod.v1.ListRunnerLLMIntegrationsResponse: additionalProperties: false properties: llmIntegrations: description: The LLM integrations configured for the runner items: $ref: '#/components/schemas/gitpod.v1.LLMIntegration' title: llm_integrations type: array pagination: $ref: '#/components/schemas/gitpod.v1.PaginationResponse' description: pagination contains the pagination options for listing LLM integrations title: pagination title: ListRunnerLLMIntegrationsResponse type: object gitpod.v1.ListRunnerManagersRequest: additionalProperties: false properties: pagination: $ref: '#/components/schemas/gitpod.v1.PaginationRequest' description: pagination contains the pagination options for listing runner managers title: pagination title: ListRunnerManagersRequest type: object gitpod.v1.ListRunnerManagersResponse: additionalProperties: false properties: pagination: $ref: '#/components/schemas/gitpod.v1.PaginationResponse' description: pagination contains the pagination options for listing runner managers title: pagination runnerManagers: description: The runner managers registered in the scope items: $ref: '#/components/schemas/gitpod.v1.RunnerManager' title: runner_managers type: array title: ListRunnerManagersResponse type: object gitpod.v1.ListRunnerPoliciesRequest: additionalProperties: false description: ListRunnerPoliciesRequest lists policies for a project. properties: pagination: $ref: '#/components/schemas/gitpod.v1.PaginationRequest' description: pagination contains the pagination options for listing project policies title: pagination runnerId: description: runner_id specifies the project identifier format: uuid title: runner_id type: string title: ListRunnerPoliciesRequest type: object gitpod.v1.ListRunnerPoliciesResponse: additionalProperties: false properties: pagination: $ref: '#/components/schemas/gitpod.v1.PaginationResponse' title: pagination policies: items: $ref: '#/components/schemas/gitpod.v1.RunnerPolicy' title: policies type: array title: ListRunnerPoliciesResponse type: object gitpod.v1.ListRunnerSCMIntegrationsRequest: additionalProperties: false properties: filter: $ref: '#/components/schemas/gitpod.v1.ListRunnerSCMIntegrationsRequest.Filter' title: filter pagination: $ref: '#/components/schemas/gitpod.v1.PaginationRequest' description: pagination contains the pagination options for listing SCM integrations title: pagination runnerId: description: The runner's identity format: uuid title: runner_id type: string title: ListRunnerSCMIntegrationsRequest type: object gitpod.v1.ListRunnerSCMIntegrationsRequest.Filter: additionalProperties: false properties: scmIntegrationIds: description: environment_class_ids filters the response to only SCM integrations with these IDs items: format: uuid maxItems: 25 type: string maxItems: 25 title: scm_integration_ids type: array title: Filter type: object gitpod.v1.ListRunnerSCMIntegrationsResponse: additionalProperties: false properties: pagination: $ref: '#/components/schemas/gitpod.v1.PaginationResponse' description: pagination contains the pagination options for listing SCM integrations title: pagination scmIntegrations: description: The SCM integrations configured for the runner items: $ref: '#/components/schemas/gitpod.v1.SCMIntegration' title: scm_integrations type: array title: ListRunnerSCMIntegrationsResponse type: object gitpod.v1.ListRunnerWarmPoolsRequest: additionalProperties: false properties: pagination: $ref: '#/components/schemas/gitpod.v1.PaginationRequest' description: pagination contains the pagination options for listing warm pools title: pagination runnerId: description: The runner's identity format: uuid title: runner_id type: string required: - runnerId title: ListRunnerWarmPoolsRequest type: object gitpod.v1.ListRunnerWarmPoolsResponse: additionalProperties: false properties: pagination: $ref: '#/components/schemas/gitpod.v1.PaginationResponse' description: pagination contains the pagination response title: pagination warmPools: items: $ref: '#/components/schemas/gitpod.v1.WarmPool' title: warm_pools type: array title: ListRunnerWarmPoolsResponse type: object gitpod.v1.ListRunnersRequest: additionalProperties: false properties: filter: $ref: '#/components/schemas/gitpod.v1.ListRunnersRequest.Filter' title: filter pagination: $ref: '#/components/schemas/gitpod.v1.PaginationRequest' description: pagination contains the pagination options for listing runners title: pagination title: ListRunnersRequest type: object gitpod.v1.ListRunnersRequest.Filter: additionalProperties: false properties: creatorIds: description: creator_ids filters the response to only runner created by specified users items: format: uuid maxItems: 25 type: string maxItems: 25 title: creator_ids type: array kinds: description: kinds filters the response to only runners of the specified kinds items: $ref: '#/components/schemas/gitpod.v1.RunnerKind' maxItems: 25 title: kinds type: array providers: description: providers filters the response to only runners of the specified providers items: $ref: '#/components/schemas/gitpod.v1.RunnerProvider' maxItems: 25 title: providers type: array title: Filter type: object gitpod.v1.ListRunnersResponse: additionalProperties: false properties: pagination: $ref: '#/components/schemas/gitpod.v1.PaginationResponse' description: pagination contains the pagination options for listing runners title: pagination runners: description: The runners registered in the scope items: $ref: '#/components/schemas/gitpod.v1.Runner' title: runners type: array title: ListRunnersResponse type: object gitpod.v1.ListSCIMConfigurationsRequest: additionalProperties: false properties: pagination: $ref: '#/components/schemas/gitpod.v1.PaginationRequest' title: pagination title: ListSCIMConfigurationsRequest type: object gitpod.v1.ListSCIMConfigurationsResponse: additionalProperties: false properties: pagination: $ref: '#/components/schemas/gitpod.v1.PaginationResponse' title: pagination scimConfigurations: description: scim_configurations are the SCIM configurations for the organization items: $ref: '#/components/schemas/gitpod.v1.SCIMConfiguration' title: scim_configurations type: array required: - pagination title: ListSCIMConfigurationsResponse type: object gitpod.v1.ListSCMIntegrationsRequest: additionalProperties: false properties: filter: $ref: '#/components/schemas/gitpod.v1.ListSCMIntegrationsRequest.Filter' title: filter pagination: $ref: '#/components/schemas/gitpod.v1.PaginationRequest' description: pagination contains the pagination options for listing scm integrations title: pagination title: ListSCMIntegrationsRequest type: object gitpod.v1.ListSCMIntegrationsRequest.Filter: additionalProperties: false properties: runnerIds: description: runner_ids filters the response to only SCM integrations of these Runner IDs items: format: uuid maxItems: 25 type: string maxItems: 25 title: runner_ids type: array title: Filter type: object gitpod.v1.ListSCMIntegrationsResponse: additionalProperties: false properties: integrations: items: $ref: '#/components/schemas/gitpod.v1.SCMIntegration' title: integrations type: array pagination: $ref: '#/components/schemas/gitpod.v1.PaginationResponse' description: pagination contains the pagination options for listing scm integrations title: pagination title: ListSCMIntegrationsResponse type: object gitpod.v1.ListSCMOrganizationsRequest: additionalProperties: false properties: runnerId: format: uuid title: runner_id type: string scmHost: description: The SCM host to list organizations from (e.g., "github.com", "gitlab.com") minLength: 1 title: scm_host type: string title: ListSCMOrganizationsRequest type: object gitpod.v1.ListSCMOrganizationsResponse: additionalProperties: false properties: organizations: description: List of organizations the user belongs to items: $ref: '#/components/schemas/gitpod.v1.ListSCMOrganizationsResponse.SCMOrganization' title: organizations type: array title: ListSCMOrganizationsResponse type: object gitpod.v1.ListSCMOrganizationsResponse.SCMOrganization: additionalProperties: false properties: isAdmin: description: "Whether the user has admin permissions in this organization.\n Admin permissions typically allow creating\ \ organization-level webhooks." title: is_admin type: boolean name: description: Organization name/slug (e.g., "gitpod-io") title: name type: string url: description: Organization URL (e.g., "https://github.com/gitpod-io") title: url type: string title: SCMOrganization type: object gitpod.v1.ListSSOConfigurationsRequest: additionalProperties: false properties: organizationId: description: organization_id is the ID of the organization to list SSO configurations for. format: uuid title: organization_id type: string pagination: $ref: '#/components/schemas/gitpod.v1.PaginationRequest' title: pagination required: - organizationId title: ListSSOConfigurationsRequest type: object gitpod.v1.ListSSOConfigurationsResponse: additionalProperties: false properties: pagination: $ref: '#/components/schemas/gitpod.v1.PaginationResponse' title: pagination ssoConfigurations: description: sso_configurations are the SSO configurations for the organization items: $ref: '#/components/schemas/gitpod.v1.SSOConfiguration' title: sso_configurations type: array required: - pagination title: ListSSOConfigurationsResponse type: object gitpod.v1.ListSSOLoginsRequest: additionalProperties: false properties: email: description: email is the email the user wants to login with format: email title: email type: string pagination: $ref: '#/components/schemas/gitpod.v1.PaginationRequest' description: pagination contains the pagination options for listing SSO logins title: pagination returnTo: description: return_to is the URL the user will be redirected to after login format: uri nullable: true title: return_to type: string required: - email title: ListSSOLoginsRequest type: object gitpod.v1.ListSSOLoginsResponse: additionalProperties: false properties: logins: items: $ref: '#/components/schemas/gitpod.v1.ListSSOLoginsResponse.Login' title: logins type: array pagination: $ref: '#/components/schemas/gitpod.v1.PaginationResponse' title: pagination required: - pagination title: ListSSOLoginsResponse type: object gitpod.v1.ListSSOLoginsResponse.Login: additionalProperties: false properties: displayName: description: provider is the provider used by this login method, e.g. "github", "google", "custom" title: display_name type: string loginUrl: description: login_url is the URL to redirect the user to for SSO login title: login_url type: string required: - displayName - loginUrl title: Login type: object gitpod.v1.ListSecretsRequest: additionalProperties: false properties: filter: $ref: '#/components/schemas/gitpod.v1.ListSecretsRequest.Filter' title: filter pagination: $ref: '#/components/schemas/gitpod.v1.PaginationRequest' description: pagination contains the pagination options for listing environments title: pagination title: ListSecretsRequest type: object gitpod.v1.ListSecretsRequest.Filter: additionalProperties: false properties: projectIds: deprecated: true description: "project_ids filters the response to only Secrets used by these Project IDs\n Deprecated: use scope\ \ instead. Values in project_ids will be ignored." items: deprecated: true format: uuid maxItems: 25 type: string maxItems: 25 title: project_ids type: array scope: $ref: '#/components/schemas/gitpod.v1.SecretScope' description: scope is the scope of the secrets to list title: scope title: Filter type: object gitpod.v1.ListSecretsResponse: additionalProperties: false properties: pagination: $ref: '#/components/schemas/gitpod.v1.PaginationResponse' description: pagination contains the pagination options for listing secrets title: pagination secrets: items: $ref: '#/components/schemas/gitpod.v1.Secret' title: secrets type: array title: ListSecretsResponse type: object gitpod.v1.ListServiceAccountTokensRequest: additionalProperties: false properties: pagination: $ref: '#/components/schemas/gitpod.v1.PaginationRequest' title: pagination title: ListServiceAccountTokensRequest type: object gitpod.v1.ListServiceAccountTokensResponse: additionalProperties: false properties: pagination: $ref: '#/components/schemas/gitpod.v1.PaginationResponse' title: pagination tokens: items: $ref: '#/components/schemas/gitpod.v1.ServiceAccountToken' title: tokens type: array title: ListServiceAccountTokensResponse type: object gitpod.v1.ListServiceAccountsRequest: additionalProperties: false properties: filter: $ref: '#/components/schemas/gitpod.v1.ListServiceAccountsRequest.Filter' description: filter contains options for filtering the list of service accounts. title: filter pagination: $ref: '#/components/schemas/gitpod.v1.PaginationRequest' title: pagination title: ListServiceAccountsRequest type: object gitpod.v1.ListServiceAccountsRequest.Filter: additionalProperties: false properties: includeSuspended: description: "include_suspended includes suspended (soft-deleted) service accounts in the response.\n By default,\ \ suspended service accounts are excluded." title: include_suspended type: boolean search: description: search performs case-insensitive search across service account name, description, and ID maxLength: 256 title: search type: string serviceAccountIds: description: service_account_ids filters the response to only service accounts with the specified IDs items: format: uuid maxItems: 25 type: string maxItems: 25 title: service_account_ids type: array title: Filter type: object gitpod.v1.ListServiceAccountsResponse: additionalProperties: false properties: pagination: $ref: '#/components/schemas/gitpod.v1.PaginationResponse' title: pagination serviceAccounts: items: $ref: '#/components/schemas/gitpod.v1.ServiceAccount' title: service_accounts type: array title: ListServiceAccountsResponse type: object gitpod.v1.ListServicesRequest: additionalProperties: false properties: filter: $ref: '#/components/schemas/gitpod.v1.ListServicesRequest.Filter' description: filter contains the filter options for listing services title: filter pagination: $ref: '#/components/schemas/gitpod.v1.PaginationRequest' description: pagination contains the pagination options for listing services title: pagination title: ListServicesRequest type: object gitpod.v1.ListServicesRequest.Filter: additionalProperties: false properties: environmentIds: description: environment_ids filters the response to only services of these environments items: format: uuid maxItems: 25 type: string maxItems: 25 title: environment_ids type: array references: description: references filters the response to only services with these references items: maxItems: 25 minLength: 1 type: string maxItems: 25 title: references type: array roles: description: roles filters the response to only services with these roles items: $ref: '#/components/schemas/gitpod.v1.ServiceRole' maxItems: 25 title: roles type: array serviceIds: description: service_ids filters the response to only services with these IDs items: format: uuid maxItems: 25 type: string maxItems: 25 title: service_ids type: array title: Filter type: object gitpod.v1.ListServicesResponse: additionalProperties: false properties: pagination: $ref: '#/components/schemas/gitpod.v1.PaginationResponse' title: pagination services: items: $ref: '#/components/schemas/gitpod.v1.Service' title: services type: array title: ListServicesResponse type: object gitpod.v1.ListSessionResourcesRequest: additionalProperties: false properties: kind: $ref: '#/components/schemas/gitpod.v1.SessionResourceKind' nullable: true title: kind pagination: $ref: '#/components/schemas/gitpod.v1.PaginationRequest' title: pagination sessionId: format: uuid title: session_id type: string title: ListSessionResourcesRequest type: object gitpod.v1.ListSessionResourcesResponse: additionalProperties: false properties: pagination: $ref: '#/components/schemas/gitpod.v1.PaginationResponse' title: pagination resources: items: $ref: '#/components/schemas/gitpod.v1.SessionResource' title: resources type: array title: ListSessionResourcesResponse type: object gitpod.v1.ListSessionsRequest: additionalProperties: false properties: pagination: $ref: '#/components/schemas/gitpod.v1.PaginationRequest' title: pagination phase: $ref: '#/components/schemas/gitpod.v1.SessionPhase' nullable: true title: phase title: ListSessionsRequest type: object gitpod.v1.ListSessionsResponse: additionalProperties: false properties: pagination: $ref: '#/components/schemas/gitpod.v1.PaginationResponse' title: pagination sessions: items: $ref: '#/components/schemas/gitpod.v1.Session' title: sessions type: array title: ListSessionsResponse type: object gitpod.v1.ListSubscriptionsRequest: additionalProperties: false properties: organizationId: description: organization_id is the ID of the organization to list subscriptions for format: uuid title: organization_id type: string required: - organizationId title: ListSubscriptionsRequest type: object gitpod.v1.ListSubscriptionsResponse: additionalProperties: false properties: subscriptions: description: subscriptions is the list of subscriptions for the organization items: $ref: '#/components/schemas/gitpod.v1.Subscription' title: subscriptions type: array title: ListSubscriptionsResponse type: object gitpod.v1.ListTaskExecutionsRequest: additionalProperties: false properties: filter: $ref: '#/components/schemas/gitpod.v1.ListTaskExecutionsRequest.Filter' description: filter contains the filter options for listing task runs title: filter pagination: $ref: '#/components/schemas/gitpod.v1.PaginationRequest' description: pagination contains the pagination options for listing task runs title: pagination title: ListTaskExecutionsRequest type: object gitpod.v1.ListTaskExecutionsRequest.Filter: additionalProperties: false properties: environmentIds: description: environment_ids filters the response to only task runs of these environments items: format: uuid maxItems: 25 type: string maxItems: 25 title: environment_ids type: array phases: description: phases filters the response to only task runs in these phases items: $ref: '#/components/schemas/gitpod.v1.TaskExecutionPhase' maxItems: 25 title: phases type: array taskIds: description: task_ids filters the response to only task runs of these tasks items: format: uuid maxItems: 25 type: string maxItems: 25 title: task_ids type: array taskReferences: description: task_references filters the response to only task runs with this reference items: maxItems: 25 type: string maxItems: 25 title: task_references type: array title: Filter type: object gitpod.v1.ListTaskExecutionsResponse: additionalProperties: false properties: pagination: $ref: '#/components/schemas/gitpod.v1.PaginationResponse' title: pagination taskExecutions: items: $ref: '#/components/schemas/gitpod.v1.TaskExecution' title: task_executions type: array title: ListTaskExecutionsResponse type: object gitpod.v1.ListTasksRequest: additionalProperties: false properties: filter: $ref: '#/components/schemas/gitpod.v1.ListTasksRequest.Filter' description: filter contains the filter options for listing tasks title: filter pagination: $ref: '#/components/schemas/gitpod.v1.PaginationRequest' description: pagination contains the pagination options for listing tasks title: pagination title: ListTasksRequest type: object gitpod.v1.ListTasksRequest.Filter: additionalProperties: false properties: environmentIds: description: environment_ids filters the response to only tasks of these environments items: format: uuid maxItems: 25 type: string maxItems: 25 title: environment_ids type: array references: description: references filters the response to only services with these references items: maxItems: 25 minLength: 1 type: string maxItems: 25 title: references type: array taskIds: description: task_ids filters the response to only tasks with these IDs items: format: uuid maxItems: 25 type: string maxItems: 25 title: task_ids type: array title: Filter type: object gitpod.v1.ListTasksResponse: additionalProperties: false properties: pagination: $ref: '#/components/schemas/gitpod.v1.PaginationResponse' title: pagination tasks: items: $ref: '#/components/schemas/gitpod.v1.Task' title: tasks type: array title: ListTasksResponse type: object gitpod.v1.ListTeamMembersRequest: additionalProperties: false properties: count: $ref: '#/components/schemas/gitpod.v1.CountRequest' description: count controls whether the response includes a bounded total count. title: count pagination: $ref: '#/components/schemas/gitpod.v1.PaginationRequest' title: pagination teamId: format: uuid title: team_id type: string title: ListTeamMembersRequest type: object gitpod.v1.ListTeamMembersResponse: additionalProperties: false properties: count: $ref: '#/components/schemas/gitpod.v1.CountResponse' description: "count is the bounded total count of matching team members, present only when\n requested via CountRequest.include\ \ on the first page." title: count members: items: $ref: '#/components/schemas/gitpod.v1.TeamMember' title: members type: array pagination: $ref: '#/components/schemas/gitpod.v1.PaginationResponse' title: pagination title: ListTeamMembersResponse type: object gitpod.v1.ListTeamsRequest: additionalProperties: false properties: filter: $ref: '#/components/schemas/gitpod.v1.ListTeamsRequest.Filter' description: filter contains options for filtering the list of teams. title: filter pagination: $ref: '#/components/schemas/gitpod.v1.PaginationRequest' title: pagination title: ListTeamsRequest type: object gitpod.v1.ListTeamsRequest.Filter: additionalProperties: false properties: search: description: search filters teams by name (case-insensitive substring match). maxLength: 256 title: search type: string title: Filter type: object gitpod.v1.ListTeamsResponse: additionalProperties: false properties: pagination: $ref: '#/components/schemas/gitpod.v1.PaginationResponse' title: pagination teams: items: $ref: '#/components/schemas/gitpod.v1.Team' title: teams type: array title: ListTeamsResponse type: object gitpod.v1.ListWarmPoolsRequest: additionalProperties: false properties: filter: $ref: '#/components/schemas/gitpod.v1.ListWarmPoolsRequest.Filter' description: filter contains the filter options for listing warm pools title: filter pagination: $ref: '#/components/schemas/gitpod.v1.PaginationRequest' description: pagination contains the pagination options for listing warm pools title: pagination title: ListWarmPoolsRequest type: object gitpod.v1.ListWarmPoolsRequest.Filter: additionalProperties: false properties: environmentClassIds: description: environment_class_ids filters warm pools to specific environment classes items: format: uuid maxItems: 25 type: string maxItems: 25 title: environment_class_ids type: array projectIds: description: project_ids filters warm pools to specific projects items: format: uuid maxItems: 25 type: string maxItems: 25 title: project_ids type: array title: Filter type: object gitpod.v1.ListWarmPoolsResponse: additionalProperties: false properties: pagination: $ref: '#/components/schemas/gitpod.v1.PaginationResponse' description: pagination contains the pagination response title: pagination warmPools: description: warm_pools are the warm pools that matched the query items: $ref: '#/components/schemas/gitpod.v1.WarmPool' title: warm_pools type: array title: ListWarmPoolsResponse type: object gitpod.v1.ListWebhookWorkflowsRequest: additionalProperties: false description: ListWebhookWorkflowsRequest lists workflows bound to a webhook. properties: pagination: $ref: '#/components/schemas/gitpod.v1.PaginationRequest' title: pagination webhookId: format: uuid title: webhook_id type: string title: ListWebhookWorkflowsRequest type: object gitpod.v1.ListWebhookWorkflowsResponse: additionalProperties: false properties: pagination: $ref: '#/components/schemas/gitpod.v1.PaginationResponse' title: pagination workflows: items: $ref: '#/components/schemas/gitpod.v1.Workflow' title: workflows type: array title: ListWebhookWorkflowsResponse type: object gitpod.v1.ListWebhooksRequest: additionalProperties: false description: ListWebhooksRequest lists webhooks with optional filtering. properties: filter: $ref: '#/components/schemas/gitpod.v1.ListWebhooksRequest.Filter' title: filter pagination: $ref: '#/components/schemas/gitpod.v1.PaginationRequest' title: pagination title: ListWebhooksRequest type: object gitpod.v1.ListWebhooksRequest.Filter: additionalProperties: false properties: providers: description: providers filters by webhook provider items: $ref: '#/components/schemas/gitpod.v1.WebhookProvider' maxItems: 5 title: providers type: array types: description: types filters by webhook type items: $ref: '#/components/schemas/gitpod.v1.WebhookType' maxItems: 5 title: types type: array webhookIds: description: webhook_ids filters by specific webhook IDs items: format: uuid maxItems: 25 type: string maxItems: 25 title: webhook_ids type: array title: Filter type: object gitpod.v1.ListWebhooksResponse: additionalProperties: false properties: pagination: $ref: '#/components/schemas/gitpod.v1.PaginationResponse' title: pagination webhooks: items: $ref: '#/components/schemas/gitpod.v1.Webhook' title: webhooks type: array title: ListWebhooksResponse 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.ListWorkflowExecutionActionsRequest.Filter: additionalProperties: false properties: phases: items: $ref: '#/components/schemas/gitpod.v1.WorkflowExecutionActionPhase' maxItems: 10 title: phases type: array workflowExecutionActionIds: items: format: uuid maxItems: 25 type: string maxItems: 25 title: workflow_execution_action_ids type: array workflowExecutionIds: items: format: uuid maxItems: 25 type: string maxItems: 25 title: workflow_execution_ids type: array workflowIds: items: format: uuid maxItems: 25 type: string maxItems: 25 title: workflow_ids type: array title: Filter type: object gitpod.v1.ListWorkflowExecutionActionsResponse: additionalProperties: false properties: pagination: $ref: '#/components/schemas/gitpod.v1.PaginationResponse' title: pagination workflowExecutionActions: items: $ref: '#/components/schemas/gitpod.v1.WorkflowExecutionAction' title: workflow_execution_actions type: array title: ListWorkflowExecutionActionsResponse type: object gitpod.v1.ListWorkflowExecutionOutputsRequest: additionalProperties: false properties: filter: $ref: '#/components/schemas/gitpod.v1.ListWorkflowExecutionOutputsRequest.Filter' title: filter pagination: $ref: '#/components/schemas/gitpod.v1.PaginationRequest' title: pagination title: ListWorkflowExecutionOutputsRequest type: object gitpod.v1.ListWorkflowExecutionOutputsRequest.Filter: additionalProperties: false properties: workflowExecutionIds: items: format: uuid maxItems: 25 type: string maxItems: 25 title: workflow_execution_ids type: array title: Filter type: object gitpod.v1.ListWorkflowExecutionOutputsResponse: additionalProperties: false properties: outputs: items: $ref: '#/components/schemas/gitpod.v1.ListWorkflowExecutionOutputsResponse.ActionOutput' title: outputs type: array pagination: $ref: '#/components/schemas/gitpod.v1.PaginationResponse' title: pagination title: ListWorkflowExecutionOutputsResponse type: object gitpod.v1.ListWorkflowExecutionOutputsResponse.ActionOutput: additionalProperties: false properties: actionId: title: action_id type: string values: additionalProperties: $ref: '#/components/schemas/gitpod.v1.AgentExecution.Status.OutputValue' title: value title: values type: object title: ActionOutput type: object gitpod.v1.ListWorkflowExecutionOutputsResponse.ActionOutput.ValuesEntry: additionalProperties: false properties: key: title: key type: string value: $ref: '#/components/schemas/gitpod.v1.AgentExecution.Status.OutputValue' title: value title: ValuesEntry type: object gitpod.v1.ListWorkflowExecutionsRequest: additionalProperties: false description: ListWorkflowExecutionsRequest lists workflow executions with optional filtering. properties: filter: $ref: '#/components/schemas/gitpod.v1.ListWorkflowExecutionsRequest.Filter' title: filter pagination: $ref: '#/components/schemas/gitpod.v1.PaginationRequest' title: pagination sort: $ref: '#/components/schemas/gitpod.v1.Sort' description: "sort specifies the order of results. When unspecified, results are sorted by\n operational priority\ \ (running first, then failed, then completed, then others).\n Supported sort fields: startedAt, finishedAt, createdAt." title: sort title: ListWorkflowExecutionsRequest type: object gitpod.v1.ListWorkflowExecutionsRequest.Filter: additionalProperties: false properties: hasFailedActions: nullable: true title: has_failed_actions type: boolean search: description: search performs case-insensitive search across workflow execution ID and trigger type maxLength: 256 title: search type: string statusPhases: items: $ref: '#/components/schemas/gitpod.v1.WorkflowExecutionPhase' maxItems: 10 title: status_phases type: array workflowExecutionIds: items: format: uuid maxItems: 25 type: string maxItems: 25 title: workflow_execution_ids type: array workflowIds: items: format: uuid maxItems: 25 type: string maxItems: 25 title: workflow_ids type: array title: Filter type: object gitpod.v1.ListWorkflowExecutionsResponse: additionalProperties: false properties: pagination: $ref: '#/components/schemas/gitpod.v1.PaginationResponse' title: pagination workflowExecutions: items: $ref: '#/components/schemas/gitpod.v1.WorkflowExecution' title: workflow_executions type: array title: ListWorkflowExecutionsResponse type: object gitpod.v1.ListWorkflowsRequest: additionalProperties: false description: ListWorkflowsRequest lists workflows with optional filtering. properties: count: $ref: '#/components/schemas/gitpod.v1.CountRequest' description: count controls whether the response includes a bounded total count. title: count x-stainless-skip: true filter: $ref: '#/components/schemas/gitpod.v1.ListWorkflowsRequest.Filter' title: filter pagination: $ref: '#/components/schemas/gitpod.v1.PaginationRequest' title: pagination sort: $ref: '#/components/schemas/gitpod.v1.ListWorkflowsRequest.Sort' description: "sort specifies the order of results. When unspecified, results are sorted\n alphabetically by name\ \ ascending." title: sort title: ListWorkflowsRequest type: object gitpod.v1.ListWorkflowsRequest.Filter: additionalProperties: false properties: creatorIds: description: creator_ids filters workflows by creator user IDs items: format: uuid maxItems: 25 type: string maxItems: 25 title: creator_ids type: array disabled: description: "disabled filters workflows by their disabled state.\n When set to true, only disabled workflows are\ \ returned.\n When set to false, only enabled workflows are returned.\n When unset, all workflows are returned\ \ regardless of disabled state." nullable: true title: disabled type: boolean x-stainless-skip: true hasFailedExecutionSince: $ref: '#/components/schemas/google.protobuf.Timestamp' description: "has_failed_execution_since filters workflows that have at least one failed execution\n with create_time\ \ >= the specified timestamp. A failed execution is one that is COMPLETED\n with failed_action_count > 0, or STOPPED\ \ with failed_action_count > 0 or a non-empty\n failure_message. This filter is mutually exclusive with status_phases." title: has_failed_execution_since search: description: search performs case-insensitive search across workflow name, description, and ID maxLength: 256 title: search type: string statusPhases: description: "status_phases filters workflows by the phase of their latest execution.\n Only workflows whose most\ \ recent execution matches one of the specified phases are returned." items: $ref: '#/components/schemas/gitpod.v1.WorkflowExecutionPhase' maxItems: 10 title: status_phases type: array workflowIds: items: format: uuid maxItems: 25 type: string maxItems: 25 title: workflow_ids type: array title: Filter type: object gitpod.v1.ListWorkflowsRequest.Sort: additionalProperties: false properties: field: $ref: '#/components/schemas/gitpod.v1.ListWorkflowsRequest.SortField' title: field order: $ref: '#/components/schemas/gitpod.v1.SortOrder' title: order title: Sort type: object gitpod.v1.ListWorkflowsRequest.SortField: enum: - SORT_FIELD_UNSPECIFIED - SORT_FIELD_NAME - SORT_FIELD_RECENTLY_COMPLETED title: SortField type: string gitpod.v1.ListWorkflowsResponse: additionalProperties: false properties: count: $ref: '#/components/schemas/gitpod.v1.CountResponse' description: "count is the bounded total count of matching workflows, present only when\n requested via CountRequest.include\ \ on the first page." title: count x-stainless-skip: true pagination: $ref: '#/components/schemas/gitpod.v1.PaginationResponse' title: pagination workflows: items: $ref: '#/components/schemas/gitpod.v1.Workflow' title: workflows type: array title: ListWorkflowsResponse type: object gitpod.v1.LogLevel: enum: - LOG_LEVEL_UNSPECIFIED - LOG_LEVEL_DEBUG - LOG_LEVEL_INFO - LOG_LEVEL_WARN - LOG_LEVEL_ERROR title: LogLevel type: string gitpod.v1.LogSectionOutcome: enum: - LOG_SECTION_OUTCOME_UNSPECIFIED - LOG_SECTION_OUTCOME_SUCCESS - LOG_SECTION_OUTCOME_FAILURE - LOG_SECTION_OUTCOME_CANCELLED title: LogSectionOutcome type: string gitpod.v1.LoginProvider: additionalProperties: false properties: loginUrl: description: login_url is the URL to redirect the browser agent to for login, when provider is "custom" title: login_url type: string provider: description: provider is the provider used by this login method, e.g. "github", "google", "custom" title: provider type: string required: - provider title: LoginProvider type: object gitpod.v1.MCPIntegration: additionalProperties: false properties: id: title: id type: string name: title: name type: string url: title: url type: string title: MCPIntegration type: object gitpod.v1.MCPIntegrationPhase: description: MCPIntegrationPhase represents the status of an MCP integration connection enum: - MCP_INTEGRATION_PHASE_UNSPECIFIED - MCP_INTEGRATION_PHASE_INITIALIZING - MCP_INTEGRATION_PHASE_READY - MCP_INTEGRATION_PHASE_FAILED - MCP_INTEGRATION_PHASE_UNAVAILABLE title: MCPIntegrationPhase type: string gitpod.v1.ManagedRunner: additionalProperties: false properties: organizationId: description: The organization's ID that this runner is assigned to format: uuid title: organization_id type: string runnerId: description: The runner's ID format: uuid title: runner_id type: string title: ManagedRunner type: object gitpod.v1.MarkEnvironmentActiveRequest: additionalProperties: false properties: activitySignal: $ref: '#/components/schemas/gitpod.v1.EnvironmentActivitySignal' description: activity_signal specifies the activity. title: activity_signal environmentId: description: The ID of the environment to update activity for. format: uuid title: environment_id type: string title: MarkEnvironmentActiveRequest type: object gitpod.v1.MarkEnvironmentActiveResponse: additionalProperties: false title: MarkEnvironmentActiveResponse type: object gitpod.v1.MarkNotificationsReadRequest: additionalProperties: false properties: notificationIds: items: format: uuid maxItems: 25 minItems: 1 type: string maxItems: 25 minItems: 1 title: notification_ids type: array title: MarkNotificationsReadRequest type: object gitpod.v1.MarkNotificationsReadResponse: additionalProperties: false title: MarkNotificationsReadResponse type: object gitpod.v1.MarkNotificationsUnreadRequest: additionalProperties: false properties: notificationIds: items: format: uuid maxItems: 25 minItems: 1 type: string maxItems: 25 minItems: 1 title: notification_ids type: array title: MarkNotificationsUnreadRequest type: object gitpod.v1.MarkNotificationsUnreadResponse: additionalProperties: false title: MarkNotificationsUnreadResponse type: object gitpod.v1.MarkRunnerActiveRequest: additionalProperties: false properties: runnerId: description: The runner's identity format: uuid title: runner_id type: string title: MarkRunnerActiveRequest type: object gitpod.v1.MarkRunnerActiveResponse: additionalProperties: false title: MarkRunnerActiveResponse type: object gitpod.v1.MetricConsumptionTimeSeries: additionalProperties: false description: Daily OCU consumption for a single metric category. properties: displayName: description: Human-readable label (e.g. "Environment Usage", "LLM Cache Reads", "Total"). title: display_name type: string kind: $ref: '#/components/schemas/gitpod.v1.MetricConsumptionTimeSeries.Kind' description: Category for grouping and filtering. title: kind series: description: Daily data points. items: $ref: '#/components/schemas/gitpod.v1.CreditUsageDataPoint' title: series type: array title: MetricConsumptionTimeSeries type: object gitpod.v1.MetricConsumptionTimeSeries.Kind: enum: - KIND_UNSPECIFIED - KIND_ALL - KIND_ENVIRONMENT - KIND_LLM title: Kind type: string gitpod.v1.MetricsConfiguration: additionalProperties: false properties: enabled: description: enabled indicates whether the runner should collect metrics title: enabled type: boolean managedMetricsEnabled: description: "When true, the runner pushes metrics to the management plane via\n ReportRunnerMetrics instead of\ \ directly to the remote_write endpoint." title: managed_metrics_enabled type: boolean password: description: password is the password to use for the metrics collector title: password type: string url: description: url is the URL of the metrics collector title: url type: string username: description: username is the username to use for the metrics collector title: username type: string title: MetricsConfiguration type: object gitpod.v1.NextStepsProposal: additionalProperties: false properties: actions: items: $ref: '#/components/schemas/gitpod.v1.NextStepsProposal.Action' maxItems: 4 minItems: 1 title: actions type: array title: NextStepsProposal type: object gitpod.v1.NextStepsProposal.Action: additionalProperties: false properties: prompt: minLength: 1 title: prompt type: string title: minLength: 1 title: title type: string variant: title: variant type: string title: Action type: object gitpod.v1.Notification: additionalProperties: false description: Notification represents an in-app notification for a user. properties: body: title: body type: string context: $ref: '#/components/schemas/gitpod.v1.NotificationContext' title: context createdAt: $ref: '#/components/schemas/google.protobuf.Timestamp' title: created_at id: format: uuid title: id type: string readAt: $ref: '#/components/schemas/google.protobuf.Timestamp' title: read_at title: title: title type: string type: $ref: '#/components/schemas/gitpod.v1.NotificationType' title: type updatedAt: $ref: '#/components/schemas/google.protobuf.Timestamp' title: updated_at userId: format: uuid title: user_id type: string required: - userId title: Notification type: object gitpod.v1.NotificationContext: additionalProperties: false description: "NotificationContext carries structured metadata for click-through navigation.\n Context is snapshotted\ \ at emit time so deleted resources still have display names." oneOf: - not: anyOf: - required: - environment - required: - project required: - agentExecution - not: anyOf: - required: - agentExecution - required: - project required: - environment - not: anyOf: - required: - agentExecution - required: - environment required: - project properties: agentExecution: $ref: '#/components/schemas/gitpod.v1.NotificationContext.AgentExecutionContext' title: agent_execution environment: $ref: '#/components/schemas/gitpod.v1.NotificationContext.EnvironmentContext' title: environment project: $ref: '#/components/schemas/gitpod.v1.NotificationContext.ProjectContext' title: project title: NotificationContext type: object gitpod.v1.NotificationContext.AgentExecutionContext: additionalProperties: false properties: agentExecutionId: title: agent_execution_id type: string agentExecutionName: title: agent_execution_name type: string environmentId: title: environment_id type: string title: AgentExecutionContext type: object gitpod.v1.NotificationContext.EnvironmentContext: additionalProperties: false properties: environmentId: title: environment_id type: string title: EnvironmentContext type: object gitpod.v1.NotificationContext.ProjectContext: additionalProperties: false properties: projectId: title: project_id type: string projectName: title: project_name type: string title: ProjectContext type: object gitpod.v1.NotificationType: enum: - NOTIFICATION_TYPE_UNSPECIFIED - NOTIFICATION_TYPE_AGENT_COMPLETED - NOTIFICATION_TYPE_AGENT_WAITING_FOR_INPUT - NOTIFICATION_TYPE_ENVIRONMENT_ARCHIVED - NOTIFICATION_TYPE_ENVIRONMENT_LIFETIME_EXCEEDED - NOTIFICATION_TYPE_GROUP_ADDED - NOTIFICATION_TYPE_GROUP_REMOVED - NOTIFICATION_TYPE_BILLING_CREDITS_LOW - NOTIFICATION_TYPE_BILLING_PAYMENT_FAILED - NOTIFICATION_TYPE_BILLING_ACCOUNT_SUSPENDED - NOTIFICATION_TYPE_AUTOMATION_COMPLETED - NOTIFICATION_TYPE_AUTOMATION_STOPPED - NOTIFICATION_TYPE_PREBUILD_FAILED title: NotificationType type: string gitpod.v1.OIDCConfig: additionalProperties: false description: "OIDCConfig represents the OIDC token configuration for an organization.\n The version oneof determines\ \ which token version is active." oneOf: - not: anyOf: - required: - v3 required: - v2 - not: anyOf: - required: - v2 required: - v3 properties: v2: $ref: '#/components/schemas/gitpod.v1.OIDCConfigV2' description: v2 selects V2 OIDC tokens (the default for new organizations). title: v2 v3: $ref: '#/components/schemas/gitpod.v1.OIDCConfigV3' description: v3 selects V3 OIDC tokens with richer claims and optional sub claim customization. title: v3 title: OIDCConfig type: object gitpod.v1.OIDCConfigV2: additionalProperties: false description: OIDCConfigV2 configures V2 OIDC tokens. No additional parameters. title: OIDCConfigV2 type: object gitpod.v1.OIDCConfigV3: additionalProperties: false description: OIDCConfigV3 configures V3 OIDC tokens with optional sub claim customization. properties: extraSubFields: description: "extra_sub_fields are additional property keys to include in the sub claim.\n Valid keys include: account_id,\ \ user_id, organization_id, project_id, runner_id,\n environment_id, creator_id, creator_principal, creator_email,\ \ creator_name,\n creator_idp, email, name, idp, runner_name, service_account_id, and\n dot-notation keys like\ \ creator_idp_claims.groups or idp_claims.department." items: maxItems: 50 minLength: 1 type: string uniqueItems: true maxItems: 50 title: extra_sub_fields type: array uniqueItems: true title: OIDCConfigV3 type: object gitpod.v1.Organization: additionalProperties: false properties: createdAt: $ref: '#/components/schemas/google.protobuf.Timestamp' title: created_at id: format: uuid title: id type: string inviteDomains: $ref: '#/components/schemas/gitpod.v1.InviteDomains' title: invite_domains name: title: name type: string tier: $ref: '#/components/schemas/gitpod.v1.OrganizationTier' description: The tier of the organization - free, enterprise or core title: tier updatedAt: $ref: '#/components/schemas/google.protobuf.Timestamp' title: updated_at required: - id - name - createdAt - updatedAt - tier title: Organization type: object gitpod.v1.OrganizationInvite: additionalProperties: false properties: inviteId: description: "invite_id is the unique identifier of the invite to join the organization.\n Use JoinOrganization\ \ with this ID to join the organization." format: uuid title: invite_id type: string required: - inviteId title: OrganizationInvite type: object gitpod.v1.OrganizationLLMConfiguration: additionalProperties: false description: "OrganizationLLMConfiguration contains metadata about an organization's LLM configuration.\n For security\ \ reasons, the actual API key is never returned." properties: createdAt: $ref: '#/components/schemas/google.protobuf.Timestamp' description: created_at is when the configuration was first created title: created_at organizationId: description: organization_id is the ID of the organization title: organization_id type: string provider: description: provider is the LLM provider (e.g., "anthropic") title: provider type: string updatedAt: $ref: '#/components/schemas/google.protobuf.Timestamp' description: updated_at is when the configuration was last updated title: updated_at title: OrganizationLLMConfiguration type: object gitpod.v1.OrganizationMember: additionalProperties: false properties: avatarUrl: title: avatar_url type: string email: title: email type: string fullName: title: full_name type: string loginProvider: description: login_provider is the login provider the user uses to sign in title: login_provider type: string memberSince: $ref: '#/components/schemas/google.protobuf.Timestamp' title: member_since role: $ref: '#/components/schemas/gitpod.v1.OrganizationRole' title: role status: $ref: '#/components/schemas/gitpod.v1.UserStatus' title: status userId: format: uuid title: user_id type: string required: - userId - role - memberSince - fullName - email - status - loginProvider title: OrganizationMember type: object gitpod.v1.OrganizationPolicies: additionalProperties: false properties: agentPolicy: $ref: '#/components/schemas/gitpod.v1.AgentPolicy' description: agent_policy contains agent-specific policy settings title: agent_policy allowLocalRunners: description: allow_local_runners controls whether local runners are allowed to be used in the organization title: allow_local_runners type: boolean allowedEditorIds: description: allowed_editor_ids is the list of editor IDs that are allowed to be used in the organization items: type: string title: allowed_editor_ids type: array defaultEditorId: description: default_editor_id is the default editor ID to be used when a user doesn't specify one title: default_editor_id type: string defaultEnvironmentImage: description: default_environment_image is the default container image when none is defined in repo title: default_environment_image type: string deleteArchivedEnvironmentsAfter: $ref: '#/components/schemas/google.protobuf.Duration' description: "delete_archived_environments_after controls how long archived environments are kept before automatic\ \ deletion.\n 0 means no automatic deletion. Maximum duration is 4 weeks (2419200 seconds)." title: delete_archived_environments_after editorVersionRestrictions: additionalProperties: $ref: '#/components/schemas/gitpod.v1.EditorVersionPolicy' title: value description: "editor_version_restrictions restricts which editor versions can be used.\n Maps editor ID to version\ \ policy, editor_version_restrictions not set means no restrictions.\n If empty or not set for an editor, we will\ \ use the latest version of the editor" title: editor_version_restrictions type: object maximumEnvironmentLifetime: $ref: '#/components/schemas/google.protobuf.Duration' description: "maximum_environment_lifetime controls for how long environments are allowed to be reused.\n 0 means\ \ no maximum lifetime. Maximum duration is 180 days (15552000 seconds)." title: maximum_environment_lifetime maximumEnvironmentLifetimeStrict: description: "maximum_environment_lifetime_strict controls whether environments past their\n lockdown_at timestamp\ \ are blocked from starting." title: maximum_environment_lifetime_strict type: boolean x-stainless-skip: true maximumEnvironmentTimeout: $ref: '#/components/schemas/google.protobuf.Duration' description: "maximum_environment_timeout controls the maximum timeout allowed for environments in seconds.\n 0\ \ means no limit (never). Minimum duration is 30 minutes (1800 seconds).\nvalue must be 0s (no limit) or at least\ \ 1800s (30 minutes):\n```\nthis == duration('0s') || this >= duration('1800s')\n```\n\n" title: maximum_environment_timeout maximumEnvironmentsPerUser: description: maximum_environments_per_user limits total environments (running or stopped) per user title: maximum_environments_per_user type: string maximumRunningEnvironmentsPerUser: description: maximum_running_environments_per_user limits simultaneously running environments per user title: maximum_running_environments_per_user type: string membersCreateProjects: description: members_create_projects controls whether members can create projects title: members_create_projects type: boolean membersRequireProjects: description: members_require_projects controls whether environments can only be created from projects by non-admin users title: members_require_projects type: boolean organizationId: description: organization_id is the ID of the organization format: uuid title: organization_id type: string portSharingDisabled: description: "port_sharing_disabled controls whether user-initiated port sharing is disabled in the organization.\n\ \ System ports (VS Code Browser, agents) are always exempt from this policy." title: port_sharing_disabled type: boolean requireCustomDomainAccess: description: "require_custom_domain_access controls whether users must access via custom domain\n when one is configured.\ \ When true, access via app.gitpod.io is blocked." title: require_custom_domain_access type: boolean restrictAccountCreationToScim: description: "restrict_account_creation_to_scim controls whether account creation is restricted to SCIM-provisioned\ \ users only.\n When true and SCIM is configured for the organization, only users provisioned via SCIM can create\ \ accounts." title: restrict_account_creation_to_scim type: boolean securityAgentPolicy: $ref: '#/components/schemas/gitpod.v1.SecurityAgentPolicy' description: "security_agent_policy contains security agent configuration for the organization.\n When configured,\ \ security agents are automatically deployed to all environments." title: security_agent_policy vetoExecPolicy: $ref: '#/components/schemas/gitpod.v1.VetoExecPolicy' description: veto_exec_policy contains the veto exec policy for environments. title: veto_exec_policy required: - organizationId - membersRequireProjects - membersCreateProjects - allowedEditorIds - defaultEditorId - allowLocalRunners - maximumRunningEnvironmentsPerUser - maximumEnvironmentsPerUser - defaultEnvironmentImage - portSharingDisabled - agentPolicy - requireCustomDomainAccess - restrictAccountCreationToScim title: OrganizationPolicies type: object gitpod.v1.OrganizationPolicies.EditorVersionRestrictionsEntry: additionalProperties: false properties: key: title: key type: string value: $ref: '#/components/schemas/gitpod.v1.EditorVersionPolicy' title: value title: EditorVersionRestrictionsEntry type: object gitpod.v1.OrganizationRole: enum: - ORGANIZATION_ROLE_UNSPECIFIED - ORGANIZATION_ROLE_ADMIN - ORGANIZATION_ROLE_MEMBER title: OrganizationRole type: string gitpod.v1.OrganizationTier: enum: - ORGANIZATION_TIER_UNSPECIFIED - ORGANIZATION_TIER_FREE - ORGANIZATION_TIER_ENTERPRISE - ORGANIZATION_TIER_CORE - ORGANIZATION_TIER_FREE_ONA title: OrganizationTier type: string gitpod.v1.OrganizationTierFailedPreconditionDetails: additionalProperties: false description: OrganizationTierFailedPreconditionDetails is a precondition failure details message used when a feature requires a higher Organization tier. properties: message: description: message is the message to display to the user title: message type: string requiredTier: $ref: '#/components/schemas/gitpod.v1.OrganizationTier' description: required_tier is the tier that is required to use the feature title: required_tier title: OrganizationTierFailedPreconditionDetails type: object gitpod.v1.PaginationRequest: additionalProperties: false properties: pageSize: description: "Page size is the maximum number of results to retrieve per page.\n Defaults to 25. Maximum 100." format: int32 maximum: 100 title: page_size type: integer token: description: "Token for the next set of results that was returned as next_token of a\n PaginationResponse" title: token type: string title: PaginationRequest type: object gitpod.v1.PaginationResponse: additionalProperties: false properties: nextToken: description: "Token passed for retrieving the next set of results. Empty if there are no\n more results" title: next_token type: string title: PaginationResponse type: object gitpod.v1.ParseContextURLPreconditionFailureDetails: additionalProperties: false properties: authenticationRequiredUrl: title: authentication_required_url type: string runnerIds: description: "if trying to parse a context URL without specifying a runner, runner_ids will be populated\n with\ \ possible runners that can be authenticated against to access the context URL.\n This is only populated if no\ \ authenticated runner against the context URL is found for the user." items: type: string title: runner_ids type: array scmId: title: scm_id type: string title: ParseContextURLPreconditionFailureDetails type: object gitpod.v1.ParseContextURLRequest: additionalProperties: false properties: contextUrl: format: uri title: context_url type: string runnerId: format: uuid title: runner_id type: string title: ParseContextURLRequest type: object gitpod.v1.ParseContextURLResponse: additionalProperties: false properties: git: $ref: '#/components/schemas/gitpod.v1.ParseContextURLResponse.GitContext' title: git issue: $ref: '#/components/schemas/gitpod.v1.ParseContextURLResponse.Issue' title: issue originalContextUrl: title: original_context_url type: string pr: $ref: '#/components/schemas/gitpod.v1.ParseContextURLResponse.PullRequest' deprecated: true title: pr projectIds: description: project_ids is a list of projects to which the context URL belongs to. items: type: string title: project_ids type: array pullRequest: $ref: '#/components/schemas/gitpod.v1.PullRequest' title: pull_request scmId: description: scm_id is the unique identifier of the SCM provider (e.g., "github", "gitlab", "bitbucket") title: scm_id type: string title: ParseContextURLResponse type: object gitpod.v1.ParseContextURLResponse.GitContext: additionalProperties: false properties: branch: title: branch type: string cloneUrl: title: clone_url type: string commit: title: commit type: string host: title: host type: string owner: title: owner type: string repo: title: repo type: string tag: title: tag type: string upstreamRemoteUrl: title: upstream_remote_url type: string title: GitContext type: object gitpod.v1.ParseContextURLResponse.Issue: additionalProperties: false properties: id: description: id is the source system's ID of this issue, e.g. BNFRD-6100 title: id type: string title: title: title type: string title: Issue type: object gitpod.v1.ParseContextURLResponse.PullRequest: additionalProperties: false description: 'Deprecated: Use top-level PullRequest message instead' properties: fromBranch: title: from_branch type: string id: title: id type: string title: title: title type: string toBranch: title: to_branch type: string title: PullRequest type: object gitpod.v1.PaymentFailureInfo: additionalProperties: false properties: failedAt: $ref: '#/components/schemas/google.protobuf.Timestamp' description: failed_at is when the payment failure occurred title: failed_at failureReason: description: failure_reason describes why the payment failed title: failure_reason type: string gracePeriodEndsAt: $ref: '#/components/schemas/google.protobuf.Timestamp' description: grace_period_ends_at is when the grace period ends title: grace_period_ends_at state: $ref: '#/components/schemas/gitpod.v1.PaymentFailureState' description: state indicates the current state of the payment failure title: state title: PaymentFailureInfo type: object gitpod.v1.PaymentFailureState: enum: - PAYMENT_FAILURE_STATE_UNSPECIFIED - PAYMENT_FAILURE_STATE_IN_GRACE - PAYMENT_FAILURE_STATE_SUSPENDED - PAYMENT_FAILURE_STATE_RESOLVED title: PaymentFailureState type: string gitpod.v1.PaymentMethodStatus: enum: - PAYMENT_METHOD_STATUS_UNSPECIFIED - PAYMENT_METHOD_STATUS_NOT_SET_UP - PAYMENT_METHOD_STATUS_VERIFIED title: PaymentMethodStatus type: string gitpod.v1.PaymentMethodVerificationStatus: additionalProperties: false properties: cardVerificationStatus: $ref: '#/components/schemas/gitpod.v1.CreditCardVerificationStatus' description: status contains the status of the card verification title: card_verification_status error: description: error contains any error message maxLength: 1024 minLength: 1 title: error type: string title: PaymentMethodVerificationStatus type: object gitpod.v1.PersonalAccessToken: additionalProperties: false properties: createdAt: $ref: '#/components/schemas/google.protobuf.Timestamp' title: created_at creator: $ref: '#/components/schemas/gitpod.v1.Subject' title: creator description: title: description type: string expiresAt: $ref: '#/components/schemas/google.protobuf.Timestamp' title: expires_at id: format: uuid title: id type: string lastUsed: $ref: '#/components/schemas/google.protobuf.Timestamp' title: last_used readOnly: description: "When true, the token can only be used for read operations.\n Mutations will be denied at the data\ \ layer." title: read_only type: boolean userId: format: uuid title: user_id type: string title: PersonalAccessToken type: object gitpod.v1.PolicyEnforcedFailedPreconditionDetails: additionalProperties: false description: PolicyEnforcedFailedPreconditionDetails is a precondition failure details message used when a feature is limited by the organization's policy. oneOf: - required: - maxLifetimeExceeded properties: maxLifetimeExceeded: $ref: '#/components/schemas/gitpod.v1.EnvironmentMaxLifetimeExceededDetails' title: max_lifetime_exceeded message: description: message is the message to display to the user title: message type: string policyName: description: policy_name is the name of the policy that is enforced title: policy_name type: string title: PolicyEnforcedFailedPreconditionDetails type: object gitpod.v1.PrSummary: additionalProperties: false description: PrSummary contains aggregate PR speed metrics for a date range. properties: deploymentFrequency: description: PRs merged to the default branch per week. format: double title: deployment_frequency type: number deploymentFrequencyTrend: description: "Fractional change in deployment_frequency vs previous period.\n Computed as (current - previous) /\ \ previous." format: double title: deployment_frequency_trend type: number leadTimeSeconds: description: Median lead time for changes in seconds (first commit → merge). format: double title: lead_time_seconds type: number leadTimeTrend: description: "Fractional change in lead_time_seconds vs previous period.\n Computed as (current - previous) / previous." format: double title: lead_time_trend type: number prsMergedCount: description: Total PRs merged in the date range. title: prs_merged_count type: string prsMergedTrend: description: "Fractional change in prs_merged_count vs previous period.\n Computed as (current - previous) / previous." format: double title: prs_merged_trend type: number timeToFirstApprovalSeconds: description: "Median time to first approval in seconds.\n Zero when no PRs in the range had approvals." format: double title: time_to_first_approval_seconds type: number timeToFirstApprovalTrend: description: "Fractional change in time_to_first_approval_seconds vs previous period.\n Computed as (current - previous)\ \ / previous." format: double title: time_to_first_approval_trend type: number title: PrSummary type: object gitpod.v1.PrTimeBucket: additionalProperties: false description: PrTimeBucket contains PR speed metrics for a single time period. properties: deploys: description: Total number of deploys (merged PRs) in this bucket. title: deploys type: string leadTimeSeconds: description: Median lead time in seconds for PRs merged in this bucket. format: double title: lead_time_seconds type: number prsMergedCount: description: Number of PRs merged in this bucket. title: prs_merged_count type: string startTime: $ref: '#/components/schemas/google.protobuf.Timestamp' description: Start of this time bucket. title: start_time timeToFirstApprovalSeconds: description: "Median time to first approval in seconds for PRs in this bucket.\n Zero when no PRs in the bucket\ \ had approvals." format: double title: time_to_first_approval_seconds type: number title: PrTimeBucket type: object gitpod.v1.Prebuild: additionalProperties: false description: "Prebuild represents a prebuild for a project that creates a snapshot\n for faster environment startup\ \ times." properties: id: description: id is the unique identifier for the prebuild format: uuid title: id type: string metadata: $ref: '#/components/schemas/gitpod.v1.PrebuildMetadata' description: metadata contains organizational and ownership information title: metadata spec: $ref: '#/components/schemas/gitpod.v1.PrebuildSpec' description: spec contains the configuration used to create this prebuild title: spec status: $ref: '#/components/schemas/gitpod.v1.PrebuildStatus' description: status contains the current status and progress of the prebuild title: status required: - metadata - spec - status title: Prebuild type: object gitpod.v1.PrebuildMetadata: additionalProperties: false description: PrebuildMetadata contains metadata about the prebuild properties: createdAt: $ref: '#/components/schemas/google.protobuf.Timestamp' description: created_at is when the prebuild was created title: created_at creator: $ref: '#/components/schemas/gitpod.v1.Subject' description: "creator is the identity of who created the prebuild.\n For manual prebuilds, this is the user who\ \ triggered it.\n For scheduled prebuilds, this is the configured executor." title: creator environmentClassId: description: "environment_class_id is the environment class used to create this prebuild.\n While the prebuild is\ \ created with a specific environment class, environments\n with different classes (e.g., smaller or larger instance\ \ sizes) can be created\n from the same prebuild, as long as they run on the same runner.\n If not specified in\ \ create requests, uses the project's default environment class." format: uuid title: environment_class_id type: string executor: $ref: '#/components/schemas/gitpod.v1.Subject' description: "executor is the identity used to run the prebuild.\n The executor's SCM credentials are used to clone\ \ the repository.\n If not set, the creator's identity is used." title: executor organizationId: description: organization_id is the ID of the organization that owns the prebuild format: uuid title: organization_id type: string projectId: description: project_id is the ID of the project this prebuild was created for format: uuid title: project_id type: string triggeredBy: $ref: '#/components/schemas/gitpod.v1.PrebuildMetadata.PrebuildTrigger' description: trigger describes the trigger that created this prebuild. title: triggered_by updatedAt: $ref: '#/components/schemas/google.protobuf.Timestamp' description: updated_at is when the prebuild was last updated title: updated_at required: - creator - createdAt - updatedAt title: PrebuildMetadata type: object gitpod.v1.PrebuildMetadata.PrebuildTrigger: description: PrebuildTrigger indicates how the prebuild was triggered enum: - PREBUILD_TRIGGER_UNSPECIFIED - PREBUILD_TRIGGER_MANUAL - PREBUILD_TRIGGER_SCHEDULED title: PrebuildTrigger type: string gitpod.v1.PrebuildPhase: description: PrebuildPhase represents the lifecycle phase of a prebuild enum: - PREBUILD_PHASE_UNSPECIFIED - PREBUILD_PHASE_PENDING - PREBUILD_PHASE_STARTING - PREBUILD_PHASE_RUNNING - PREBUILD_PHASE_STOPPING - PREBUILD_PHASE_SNAPSHOTTING - PREBUILD_PHASE_COMPLETED - PREBUILD_PHASE_FAILED - PREBUILD_PHASE_CANCELLING - PREBUILD_PHASE_CANCELLED - PREBUILD_PHASE_DELETING - PREBUILD_PHASE_DELETED title: PrebuildPhase type: string gitpod.v1.PrebuildSpec: additionalProperties: false description: PrebuildSpec contains the configuration used to create a prebuild properties: desiredPhase: $ref: '#/components/schemas/gitpod.v1.PrebuildPhase' description: "desired_phase is the desired phase of the prebuild.\n Used to signal cancellation or other state changes.\n\ \ This field is managed by the API and reconciler." title: desired_phase specVersion: description: "spec_version is incremented each time the spec is updated.\n Used for optimistic concurrency control." title: spec_version type: string timeout: $ref: '#/components/schemas/google.protobuf.Duration' description: "timeout is the maximum time allowed for the prebuild to complete.\n Defaults to 60 minutes if not\ \ specified.\n Maximum allowed timeout is 2 hours." title: timeout title: PrebuildSpec type: object gitpod.v1.PrebuildStatus: additionalProperties: false description: PrebuildStatus contains the current status and progress of a prebuild properties: completionTime: $ref: '#/components/schemas/google.protobuf.Timestamp' description: completion_time is when the prebuild completed (successfully or with failure) title: completion_time environmentId: description: "environment_id is the ID of the environment used to create this prebuild.\n This field is set when\ \ the prebuild environment is created." format: uuid title: environment_id type: string failureMessage: description: failure_message contains details about why the prebuild failed title: failure_message type: string logUrl: description: "log_url provides access to prebuild logs.\n During prebuild execution, this references the environment\ \ logs.\n After completion, this may reference archived logs." format: uri title: log_url type: string phase: $ref: '#/components/schemas/gitpod.v1.PrebuildPhase' description: phase is the current phase of the prebuild lifecycle title: phase snapshotCompletionPercentage: description: "snapshot_completion_percentage is the progress of snapshot creation (0-100).\n Only populated when\ \ phase is SNAPSHOTTING and progress is available from the cloud provider.\n This value may update infrequently\ \ or remain at 0 depending on the provider." format: int32 maximum: 100 title: snapshot_completion_percentage type: integer snapshotSizeBytes: description: "snapshot_size_bytes is the size of the snapshot in bytes.\n Only populated when the snapshot is available\ \ (phase is COMPLETED)." title: snapshot_size_bytes type: string statusVersion: description: "status_version is incremented each time the status is updated.\n Used for optimistic concurrency control." title: status_version type: string warningMessage: description: "warning_message contains warnings from the prebuild environment that indicate something went wrong\n\ \ but the prebuild could still complete. For example, the devcontainer failed to build but the environment\n is\ \ still usable. These warnings will likely affect any environment started from this prebuild." title: warning_message type: string required: - phase title: PrebuildStatus type: object gitpod.v1.PrebuildTrigger: additionalProperties: false description: PrebuildTrigger defines when prebuilds should be created for a project. oneOf: - required: - dailySchedule properties: dailySchedule: $ref: '#/components/schemas/gitpod.v1.PrebuildTrigger.DailySchedule' description: "daily_schedule triggers a prebuild once per day at the specified hour (UTC).\n The actual start time\ \ may vary slightly to distribute system load." title: daily_schedule title: PrebuildTrigger type: object gitpod.v1.PrebuildTrigger.DailySchedule: additionalProperties: false description: DailySchedule triggers prebuilds once per day at a specified hour. properties: hourUtc: description: "hour_utc is the hour of day (0-23) in UTC when the prebuild should start.\n The actual start time\ \ may be adjusted by a few minutes to balance system load." format: int32 maximum: 23 title: hour_utc type: integer title: DailySchedule type: object gitpod.v1.Principal: enum: - PRINCIPAL_UNSPECIFIED - PRINCIPAL_ACCOUNT - PRINCIPAL_USER - PRINCIPAL_RUNNER - PRINCIPAL_ENVIRONMENT - PRINCIPAL_SERVICE_ACCOUNT - PRINCIPAL_RUNNER_MANAGER title: Principal type: string gitpod.v1.Process: additionalProperties: false description: "Process describes the process that triggered a security event.\n This message is specific to event reporting\ \ (ingest path).\n List/Get RPCs may use a separate process representation.\n\n PID fields use int32 to match the\ \ kernel's pid_t (signed int).\n Linux PID max is 4,194,304 (2^22), well within int32 range.\n Postgres has no unsigned\ \ integer type: Ent maps uint32 to bigint\n (8 bytes) while int32 maps to integer (4 bytes). Using int32\n aligns\ \ proto, Go, and Postgres types without wasting storage." properties: cmdline: description: "cmdline is the full command line.\n The real hard limit the kernel enforces per argument during execve().\ \ MAX_ARG_STRLEN = 131072 defined in include/uapi/linux/binfmts.h as PAGE_SIZE * 32." maxLength: 131072 title: cmdline type: string name: description: "name is the process name (comm).\n 2x kernel TASK_COMM_LEN=16" maxLength: 32 title: name type: string pgid: description: pgid is the process group ID. format: int32 title: pgid type: integer pid: description: pid is the userspace process ID (kernel thread group ID, tgid). format: int32 title: pid type: integer ppid: description: ppid is the parent process ID. format: int32 title: ppid type: integer sid: description: sid is the session ID. format: int32 title: sid type: integer startedAt: $ref: '#/components/schemas/google.protobuf.Timestamp' description: started_at is when the process started. title: started_at tid: description: tid is the userspace thread ID (kernel pid). format: int32 title: tid type: integer title: Process type: object gitpod.v1.Project: additionalProperties: false properties: automationsFilePath: description: automations_file_path is the path to the automations file relative to the repo root title: automations_file_path type: string desiredPhase: $ref: '#/components/schemas/gitpod.v1.ProjectPhase' description: "desired_phase is the desired phase of the project\n When set to DELETED, the project is pending deletion" title: desired_phase devcontainerFilePath: description: devcontainer_file_path is the path to the devcontainer file relative to the repo root title: devcontainer_file_path type: string environmentClass: $ref: '#/components/schemas/gitpod.v1.ProjectEnvironmentClass' deprecated: true description: Use `environment_classes` instead. title: environment_class environmentClasses: description: environment_classes is the list of environment classes for the project items: $ref: '#/components/schemas/gitpod.v1.ProjectEnvironmentClass' title: environment_classes type: array id: description: id is the unique identifier for the project format: uuid title: id type: string initializer: $ref: '#/components/schemas/gitpod.v1.EnvironmentInitializer' description: initializer is the content initializer title: initializer metadata: $ref: '#/components/schemas/gitpod.v1.ProjectMetadata' title: metadata prebuildConfiguration: $ref: '#/components/schemas/gitpod.v1.ProjectPrebuildConfiguration' description: prebuild_configuration defines how prebuilds are created for this project. title: prebuild_configuration recommendedEditors: $ref: '#/components/schemas/gitpod.v1.RecommendedEditors' description: recommended_editors specifies the editors recommended for this project. title: recommended_editors technicalDescription: description: "technical_description is a detailed technical description of the project\n This field is not returned\ \ by default in GetProject or ListProjects responses" title: technical_description type: string usedBy: $ref: '#/components/schemas/gitpod.v1.Project.UsedBy' title: used_by required: - environmentClass title: Project type: object gitpod.v1.Project.UsedBy: additionalProperties: false properties: subjects: description: Subjects are the 10 most recent subjects who have used the project to create an environment items: $ref: '#/components/schemas/gitpod.v1.Subject' title: subjects type: array totalSubjects: description: Total number of unique subjects who have used the project format: int32 title: total_subjects type: integer title: UsedBy type: object gitpod.v1.ProjectEnvironmentClass: additionalProperties: false oneOf: - not: anyOf: - required: - localRunner required: - environmentClassId - not: anyOf: - required: - environmentClassId required: - localRunner properties: environmentClassId: description: Use a fixed environment class on a given Runner. This cannot be a local runner's environment class. format: uuid title: environment_class_id type: string localRunner: description: Use a local runner for the user title: local_runner type: boolean order: description: order is the priority of this entry format: int32 title: order type: integer title: ProjectEnvironmentClass type: object gitpod.v1.ProjectMetadata: additionalProperties: false properties: createdAt: $ref: '#/components/schemas/google.protobuf.Timestamp' title: created_at creator: $ref: '#/components/schemas/gitpod.v1.Subject' description: creator is the identity of the project creator title: creator name: description: name is the human readable name of the project maxLength: 80 minLength: 1 title: name type: string organizationId: description: organization_id is the ID of the organization that contains the environment format: uuid title: organization_id type: string updatedAt: $ref: '#/components/schemas/google.protobuf.Timestamp' title: updated_at title: ProjectMetadata type: object gitpod.v1.ProjectPhase: enum: - PROJECT_PHASE_UNSPECIFIED - PROJECT_PHASE_ACTIVE - PROJECT_PHASE_DELETED title: ProjectPhase type: string gitpod.v1.ProjectPolicy: additionalProperties: false properties: groupId: format: uuid title: group_id type: string role: $ref: '#/components/schemas/gitpod.v1.ProjectRole' description: role is the role assigned to the group title: role title: ProjectPolicy type: object gitpod.v1.ProjectPrebuildConfiguration: additionalProperties: false description: "ProjectPrebuildConfiguration defines how prebuilds are created for a project.\n Prebuilds create environment\ \ snapshots that enable faster environment startup times." properties: enableJetbrainsWarmup: description: enable_jetbrains_warmup controls whether JetBrains IDE warmup runs during prebuilds. title: enable_jetbrains_warmup type: boolean enabled: description: "enabled controls whether prebuilds are created for this project.\n When disabled, no automatic prebuilds\ \ will be triggered." title: enabled type: boolean environmentClassIds: description: "environment_class_ids specifies which environment classes should have prebuilds created.\n If empty,\ \ no prebuilds are created." items: format: uuid type: string title: environment_class_ids type: array executor: $ref: '#/components/schemas/gitpod.v1.Subject' description: "executor specifies who runs prebuilds for this project.\n The executor's SCM credentials are used\ \ to clone the repository.\n If not set, defaults to the project creator." title: executor timeout: $ref: '#/components/schemas/google.protobuf.Duration' description: "timeout is the maximum duration allowed for a prebuild to complete.\n If not specified, defaults to\ \ 1 hour.\n Must be between 5 minutes and 2 hours." title: timeout trigger: $ref: '#/components/schemas/gitpod.v1.PrebuildTrigger' description: trigger defines when prebuilds should be created. title: trigger title: ProjectPrebuildConfiguration type: object gitpod.v1.ProjectRole: enum: - PROJECT_ROLE_UNSPECIFIED - PROJECT_ROLE_ADMIN - PROJECT_ROLE_USER - PROJECT_ROLE_EDITOR title: ProjectRole type: string gitpod.v1.Prompt: additionalProperties: false properties: id: title: id type: string metadata: $ref: '#/components/schemas/gitpod.v1.PromptMetadata' title: metadata spec: $ref: '#/components/schemas/gitpod.v1.PromptSpec' title: spec title: Prompt type: object gitpod.v1.PromptMetadata: additionalProperties: false properties: createdAt: $ref: '#/components/schemas/google.protobuf.Timestamp' title: created_at creator: $ref: '#/components/schemas/gitpod.v1.Subject' description: creator is the identity of the prompt creator title: creator description: description: description is a description of what the prompt does title: description type: string name: description: name is the human readable name of the prompt title: name type: string organizationId: description: organization_id is the ID of the organization that contains the prompt format: uuid title: organization_id type: string updatedAt: $ref: '#/components/schemas/google.protobuf.Timestamp' title: updated_at title: PromptMetadata type: object gitpod.v1.PromptSpec: additionalProperties: false properties: command: description: command is the unique command string within the organization maxLength: 50 pattern: ^[a-zA-Z0-9_-]*$ title: command type: string isCommand: description: is_command indicates if this prompt is a command title: is_command type: boolean isSkill: description: is_skill indicates if this prompt is a skill (workflow instructions for agents) title: is_skill type: boolean isTemplate: description: is_template indicates if this prompt is a template title: is_template type: boolean prompt: description: prompt is the content of the prompt maxLength: 20000 title: prompt type: string title: PromptSpec type: object gitpod.v1.PromptValidationErrorDetails: additionalProperties: false description: "PromptValidationErrorDetails is returned as an error detail on INVALID_ARGUMENT\n when a prompt contains\ \ deceptive Unicode characters (e.g. bidi overrides).\n The frontend uses this to offer a one-click fix." properties: cleanedText: description: The prompt content with deceptive characters removed. title: cleaned_text type: string removedCount: description: The number of deceptive characters that were removed. format: int32 title: removed_count type: integer title: PromptValidationErrorDetails type: object gitpod.v1.PullRequest: additionalProperties: false description: "PullRequest represents pull request metadata from source control systems.\n This message is used across\ \ workflow triggers, executions, and agent contexts\n to maintain consistent PR information throughout the system." properties: author: description: Author name as provided by the SCM system title: author type: string draft: description: Whether this is a draft pull request title: draft type: boolean fromBranch: description: Source branch name (the branch being merged from) title: from_branch type: string id: description: 'Unique identifier from the source system (e.g., "123" for GitHub PR #123)' title: id type: string repository: $ref: '#/components/schemas/gitpod.v1.PullRequest.Repository' title: repository state: $ref: '#/components/schemas/gitpod.v1.PullRequest.State' title: state title: description: Pull request title title: title type: string toBranch: description: Target branch name (the branch being merged into) title: to_branch type: string url: description: Pull request URL (e.g., "https://github.com/owner/repo/pull/123") title: url type: string title: PullRequest type: object gitpod.v1.PullRequest.Repository: additionalProperties: false description: Repository information properties: cloneUrl: title: clone_url type: string host: title: host type: string name: title: name type: string owner: title: owner type: string title: Repository 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.PullRequestStat: additionalProperties: false description: PullRequestStat represents speed metrics for a single merged pull request. properties: authorLogin: description: Raw SCM username of the PR author (e.g. GitHub user.login, GitLab author.username). maxLength: 256 minLength: 1 title: author_login type: string createdAt: $ref: '#/components/schemas/google.protobuf.Timestamp' description: When the PR was opened. title: created_at firstApprovalAt: $ref: '#/components/schemas/google.protobuf.Timestamp' description: Timestamp of the earliest approving review. Unset when the PR had no approvals. title: first_approval_at firstCommitAt: $ref: '#/components/schemas/google.protobuf.Timestamp' description: Author date of the earliest commit on the PR branch. title: first_commit_at mergedAt: $ref: '#/components/schemas/google.protobuf.Timestamp' description: When the PR was merged. title: merged_at prNumber: description: "PR/MR number from the SCM provider. Together with project_id forms the\n idempotency key for upserts." exclusiveMinimum: true format: int32 minimum: 0 title: pr_number type: integer scmProvider: $ref: '#/components/schemas/gitpod.v1.ScmProvider' description: SCM platform the PR was fetched from. not: enum: - 0 title: scm_provider targetBranch: description: Branch the PR was merged into (e.g. "main"). maxLength: 256 minLength: 1 title: target_branch type: string required: - createdAt - mergedAt - firstCommitAt title: PullRequestStat type: object gitpod.v1.RecommendedEditors: additionalProperties: false description: RecommendedEditors contains the map of recommended editors and their versions. properties: editors: additionalProperties: $ref: '#/components/schemas/gitpod.v1.EditorVersions' title: value description: "editors maps editor aliases to their recommended versions.\n Key is the editor alias (e.g., \"intellij\"\ , \"goland\", \"vscode\").\n Value contains the list of recommended versions for that editor.\n If versions list\ \ is empty, all available versions are recommended.\n Example: {\"intellij\": {versions: [\"2025.1\", \"2024.3\"\ ]}, \"goland\": {}}" title: editors type: object title: RecommendedEditors type: object gitpod.v1.RecommendedEditors.EditorsEntry: additionalProperties: false properties: key: title: key type: string value: $ref: '#/components/schemas/gitpod.v1.EditorVersions' title: value title: EditorsEntry type: object gitpod.v1.ReconcileBillingRequest: additionalProperties: false properties: organizationId: description: organization_id is the ID of the organization to reconcile billing for format: uuid title: organization_id type: string required: - organizationId title: ReconcileBillingRequest type: object gitpod.v1.ReconcileBillingResponse: additionalProperties: false title: ReconcileBillingResponse type: object gitpod.v1.RegenerateSCIMTokenRequest: additionalProperties: false properties: scimConfigurationId: description: scim_configuration_id is the ID of the SCIM configuration to regenerate token for format: uuid title: scim_configuration_id type: string tokenExpiresIn: $ref: '#/components/schemas/google.protobuf.Duration' description: "token_expires_in is the duration until the new token expires.\n If not specified, uses the same duration\ \ as the previous token." nullable: true title: token_expires_in required: - scimConfigurationId title: RegenerateSCIMTokenRequest type: object gitpod.v1.RegenerateSCIMTokenResponse: additionalProperties: false properties: token: description: "token is the new bearer token for SCIM API authentication.\n This invalidates the previous token -\ \ store it securely." title: token type: string tokenExpiresAt: $ref: '#/components/schemas/google.protobuf.Timestamp' description: token_expires_at is when the new token will expire title: token_expires_at required: - token - tokenExpiresAt title: RegenerateSCIMTokenResponse type: object gitpod.v1.RemoveSessionResourceRequest: additionalProperties: false properties: resourceId: format: uuid title: resource_id type: string sessionId: format: uuid title: session_id type: string title: RemoveSessionResourceRequest type: object gitpod.v1.RemoveSessionResourceResponse: additionalProperties: false title: RemoveSessionResourceResponse type: object gitpod.v1.RemoveTeamMemberRequest: additionalProperties: false properties: teamMemberId: format: uuid title: team_member_id type: string title: RemoveTeamMemberRequest type: object gitpod.v1.RemoveTeamMemberResponse: additionalProperties: false title: RemoveTeamMemberResponse type: object gitpod.v1.ReportAgentExecutionOutputsRequest: additionalProperties: false properties: agentExecutionId: description: The ID of the agent execution to report outputs for format: uuid title: agent_execution_id type: string outputs: additionalProperties: $ref: '#/components/schemas/gitpod.v1.AgentExecution.Status.OutputValue' title: value description: "Outputs to report. New outputs are merged with existing outputs.\n Values are stored as strings and\ \ the API determines the type." minProperties: 1 title: outputs type: object title: ReportAgentExecutionOutputsRequest type: object gitpod.v1.ReportAgentExecutionOutputsRequest.OutputsEntry: additionalProperties: false properties: key: title: key type: string value: $ref: '#/components/schemas/gitpod.v1.AgentExecution.Status.OutputValue' title: value title: OutputsEntry type: object gitpod.v1.ReportAgentExecutionOutputsResponse: additionalProperties: false properties: agentExecution: $ref: '#/components/schemas/gitpod.v1.AgentExecution' title: agent_execution title: ReportAgentExecutionOutputsResponse type: object gitpod.v1.ReportAgentTraceRequest: additionalProperties: false description: "ReportAgentTraceRequest pushes an agent trace session containing one or more\n trace lines (typically\ \ JSONL) for storage." properties: agentExecutionId: description: Agent execution that produced the trace. format: uuid title: agent_execution_id type: string environmentId: description: Environment that produced the trace. format: uuid title: environment_id type: string linesAdded: description: Total lines added across all edits in the trace session. title: lines_added type: string linesRemoved: description: Total lines removed across all edits in the trace session. title: lines_removed type: string model: $ref: '#/components/schemas/gitpod.v1.SupportedModel' description: The LLM model used during this agent session. title: model projectId: description: Project the trace belongs to. format: uuid title: project_id type: string traces: description: "Individual trace lines (typically one JSON object per line).\n May be empty when only line-count aggregates\ \ are reported.\n Each line is capped at 5 MiB." items: maxLength: 5242880 minLength: 1 type: string title: traces type: array title: ReportAgentTraceRequest type: object gitpod.v1.ReportAgentTraceResponse: additionalProperties: false title: ReportAgentTraceResponse type: object gitpod.v1.ReportCoAuthorStatsRequest: additionalProperties: false description: ReportCoAuthorStatsRequest is sent by the CLI to push analysis results. properties: projectId: description: Project that was analyzed. minLength: 1 title: project_id type: string stats: description: Per-commit co-author stats to upsert. items: $ref: '#/components/schemas/gitpod.v1.CommitCoAuthorStat' maxItems: 10000 minItems: 1 title: stats type: array title: ReportCoAuthorStatsRequest type: object gitpod.v1.ReportCoAuthorStatsResponse: additionalProperties: false properties: insertedCount: description: Number of rows inserted (new commits). title: inserted_count type: string updatedCount: description: Number of rows updated (re-reported commits). title: updated_count type: string title: ReportCoAuthorStatsResponse type: object gitpod.v1.ReportErrorsRequest: additionalProperties: false description: ReportErrorsRequest contains the error information to be reported properties: events: description: Error events to be reported (batch) - now using Sentry-compatible structure items: $ref: '#/components/schemas/gitpod.v1.ErrorEvent' maxItems: 100 minItems: 1 title: events type: array title: ReportErrorsRequest type: object gitpod.v1.ReportErrorsResponse: additionalProperties: false description: "ReportErrorsResponse confirms that the errors were successfully received\n Success is indicated by HTTP\ \ 200 status code, failures by other status codes Empty response - success indicated by HTTP status code" title: ReportErrorsResponse type: object gitpod.v1.ReportExecEventRequest: additionalProperties: false properties: action: $ref: '#/components/schemas/gitpod.v1.KernelControlsAction' description: action is the enforcement action taken (block or audit). not: enum: - 0 title: action environmentId: description: environment_id is the environment where the event occurred. format: uuid title: environment_id type: string executable: description: "executable is the digest of the binary content (e.g., \"sha256:a1b2c3d4...\").\n 256 allows for longer\ \ hash algorithms or prefixed identifiers.\n May be empty when the event source cannot compute the hash." maxLength: 256 title: executable type: string filename: description: "filename is the kernel-resolved path of the binary.\n Kernel PATH_MAX = 4096 (include/uapi/linux/limits.h).\n\ \ May be empty if the event source could not resolve it." maxLength: 4096 title: filename type: string process: $ref: '#/components/schemas/gitpod.v1.Process' description: process contains metadata about the process that triggered the event. title: process timestamp: $ref: '#/components/schemas/google.protobuf.Timestamp' description: timestamp is when the event occurred in the environment. title: timestamp required: - process - timestamp title: ReportExecEventRequest type: object gitpod.v1.ReportExecEventResponse: additionalProperties: false title: ReportExecEventResponse type: object gitpod.v1.ReportLLMUsageRequest: additionalProperties: false properties: agentExecutionId: description: The agent execution ID if this usage is associated with an agent execution title: agent_execution_id type: string idempotencyKey: description: Idempotency key to prevent duplicate usage reports title: idempotency_key type: string llmIntegrationId: description: The LLM integration's ID format: uuid title: llm_integration_id type: string runnerId: description: The runner's identity format: uuid title: runner_id type: string supportedModel: $ref: '#/components/schemas/gitpod.v1.SupportedModel' description: The model used for the LLM request title: supported_model usage: $ref: '#/components/schemas/gitpod.v1.LLMUsage' title: usage title: ReportLLMUsageRequest type: object gitpod.v1.ReportLLMUsageResponse: additionalProperties: false title: ReportLLMUsageResponse type: object gitpod.v1.ReportPrStatsRequest: additionalProperties: false description: ReportPrStatsRequest is sent by the CLI to push PR speed metrics. properties: projectId: description: Project that was analyzed. format: uuid title: project_id type: string stats: description: Per-PR stats to upsert. items: $ref: '#/components/schemas/gitpod.v1.PullRequestStat' maxItems: 10000 minItems: 1 title: stats type: array title: ReportPrStatsRequest type: object gitpod.v1.ReportPrStatsResponse: additionalProperties: false properties: insertedCount: description: Number of rows inserted (new PRs). title: inserted_count type: string updatedCount: description: Number of rows updated (re-reported PRs). title: updated_count type: string title: ReportPrStatsResponse type: object gitpod.v1.ReportRunnerMetricsRequest: additionalProperties: false properties: compressedMetrics: description: "Snappy-compressed Prometheus remote-write WriteRequest protobuf.\n Maximum 512 KB compressed." format: byte maxLength: 524288 title: compressed_metrics type: string runnerId: description: The runner's identity format: uuid title: runner_id type: string required: - runnerId - compressedMetrics title: ReportRunnerMetricsRequest type: object gitpod.v1.ReportRunnerMetricsResponse: additionalProperties: false title: ReportRunnerMetricsResponse type: object gitpod.v1.RequestInfo: additionalProperties: false description: Request information (Sentry-compatible) properties: data: description: Request body (truncated if large) maxLength: 10000 title: data type: string headers: additionalProperties: maxLength: 1000 title: value type: string description: Request headers maxProperties: 50 title: headers type: object method: description: HTTP method maxLength: 10 title: method type: string queryString: additionalProperties: maxLength: 1000 title: value type: string description: Query parameters maxProperties: 50 title: query_string type: object url: description: Request URL maxLength: 2000 title: url type: string title: RequestInfo type: object gitpod.v1.RequestInfo.HeadersEntry: additionalProperties: false properties: key: title: key type: string value: title: value type: string title: HeadersEntry type: object gitpod.v1.RequestInfo.QueryStringEntry: additionalProperties: false properties: key: title: key type: string value: title: value type: string title: QueryStringEntry type: object gitpod.v1.RequestRecoveryCreditRequest: additionalProperties: false properties: organizationId: description: organization_id is the ID of the organization requesting recovery credits format: uuid title: organization_id type: string required: - organizationId title: RequestRecoveryCreditRequest type: object gitpod.v1.RequestRecoveryCreditResponse: additionalProperties: false title: RequestRecoveryCreditResponse type: object gitpod.v1.Resolution: description: Resolution specifies the time granularity for time series data. enum: - RESOLUTION_UNSPECIFIED - RESOLUTION_HOURLY - RESOLUTION_DAILY - RESOLUTION_WEEKLY - RESOLUTION_MONTHLY title: Resolution type: string gitpod.v1.ResolveEditorURLRequest: additionalProperties: false properties: editorId: description: editorId is the ID of the editor to resolve the URL for format: uuid title: editor_id type: string environmentId: description: environmentId is the ID of the environment to resolve the URL for format: uuid title: environment_id type: string organizationId: description: organizationId is the ID of the organization to resolve the URL for format: uuid title: organization_id type: string version: description: "version is the editor version to use\n If not provided, the latest version will be installed\n\n Examples\ \ for JetBrains: 2025.2" title: version type: string required: - editorId - environmentId - organizationId title: ResolveEditorURLRequest type: object gitpod.v1.ResolveEditorURLResponse: additionalProperties: false properties: url: description: url is the resolved editor URL title: url type: string required: - url title: ResolveEditorURLResponse type: object gitpod.v1.ResourceOperation: enum: - RESOURCE_OPERATION_UNSPECIFIED - RESOURCE_OPERATION_CREATE - RESOURCE_OPERATION_UPDATE - RESOURCE_OPERATION_DELETE - RESOURCE_OPERATION_UPDATE_STATUS title: ResourceOperation type: string gitpod.v1.ResourceRole: description: "ResourceRole represents roles that can be assigned to groups on resources\n These map directly to the\ \ roles defined in backend/db/rule/rbac/role/role.go" enum: - RESOURCE_ROLE_UNSPECIFIED - RESOURCE_ROLE_ORG_ADMIN - RESOURCE_ROLE_ORG_MEMBER - RESOURCE_ROLE_ORG_RUNNERS_ADMIN - RESOURCE_ROLE_ORG_PROJECTS_ADMIN - RESOURCE_ROLE_ORG_AUTOMATIONS_ADMIN - RESOURCE_ROLE_ORG_GROUPS_ADMIN - RESOURCE_ROLE_ORG_AUDIT_LOG_READER - RESOURCE_ROLE_GROUP_ADMIN - RESOURCE_ROLE_GROUP_VIEWER - RESOURCE_ROLE_USER_IDENTITY - RESOURCE_ROLE_USER_VIEWER - RESOURCE_ROLE_USER_ADMIN - RESOURCE_ROLE_ENVIRONMENT_IDENTITY - RESOURCE_ROLE_ENVIRONMENT_ADMIN - RESOURCE_ROLE_ENVIRONMENT_USER - RESOURCE_ROLE_ENVIRONMENT_VIEWER - RESOURCE_ROLE_ENVIRONMENT_RUNNER - RESOURCE_ROLE_RUNNER_IDENTITY - RESOURCE_ROLE_RUNNER_ADMIN - RESOURCE_ROLE_RUNNER_LOCAL_ADMIN - RESOURCE_ROLE_RUNNER_MANAGED_ADMIN - RESOURCE_ROLE_RUNNER_USER - RESOURCE_ROLE_RUNNER_CONFIGURATION_READER - RESOURCE_ROLE_HOST_AUTHENTICATION_TOKEN_ADMIN - RESOURCE_ROLE_HOST_AUTHENTICATION_TOKEN_UPDATER - RESOURCE_ROLE_PROJECT_ADMIN - RESOURCE_ROLE_PROJECT_USER - RESOURCE_ROLE_PROJECT_EDITOR - RESOURCE_ROLE_ENVIRONMENT_SERVICE_ADMIN - RESOURCE_ROLE_ENVIRONMENT_SERVICE_VIEWER - RESOURCE_ROLE_ENVIRONMENT_SERVICE_USER - RESOURCE_ROLE_ENVIRONMENT_SERVICE_ENV - RESOURCE_ROLE_ENVIRONMENT_TASK_ADMIN - RESOURCE_ROLE_ENVIRONMENT_TASK_VIEWER - RESOURCE_ROLE_ENVIRONMENT_TASK_USER - RESOURCE_ROLE_ENVIRONMENT_TASK_ENV - RESOURCE_ROLE_SERVICE_ACCOUNT_IDENTITY - RESOURCE_ROLE_SERVICE_ACCOUNT_ADMIN - RESOURCE_ROLE_AGENT_EXECUTION_USER - RESOURCE_ROLE_AGENT_EXECUTION_ADMIN - RESOURCE_ROLE_AGENT_EXECUTION_RUNNER - RESOURCE_ROLE_AGENT_EXECUTION_OUTPUTS_REPORTER - RESOURCE_ROLE_AGENT_EXECUTION_VIEWER - RESOURCE_ROLE_AGENT_ADMIN - RESOURCE_ROLE_AGENT_VIEWER - RESOURCE_ROLE_AGENT_EXECUTOR - RESOURCE_ROLE_WORKFLOW_ADMIN - RESOURCE_ROLE_WORKFLOW_USER - RESOURCE_ROLE_WORKFLOW_VIEWER - RESOURCE_ROLE_WORKFLOW_EXECUTOR - RESOURCE_ROLE_SNAPSHOT_ADMIN - RESOURCE_ROLE_SNAPSHOT_RUNNER - RESOURCE_ROLE_WEBHOOK_ADMIN - RESOURCE_ROLE_WEBHOOK_VIEWER - RESOURCE_ROLE_WARMPOOL_RUNNER - RESOURCE_ROLE_WARMPOOL_ADMIN - RESOURCE_ROLE_WARMPOOL_VIEWER - RESOURCE_ROLE_SESSION_ADMIN - RESOURCE_ROLE_SESSION_USER - RESOURCE_ROLE_TEAM_ADMIN - RESOURCE_ROLE_TEAM_VIEWER title: ResourceRole type: string gitpod.v1.ResourceType: enum: - RESOURCE_TYPE_UNSPECIFIED - RESOURCE_TYPE_ENVIRONMENT - RESOURCE_TYPE_RUNNER - RESOURCE_TYPE_PROJECT - RESOURCE_TYPE_TASK - RESOURCE_TYPE_TASK_EXECUTION - RESOURCE_TYPE_SERVICE - RESOURCE_TYPE_ORGANIZATION - RESOURCE_TYPE_USER - RESOURCE_TYPE_ENVIRONMENT_CLASS - RESOURCE_TYPE_RUNNER_SCM_INTEGRATION - RESOURCE_TYPE_HOST_AUTHENTICATION_TOKEN - RESOURCE_TYPE_GROUP - RESOURCE_TYPE_PERSONAL_ACCESS_TOKEN - RESOURCE_TYPE_USER_PREFERENCE - RESOURCE_TYPE_SERVICE_ACCOUNT - RESOURCE_TYPE_SECRET - RESOURCE_TYPE_SSO_CONFIG - RESOURCE_TYPE_DOMAIN_VERIFICATION - RESOURCE_TYPE_AGENT_EXECUTION - RESOURCE_TYPE_RUNNER_LLM_INTEGRATION - RESOURCE_TYPE_AGENT - RESOURCE_TYPE_ENVIRONMENT_SESSION - RESOURCE_TYPE_USER_SECRET - RESOURCE_TYPE_ORGANIZATION_POLICY - RESOURCE_TYPE_ORGANIZATION_SECRET - RESOURCE_TYPE_PROJECT_ENVIRONMENT_CLASS - RESOURCE_TYPE_BILLING - RESOURCE_TYPE_PROMPT - RESOURCE_TYPE_COUPON - RESOURCE_TYPE_COUPON_REDEMPTION - RESOURCE_TYPE_ACCOUNT - RESOURCE_TYPE_INTEGRATION - RESOURCE_TYPE_WORKFLOW - RESOURCE_TYPE_WORKFLOW_EXECUTION - RESOURCE_TYPE_WORKFLOW_EXECUTION_ACTION - RESOURCE_TYPE_SNAPSHOT - RESOURCE_TYPE_PREBUILD - RESOURCE_TYPE_ORGANIZATION_LLM_INTEGRATION - RESOURCE_TYPE_CUSTOM_DOMAIN - RESOURCE_TYPE_ROLE_ASSIGNMENT_CHANGED - RESOURCE_TYPE_GROUP_MEMBERSHIP_CHANGED - RESOURCE_TYPE_WEBHOOK - RESOURCE_TYPE_SCIM_CONFIGURATION - RESOURCE_TYPE_SERVICE_ACCOUNT_SECRET - RESOURCE_TYPE_ANNOUNCEMENT_BANNER - RESOURCE_TYPE_SERVICE_ACCOUNT_TOKEN - RESOURCE_TYPE_ROLE_ASSIGNMENT - RESOURCE_TYPE_WARM_POOL - RESOURCE_TYPE_NOTIFICATION title: ResourceType type: string gitpod.v1.RoleAssignment: additionalProperties: false description: RoleAssignment represents a role assigned to a group on a specific resource properties: derivedFromOrgRole: $ref: '#/components/schemas/gitpod.v1.ResourceRole' description: "The org-level role that created this assignment, if any.\n RESOURCE_ROLE_UNSPECIFIED means this is\ \ a direct share (manually created).\n Non-zero (e.g., ORG_PROJECTS_ADMIN, ORG_RUNNERS_ADMIN) means this\n assignment\ \ was derived from an org-level role." nullable: true title: derived_from_org_role groupId: description: Group identifier format: uuid title: group_id type: string id: description: Unique identifier for the role assignment format: uuid title: id type: string organizationId: description: Organization identifier format: uuid title: organization_id type: string resourceId: description: Resource identifier format: uuid title: resource_id type: string resourceRole: $ref: '#/components/schemas/gitpod.v1.ResourceRole' description: Role assigned to the group on this resource title: resource_role resourceType: $ref: '#/components/schemas/gitpod.v1.ResourceType' description: Type of resource (runner, project, environment, etc.) title: resource_type title: RoleAssignment type: object gitpod.v1.RotateWebhookSecretRequest: additionalProperties: false description: RotateWebhookSecretRequest rotates the webhook secret. properties: webhookId: format: uuid title: webhook_id type: string title: RotateWebhookSecretRequest type: object gitpod.v1.RotateWebhookSecretResponse: additionalProperties: false properties: secret: description: The new webhook secret (decrypted) title: secret type: string title: RotateWebhookSecretResponse type: object gitpod.v1.RotateWorkflowWebhookSecretRequest: additionalProperties: false properties: workflowId: format: uuid title: workflow_id type: string title: RotateWorkflowWebhookSecretRequest type: object gitpod.v1.RotateWorkflowWebhookSecretResponse: additionalProperties: false properties: secret: description: The new webhook secret (decrypted) title: secret type: string title: RotateWorkflowWebhookSecretResponse type: object gitpod.v1.Runner: additionalProperties: false properties: createdAt: $ref: '#/components/schemas/google.protobuf.Timestamp' description: Time when the Runner was created. title: created_at creator: $ref: '#/components/schemas/gitpod.v1.Subject' description: creator is the identity of the creator of the environment title: creator kind: $ref: '#/components/schemas/gitpod.v1.RunnerKind' description: The runner's kind title: kind name: description: The runner's name which is shown to users title: name type: string provider: $ref: '#/components/schemas/gitpod.v1.RunnerProvider' description: The runner's provider title: provider runnerId: title: runner_id type: string runnerManagerId: description: "The runner manager id specifies the runner manager for the managed runner.\n This field is only set\ \ for managed runners." format: uuid title: runner_manager_id type: string spec: $ref: '#/components/schemas/gitpod.v1.RunnerSpec' description: The runner's specification title: spec status: $ref: '#/components/schemas/gitpod.v1.RunnerStatus' description: The runner's status title: status updatedAt: $ref: '#/components/schemas/google.protobuf.Timestamp' description: Time when the Runner was last udpated. title: updated_at title: Runner type: object gitpod.v1.RunnerAgentExecution: additionalProperties: false properties: actorAccessToken: title: actor_access_token type: string agentExecution: $ref: '#/components/schemas/gitpod.v1.AgentExecution' title: agent_execution title: RunnerAgentExecution type: object gitpod.v1.RunnerCapability: enum: - RUNNER_CAPABILITY_UNSPECIFIED - RUNNER_CAPABILITY_FETCH_LOCAL_SCM_INTEGRATIONS - RUNNER_CAPABILITY_SECRET_CONTAINER_REGISTRY - RUNNER_CAPABILITY_AGENT_EXECUTION - RUNNER_CAPABILITY_ALLOW_ENV_TOKEN_POPULATION - RUNNER_CAPABILITY_DEFAULT_DEV_CONTAINER_IMAGE - RUNNER_CAPABILITY_ENVIRONMENT_SNAPSHOT - RUNNER_CAPABILITY_PREBUILDS_BEFORE_SNAPSHOT_TRIGGER - RUNNER_CAPABILITY_LIST_SCM_ORGANIZATIONS - RUNNER_CAPABILITY_CHECK_REPOSITORY_ACCESS - RUNNER_CAPABILITY_RUNNER_SIDE_AGENT - RUNNER_CAPABILITY_WARM_POOL - RUNNER_CAPABILITY_ASG_WARM_POOL title: RunnerCapability type: string gitpod.v1.RunnerConfiguration: additionalProperties: false properties: autoUpdate: description: auto_update indicates whether the runner should automatically update itself. title: auto_update type: boolean continuousProfiling: description: "continuous_profiling indicates whether continuous profiling is enabled.\n This is an internal-only\ \ field used for debugging and is not exposed in the dashboard UI." title: continuous_profiling type: boolean x-stainless-skip: true devcontainerImageCacheEnabled: description: "devcontainer_image_cache_enabled controls whether the devcontainer build cache is\n enabled for this\ \ runner.\n Only takes effect on supported runners, currently only AWS EC2 and Gitpod-managed runners." title: devcontainer_image_cache_enabled type: boolean encryptedHoneycombApiKey: description: "encrypted_honeycomb_api_key is the Honeycomb API key encrypted with the runner's public key.\n This\ \ is an internal-only field used for debugging and is not exposed in the dashboard UI." format: byte title: encrypted_honeycomb_api_key type: string x-stainless-skip: true logLevel: $ref: '#/components/schemas/gitpod.v1.LogLevel' description: log_level is the log level for the runner title: log_level metrics: $ref: '#/components/schemas/gitpod.v1.MetricsConfiguration' description: metrics contains configuration for the runner's metrics collection title: metrics region: description: "Region to deploy the runner in, if applicable.\n This is mainly used for remote runners, and is only\ \ a hint. The runner may be\n deployed in a different region. See the runner's status for the actual region." title: region type: string releaseChannel: $ref: '#/components/schemas/gitpod.v1.RunnerReleaseChannel' description: The release channel the runner is on title: release_channel updateWindow: $ref: '#/components/schemas/gitpod.v1.UpdateWindow' description: "update_window defines the daily time window (UTC) during which auto-updates are allowed.\n If not\ \ set, updates are allowed at any time." title: update_window title: RunnerConfiguration type: object gitpod.v1.RunnerConfigurationSchema: additionalProperties: false properties: environmentClasses: items: $ref: '#/components/schemas/gitpod.v1.RunnerConfigurationSchema.Field' title: environment_classes type: array runnerConfig: items: $ref: '#/components/schemas/gitpod.v1.RunnerConfigurationSchema.Field' title: runner_config type: array scm: items: $ref: '#/components/schemas/gitpod.v1.RunnerConfigurationSchema.SCMConfigSchema' title: scm type: array version: description: The schema version title: version type: string title: RunnerConfigurationSchema type: object gitpod.v1.RunnerConfigurationSchema.BoolField: additionalProperties: false properties: default: title: default type: boolean title: BoolField type: object gitpod.v1.RunnerConfigurationSchema.DisplayField: additionalProperties: false properties: default: title: default type: string title: DisplayField type: object gitpod.v1.RunnerConfigurationSchema.EnumField: additionalProperties: false properties: default: deprecated: true description: deprecated, will be removed, use default_value instead title: default type: string defaultValue: $ref: '#/components/schemas/gitpod.v1.RunnerConfigurationSchema.EnumField.Value' title: default_value possibleValues: items: $ref: '#/components/schemas/gitpod.v1.RunnerConfigurationSchema.EnumField.Value' title: possible_values type: array values: deprecated: true description: deprecated, will be removed, use possible_values instead items: deprecated: true type: string title: values type: array title: EnumField type: object gitpod.v1.RunnerConfigurationSchema.EnumField.Value: additionalProperties: false properties: detail: title: detail type: string subtitle: title: subtitle type: string title: title: title type: string title: Value type: object gitpod.v1.RunnerConfigurationSchema.Field: additionalProperties: false oneOf: - not: anyOf: - required: - display - required: - enum - required: - int - required: - string required: - bool - not: anyOf: - required: - bool - required: - enum - required: - int - required: - string required: - display - not: anyOf: - required: - bool - required: - display - required: - int - required: - string required: - enum - not: anyOf: - required: - bool - required: - display - required: - enum - required: - string required: - int - not: anyOf: - required: - bool - required: - display - required: - enum - required: - int required: - string properties: bool: $ref: '#/components/schemas/gitpod.v1.RunnerConfigurationSchema.BoolField' title: bool description: title: description type: string display: $ref: '#/components/schemas/gitpod.v1.RunnerConfigurationSchema.DisplayField' title: display enum: $ref: '#/components/schemas/gitpod.v1.RunnerConfigurationSchema.EnumField' title: enum id: title: id type: string int: $ref: '#/components/schemas/gitpod.v1.RunnerConfigurationSchema.IntField' title: int name: title: name type: string required: title: required type: boolean secret: title: secret type: boolean string: $ref: '#/components/schemas/gitpod.v1.RunnerConfigurationSchema.StringField' title: string title: Field type: object gitpod.v1.RunnerConfigurationSchema.IntField: additionalProperties: false properties: default: format: int32 title: default type: integer max: format: int32 title: max type: integer min: format: int32 title: min type: integer title: IntField type: object gitpod.v1.RunnerConfigurationSchema.OAuth: additionalProperties: false properties: callbackUrl: description: callback_url is the URL the OAuth app will redirect to after the user has authenticated. title: callback_url type: string title: OAuth type: object gitpod.v1.RunnerConfigurationSchema.PersonalAccessToken: additionalProperties: false properties: description: description: description is a human-readable description of the PAT. title: description type: string docsLink: description: docs_link is a link to the documentation on how to create a PAT for this SCM system. title: docs_link type: string title: PersonalAccessToken type: object gitpod.v1.RunnerConfigurationSchema.SCMConfigSchema: additionalProperties: false properties: defaultHosts: items: type: string title: default_hosts type: array name: title: name type: string oauth: $ref: '#/components/schemas/gitpod.v1.RunnerConfigurationSchema.OAuth' title: oauth pat: $ref: '#/components/schemas/gitpod.v1.RunnerConfigurationSchema.PersonalAccessToken' title: pat scmId: title: scm_id type: string title: SCMConfigSchema type: object gitpod.v1.RunnerConfigurationSchema.StringField: additionalProperties: false properties: default: title: default type: string pattern: title: pattern type: string title: StringField type: object gitpod.v1.RunnerEnvironment: additionalProperties: false properties: activitySignal: $ref: '#/components/schemas/gitpod.v1.EnvironmentActivitySignal' description: The last activity signal received by the management plane title: activity_signal environmentAccessToken: description: The environment's access token title: environment_access_token type: string id: description: "ID is a unique identifier of this environment. No other environment with the same name must be managed\ \ by this\n environment manager" format: uuid title: id type: string metadata: $ref: '#/components/schemas/gitpod.v1.EnvironmentMetadata' description: Metadata is data associated with this environment that's required for other parts of Gitpod to function title: metadata scmContexts: description: The SCM contexts for the environment items: $ref: '#/components/schemas/gitpod.v1.SCMContext' title: scm_contexts type: array snapshotId: description: "snapshot_id specifies an existing environment snapshot to use when creating the environment.\n If\ \ present, the runner will attempt to use the referenced snapshot to create the environment,\n and otherwise fall\ \ back to normal environment creation." format: uuid title: snapshot_id type: string spec: $ref: '#/components/schemas/gitpod.v1.EnvironmentSpec' description: Spec is the configuration of the environment that's required for the runner to start the environment title: spec startupTraceContext: additionalProperties: title: value type: string description: "startup_trace_context contains trace headers for the root startup trace\n to propagate trace context\ \ to runners for end-to-end tracing" title: startup_trace_context type: object title: RunnerEnvironment type: object gitpod.v1.RunnerEnvironment.StartupTraceContextEntry: additionalProperties: false properties: key: title: key type: string value: title: value type: string title: StartupTraceContextEntry type: object gitpod.v1.RunnerEnvironmentSnapshot: additionalProperties: false properties: id: description: ID is a unique identifier of this snapshot title: id type: string metadata: $ref: '#/components/schemas/gitpod.v1.RunnerEnvironmentSnapshotMetadata' description: Metadata is data associated with this snapshot title: metadata spec: $ref: '#/components/schemas/gitpod.v1.RunnerEnvironmentSnapshotSpec' description: Spec is the configuration used to create this snapshot title: spec status: $ref: '#/components/schemas/gitpod.v1.RunnerEnvironmentSnapshotStatus' description: Status is the current status of the snapshot title: status title: RunnerEnvironmentSnapshot type: object gitpod.v1.RunnerEnvironmentSnapshotMetadata: additionalProperties: false description: SnapshotMetadata contains metadata about the snapshot properties: createdAt: $ref: '#/components/schemas/google.protobuf.Timestamp' description: created_at is when the snapshot creation was initiated title: created_at environmentId: description: environment_id is the ID of the environment that was snapshotted format: uuid title: environment_id type: string environmentSpec: $ref: '#/components/schemas/gitpod.v1.EnvironmentSpec' description: environment_spec is the specification of the environment that was snapshotted title: environment_spec organizationId: description: organization_id is the ID of the organization that owns the snapshot format: uuid title: organization_id type: string projectId: description: project_id is the ID of the project that the snapshot belongs to format: uuid nullable: true title: project_id type: string runnerId: description: runner_id is the ID of the runner that created the snapshot format: uuid title: runner_id type: string required: - environmentSpec title: RunnerEnvironmentSnapshotMetadata type: object gitpod.v1.RunnerEnvironmentSnapshotPhase: description: SnapshotPhase represents the lifecycle phase of a snapshot enum: - RUNNER_ENVIRONMENT_SNAPSHOT_PHASE_UNSPECIFIED - RUNNER_ENVIRONMENT_SNAPSHOT_PHASE_PENDING - RUNNER_ENVIRONMENT_SNAPSHOT_PHASE_CREATING - RUNNER_ENVIRONMENT_SNAPSHOT_PHASE_AVAILABLE - RUNNER_ENVIRONMENT_SNAPSHOT_PHASE_FAILED - RUNNER_ENVIRONMENT_SNAPSHOT_PHASE_DELETING - RUNNER_ENVIRONMENT_SNAPSHOT_PHASE_DELETED title: RunnerEnvironmentSnapshotPhase type: string gitpod.v1.RunnerEnvironmentSnapshotSpec: additionalProperties: false description: SnapshotSpec specifies the configuration for creating a snapshot properties: desiredPhase: $ref: '#/components/schemas/gitpod.v1.RunnerEnvironmentSnapshotPhase' description: desired_phase specifies the intended lifecycle phase for this snapshot title: desired_phase providerConfig: additionalProperties: title: value type: string description: provider_config contains provider-specific configuration title: provider_config type: object title: RunnerEnvironmentSnapshotSpec type: object gitpod.v1.RunnerEnvironmentSnapshotSpec.ProviderConfigEntry: additionalProperties: false properties: key: title: key type: string value: title: value type: string title: ProviderConfigEntry type: object gitpod.v1.RunnerEnvironmentSnapshotStatus: additionalProperties: false description: SnapshotStatus describes the current status of a snapshot properties: completedAt: $ref: '#/components/schemas/google.protobuf.Timestamp' description: completed_at is when the snapshot creation was completed (if successful) title: completed_at completionPercentage: description: progress contains information about snapshot creation progress format: int32 maximum: 100 title: completion_percentage type: integer failureMessage: description: failure_message contains details about why the snapshot failed title: failure_message type: string logsUrl: description: logs_url is the URL to access the environment logs for this snapshot title: logs_url type: string phase: $ref: '#/components/schemas/gitpod.v1.RunnerEnvironmentSnapshotPhase' description: phase is the current phase of the snapshot lifecycle title: phase providerSnapshot: $ref: '#/components/schemas/gitpod.v1.RunnerEnvironmentSnapshotStatus.ProviderSnapshot' description: provider_snapshot contains provider-specific snapshot details title: provider_snapshot sizeBytes: description: size_bytes is the size of the snapshot in bytes (available when completed) title: size_bytes type: string title: RunnerEnvironmentSnapshotStatus type: object gitpod.v1.RunnerEnvironmentSnapshotStatus.ProviderSnapshot: additionalProperties: false description: ProviderSnapshot contains provider-specific snapshot information properties: providerName: description: provider_name is the name of the cloud provider (e.g., "aws", "gcp", "azure") maxLength: 255 title: provider_name type: string providerSnapshotId: description: provider_snapshot_id is the ID assigned by the cloud provider title: provider_snapshot_id type: string region: description: region is the cloud provider region where the snapshot is stored maxLength: 255 title: region type: string title: ProviderSnapshot type: object gitpod.v1.RunnerKind: description: RunnerKind represents the kind of a runner enum: - RUNNER_KIND_UNSPECIFIED - RUNNER_KIND_LOCAL - RUNNER_KIND_REMOTE - RUNNER_KIND_LOCAL_CONFIGURATION title: RunnerKind type: string gitpod.v1.RunnerManager: additionalProperties: false properties: configuration: $ref: '#/components/schemas/gitpod.v1.RunnerManagerConfiguration' deprecated: true description: 'The runner manager''s configuration (DEPRECATED: Use spec.configuration instead)' title: configuration createdAt: $ref: '#/components/schemas/google.protobuf.Timestamp' description: Time when the RunnerManager was created. title: created_at creator: $ref: '#/components/schemas/gitpod.v1.Subject' description: creator is the identity of the creator of the runner manager title: creator name: description: The runner manager's name which is shown to users minLength: 1 title: name type: string phase: $ref: '#/components/schemas/gitpod.v1.RunnerManagerPhase' deprecated: true description: The current phase of the runner manager title: phase region: description: Region where the runner manager operates minLength: 1 title: region type: string runnerManagerId: title: runner_manager_id type: string spec: $ref: '#/components/schemas/gitpod.v1.RunnerManagerSpec' description: The runner manager's specification title: spec status: $ref: '#/components/schemas/gitpod.v1.RunnerManagerStatus' description: The current status of the runner manager title: status updatedAt: $ref: '#/components/schemas/google.protobuf.Timestamp' description: Time when the RunnerManager was last updated. title: updated_at title: RunnerManager type: object gitpod.v1.RunnerManagerConfiguration: additionalProperties: false properties: collectDebugProfile: description: "When set to true, the runner manager collects pprof profiles and uploads\n them to the logs S3 bucket.\ \ The runner manager resets this flag after\n collection so it acts as a one-shot trigger." title: collect_debug_profile type: boolean llmIntegrationTemplates: items: $ref: '#/components/schemas/gitpod.v1.StaticLLMIntegration' title: llm_integration_templates type: array logLevel: $ref: '#/components/schemas/gitpod.v1.LogLevel' description: log_level is the log level for the runner manager title: log_level metrics: $ref: '#/components/schemas/gitpod.v1.RunnerManagerMetricsConfiguration' description: metrics contains configuration for the runner manager's metrics collection title: metrics releaseChannel: $ref: '#/components/schemas/gitpod.v1.RunnerManagerReleaseChannel' description: The release channel for the runner manager title: release_channel scmIntegrationTemplates: items: $ref: '#/components/schemas/gitpod.v1.StaticSCMIntegration' title: scm_integration_templates type: array title: RunnerManagerConfiguration type: object gitpod.v1.RunnerManagerMetricsConfiguration: additionalProperties: false properties: enabled: description: enabled indicates whether the runner should collect metrics title: enabled type: boolean password: description: password is the password to use for the metrics collector title: password type: string url: description: url is the URL of the metrics collector title: url type: string username: description: username is the username to use for the metrics collector title: username type: string title: RunnerManagerMetricsConfiguration type: object gitpod.v1.RunnerManagerPhase: enum: - RUNNER_MANAGER_PHASE_UNSPECIFIED - RUNNER_MANAGER_PHASE_CREATED - RUNNER_MANAGER_PHASE_ENABLED - RUNNER_MANAGER_PHASE_DISABLED title: RunnerManagerPhase type: string gitpod.v1.RunnerManagerReleaseChannel: enum: - RUNNER_MANAGER_RELEASE_CHANNEL_UNSPECIFIED - RUNNER_MANAGER_RELEASE_CHANNEL_STABLE - RUNNER_MANAGER_RELEASE_CHANNEL_LATEST title: RunnerManagerReleaseChannel type: string gitpod.v1.RunnerManagerSpec: additionalProperties: false properties: configuration: $ref: '#/components/schemas/gitpod.v1.RunnerManagerConfiguration' title: configuration desiredPhase: $ref: '#/components/schemas/gitpod.v1.RunnerManagerPhase' description: The desired phase for the runner manager title: desired_phase title: RunnerManagerSpec type: object gitpod.v1.RunnerManagerStatus: additionalProperties: false properties: phase: $ref: '#/components/schemas/gitpod.v1.RunnerManagerPhase' description: The actual phase of the runner manager as reported by the system title: phase title: RunnerManagerStatus type: object gitpod.v1.RunnerMetricsConfiguration: additionalProperties: false properties: enabled: title: enabled type: boolean encryptedPassword: format: byte title: encrypted_password type: string encryptedUsername: format: byte title: encrypted_username type: string managedMetricsEnabled: description: "When true, the runner pushes metrics to the management plane via\n ReportRunnerMetrics instead of\ \ directly to the remote_write endpoint." title: managed_metrics_enabled type: boolean url: title: url type: string title: RunnerMetricsConfiguration type: object gitpod.v1.RunnerPhase: description: RunnerPhase represents the phase a runner is in enum: - RUNNER_PHASE_UNSPECIFIED - RUNNER_PHASE_CREATED - RUNNER_PHASE_INACTIVE - RUNNER_PHASE_ACTIVE - RUNNER_PHASE_DELETING - RUNNER_PHASE_DELETED - RUNNER_PHASE_DEGRADED title: RunnerPhase type: string gitpod.v1.RunnerPolicy: additionalProperties: false properties: groupId: format: uuid title: group_id type: string role: $ref: '#/components/schemas/gitpod.v1.RunnerRole' description: role is the role assigned to the group title: role title: RunnerPolicy type: object gitpod.v1.RunnerProvider: description: "RunnerProvider identifies the specific implementation type of a runner.\n Each provider maps to a specific\ \ kind of runner (local or remote), as\n specified below for each provider." enum: - RUNNER_PROVIDER_UNSPECIFIED - RUNNER_PROVIDER_AWS_EC2 - RUNNER_PROVIDER_LINUX_HOST - RUNNER_PROVIDER_DESKTOP_MAC - RUNNER_PROVIDER_MANAGED - RUNNER_PROVIDER_GCP - RUNNER_PROVIDER_DEV_AGENT title: RunnerProvider type: string gitpod.v1.RunnerReleaseChannel: enum: - RUNNER_RELEASE_CHANNEL_UNSPECIFIED - RUNNER_RELEASE_CHANNEL_STABLE - RUNNER_RELEASE_CHANNEL_LATEST title: RunnerReleaseChannel type: string gitpod.v1.RunnerRole: enum: - RUNNER_ROLE_UNSPECIFIED - RUNNER_ROLE_ADMIN - RUNNER_ROLE_USER title: RunnerRole type: string gitpod.v1.RunnerSideAgentSpec: additionalProperties: false properties: preferredModels: description: "Ordered list of models the runner should try when creating an LLM client.\n Populated by the backend\ \ based on org tier. If empty, the runner falls\n back to its built-in PreferredModels list (backward compatibility)." items: $ref: '#/components/schemas/gitpod.v1.SupportedModel' title: preferred_models type: array prompts: description: The prompts configuration for each supported model. One cannot have multiple prompts for the same model - this will return an invalid argument error. items: $ref: '#/components/schemas/gitpod.v1.RunnerSideAgentSpec.Prompts' title: prompts type: array requiredTools: description: The list of tools required by this agent to function items: type: string title: required_tools type: array title: RunnerSideAgentSpec type: object gitpod.v1.RunnerSideAgentSpec.Prompts: additionalProperties: false properties: improvePrompt: description: The prompt used to improve the agent's prompt title: improve_prompt type: string initialMessage: description: The initial message sent to the user. If empty, the agent will start in WAITING_FOR_INPUT state title: initial_message type: string judgementPrompt: description: The prompt used to evaluate agent's performance and provide final assessment title: judgement_prompt type: string model: $ref: '#/components/schemas/gitpod.v1.SupportedModel' description: The model these prompts are for title: model systemPrompt: description: The system prompt that defines the agent's role and capabilities title: system_prompt type: string title: Prompts type: object gitpod.v1.RunnerSpec: additionalProperties: false properties: configuration: $ref: '#/components/schemas/gitpod.v1.RunnerConfiguration' description: The runner's configuration title: configuration desiredPhase: $ref: '#/components/schemas/gitpod.v1.RunnerPhase' title: desired_phase variant: $ref: '#/components/schemas/gitpod.v1.RunnerVariant' description: The runner's variant title: variant title: RunnerSpec type: object gitpod.v1.RunnerStatus: additionalProperties: false description: RunnerStatus represents the status of a runner properties: additionalInfo: description: "additional_info contains additional information about the runner,\n e.g. a CloudFormation stack URL." items: $ref: '#/components/schemas/gitpod.v1.FieldValue' title: additional_info type: array capabilities: description: capabilities is a list of capabilities the runner supports. items: $ref: '#/components/schemas/gitpod.v1.RunnerCapability' title: capabilities type: array gatewayInfo: $ref: '#/components/schemas/gitpod.v1.GatewayInfo' description: gateway_info is information about the gateway to which the runner is connected. title: gateway_info llmUrl: description: llm_url is the URL of the LLM service to which the runner is connected. title: llm_url type: string logUrl: title: log_url type: string message: description: "The runner's reported message which is shown to users.\n This message adds more context to the runner's\ \ phase." title: message type: string phase: $ref: '#/components/schemas/gitpod.v1.RunnerPhase' description: The runner's reported phase title: phase publicKey: description: public_key is the runner's public key used for encryption (32 bytes) format: byte maxLength: 32 minLength: 32 title: public_key type: string region: description: region is the region the runner is running in, if applicable. title: region type: string supportBundleUrl: description: "support_bundle_url is the URL at which the runner support bundle can be accessed.\n This URL provides\ \ access to pprof profiles and other debug information.\n Only available for standalone runners." title: support_bundle_url type: string systemDetails: title: system_details type: string updatedAt: $ref: '#/components/schemas/google.protobuf.Timestamp' description: Time when the status was last updated. title: updated_at version: title: version type: string title: RunnerStatus type: object gitpod.v1.RunnerVariant: enum: - RUNNER_VARIANT_UNSPECIFIED - RUNNER_VARIANT_STANDARD - RUNNER_VARIANT_ENTERPRISE title: RunnerVariant type: string gitpod.v1.RunsOn: additionalProperties: false oneOf: - not: anyOf: - required: - machine - required: - terminal required: - docker - not: anyOf: - required: - docker - required: - terminal required: - machine - not: anyOf: - required: - docker - required: - machine required: - terminal properties: docker: $ref: '#/components/schemas/gitpod.v1.RunsOn.Docker' title: docker machine: $ref: '#/components/schemas/gitpod.v1.RunsOn.Machine' title: machine terminal: $ref: '#/components/schemas/gitpod.v1.RunsOn.Terminal' title: terminal title: RunsOn type: object gitpod.v1.RunsOn.Docker: additionalProperties: false properties: environment: items: type: string title: environment type: array image: minLength: 1 title: image type: string title: Docker type: object gitpod.v1.RunsOn.Machine: additionalProperties: false description: Machine runs the service/task directly on the VM/machine level. title: Machine type: object gitpod.v1.RunsOn.Terminal: additionalProperties: false description: "Terminal runs the service inside a managed PTY terminal in the devcontainer.\n Users can attach to the\ \ terminal interactively via the terminal API." title: Terminal type: object gitpod.v1.SCIMConfiguration: additionalProperties: false description: SCIMConfiguration represents a SCIM 2.0 provisioning configuration properties: createdAt: $ref: '#/components/schemas/google.protobuf.Timestamp' description: created_at is when the SCIM configuration was created title: created_at enabled: description: enabled indicates if SCIM provisioning is active title: enabled type: boolean id: description: id is the unique identifier of the SCIM configuration format: uuid title: id type: string name: description: name is a human-readable name for the SCIM configuration maxLength: 128 title: name type: string organizationId: description: organization_id is the ID of the organization this SCIM configuration belongs to format: uuid title: organization_id type: string ssoConfigurationId: description: sso_configuration_id is the linked SSO configuration (optional) format: uuid title: sso_configuration_id type: string tokenExpiresAt: $ref: '#/components/schemas/google.protobuf.Timestamp' description: token_expires_at is when the current SCIM token expires title: token_expires_at updatedAt: $ref: '#/components/schemas/google.protobuf.Timestamp' description: updated_at is when the SCIM configuration was last updated title: updated_at required: - id - organizationId - createdAt - updatedAt - tokenExpiresAt title: SCIMConfiguration type: object gitpod.v1.SCMContext: additionalProperties: false properties: email: title: email type: string host: title: host type: string remoteUri: title: remote_uri type: string token: title: token type: string username: title: username type: string title: SCMContext type: object gitpod.v1.SCMIntegration: additionalProperties: false properties: host: title: host type: string id: description: id is the unique identifier of the SCM integration title: id type: string oauth: $ref: '#/components/schemas/gitpod.v1.SCMIntegrationOAuthConfig' nullable: true title: oauth pat: title: pat type: boolean runnerId: title: runner_id type: string scmId: description: scm_id references the scm_id in the runner's configuration schema that this integration is for title: scm_id type: string virtualDirectory: description: "virtual_directory is the virtual directory path for Azure DevOps Server (e.g., \"/tfs\").\n This field\ \ is only used for Azure DevOps Server SCM integrations and should be empty for other SCM types.\n Azure DevOps\ \ Server APIs work without collection when PAT scope is 'All accessible organizations'." nullable: true title: virtual_directory type: string title: SCMIntegration type: object gitpod.v1.SCMIntegrationOAuthConfig: additionalProperties: false properties: clientId: description: client_id is the OAuth app's client ID in clear text. title: client_id type: string encryptedClientSecret: description: encrypted_client_secret is the OAuth app's secret encrypted with the runner's public key. format: byte title: encrypted_client_secret type: string issuerUrl: description: "issuer_url is used to override the authentication provider URL, if it doesn't match the SCM host.\n\ \n +optional if not set, this account is owned by the installation." title: issuer_url type: string title: SCMIntegrationOAuthConfig type: object gitpod.v1.SCMIntegrationValidationResult: additionalProperties: false properties: hostError: nullable: true title: host_error type: string oauthError: nullable: true title: oauth_error type: string patError: nullable: true title: pat_error type: string scmIdError: nullable: true title: scm_id_error type: string valid: title: valid type: boolean title: SCMIntegrationValidationResult type: object gitpod.v1.SSOConfiguration: additionalProperties: false properties: additionalScopes: description: additional_scopes are extra OIDC scopes requested from the identity provider during sign-in. items: type: string title: additional_scopes type: array claims: additionalProperties: title: value type: string description: claims are key/value pairs that defines a mapping of claims issued by the IdP. title: claims type: object claimsExpression: description: "claims_expression is a CEL (Common Expression Language) expression evaluated against\n the OIDC token\ \ claims during login. When set, the expression must evaluate to true\n for the login to succeed. The expression\ \ has access to a `claims` variable containing\n all token claims as a map. Example: `claims.email_verified &&\ \ claims.email.endsWith(\"@example.com\")`" maxLength: 4096 title: claims_expression type: string clientId: description: client_id is the client ID of the OIDC application set on the IdP title: client_id type: string displayName: maxLength: 128 title: display_name type: string emailDomain: title: email_domain type: string emailDomains: items: maxLength: 253 minLength: 4 pattern: ^(?:[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?\.)+[a-zA-Z]{2,}$ type: string uniqueItems: true title: email_domains type: array uniqueItems: true id: description: id is the unique identifier of the SSO configuration format: uuid title: id type: string issuerUrl: description: issuer_url is the URL of the IdP issuer title: issuer_url type: string organizationId: format: uuid title: organization_id type: string providerType: $ref: '#/components/schemas/gitpod.v1.SSOConfiguration.ProviderType' description: provider_type defines the type of the SSO configuration title: provider_type state: $ref: '#/components/schemas/gitpod.v1.SSOConfigurationState' description: state is the state of the SSO configuration title: state required: - id - organizationId - issuerUrl - state - providerType title: SSOConfiguration type: object gitpod.v1.SSOConfiguration.ClaimsEntry: additionalProperties: false properties: key: title: key type: string value: title: value type: string title: ClaimsEntry type: object gitpod.v1.SSOConfiguration.ProviderType: enum: - PROVIDER_TYPE_UNSPECIFIED - PROVIDER_TYPE_BUILTIN - PROVIDER_TYPE_CUSTOM title: ProviderType type: string gitpod.v1.SSOConfigurationState: enum: - SSO_CONFIGURATION_STATE_UNSPECIFIED - SSO_CONFIGURATION_STATE_INACTIVE - SSO_CONFIGURATION_STATE_ACTIVE title: SSOConfigurationState type: string gitpod.v1.ScmProvider: description: ScmProvider identifies the SCM platform a pull request was fetched from. enum: - SCM_PROVIDER_UNSPECIFIED - SCM_PROVIDER_GITHUB - SCM_PROVIDER_GITLAB - SCM_PROVIDER_BITBUCKET title: ScmProvider type: string gitpod.v1.SearchMode: enum: - SEARCH_MODE_UNSPECIFIED - SEARCH_MODE_KEYWORD - SEARCH_MODE_NATIVE title: SearchMode type: string gitpod.v1.SearchRepositoriesRequest: additionalProperties: false properties: limit: deprecated: true description: "Maximum number of repositories to return.\n Default: 25, Maximum: 100\n Deprecated: Use pagination.page_size\ \ instead" format: int32 maximum: 100 minimum: 1 title: limit type: integer pagination: $ref: '#/components/schemas/gitpod.v1.PaginationRequest' description: Pagination parameters for repository search title: pagination runnerId: format: uuid title: runner_id type: string scmHost: description: The SCM's host to retrieve repositories from title: scm_host type: string searchMode: $ref: '#/components/schemas/gitpod.v1.SearchMode' description: Search mode determines how search_string is interpreted title: search_mode searchString: description: Search query - interpretation depends on search_mode title: search_string type: string title: SearchRepositoriesRequest type: object gitpod.v1.SearchRepositoriesResponse: additionalProperties: false properties: lastPage: description: 'Deprecated: Use pagination token instead. Total pages can be extracted from token.' format: int32 title: last_page type: integer pagination: $ref: '#/components/schemas/gitpod.v1.PaginationResponse' description: "Pagination information for the response.\n Token format: \"NEXT_PAGE/TOTAL_PAGES/TOTAL_COUNT\" (e.g.,\ \ \"2/40/1000\").\n Use -1 for unknown values (e.g., \"2/-1/-1\" when totals unavailable).\n Empty token means\ \ no more pages." title: pagination repositories: description: List of repositories matching the search criteria items: $ref: '#/components/schemas/gitpod.v1.SearchRepositoriesResponse.Repository' title: repositories type: array title: SearchRepositoriesResponse type: object gitpod.v1.SearchRepositoriesResponse.Repository: additionalProperties: false properties: name: description: Repository name (e.g., "my-project") title: name type: string url: description: Repository URL (e.g., "https://github.com/owner/my-project") title: url type: string title: Repository type: object gitpod.v1.Secret: additionalProperties: false oneOf: - not: anyOf: - required: - containerRegistryBasicAuthHost - required: - environmentVariable - required: - filePath required: - apiOnly - not: anyOf: - required: - apiOnly - required: - environmentVariable - required: - filePath required: - containerRegistryBasicAuthHost - not: anyOf: - required: - apiOnly - required: - containerRegistryBasicAuthHost - required: - filePath required: - environmentVariable - not: anyOf: - required: - apiOnly - required: - containerRegistryBasicAuthHost - required: - environmentVariable required: - filePath properties: apiOnly: description: api_only indicates the secret is only available via API/CLI title: api_only type: boolean containerRegistryBasicAuthHost: description: secret will be mounted as a registry secret format: uri title: container_registry_basic_auth_host type: string createdAt: $ref: '#/components/schemas/google.protobuf.Timestamp' title: created_at creator: $ref: '#/components/schemas/gitpod.v1.Subject' description: creator is the identity of the creator of the secret title: creator environmentVariable: description: secret will be created as an Environment Variable with the same name as the secret title: environment_variable type: boolean filePath: description: absolute path to the file where the secret is mounted title: file_path type: string id: format: uuid title: id type: string name: description: Name of the secret for humans. title: name type: string projectId: deprecated: true description: "The Project ID this Secret belongs to\n Deprecated: use scope instead" format: uuid title: project_id type: string scope: $ref: '#/components/schemas/gitpod.v1.SecretScope' title: scope updatedAt: $ref: '#/components/schemas/google.protobuf.Timestamp' title: updated_at title: Secret type: object gitpod.v1.SecretRef: additionalProperties: false description: SecretRef references a secret by its ID. properties: id: description: id is the UUID of the secret to reference. format: uuid title: id type: string title: SecretRef type: object gitpod.v1.SecretScope: additionalProperties: false oneOf: - not: anyOf: - required: - projectId - required: - serviceAccountId - required: - userId required: - organizationId - not: anyOf: - required: - organizationId - required: - serviceAccountId - required: - userId required: - projectId - not: anyOf: - required: - organizationId - required: - projectId - required: - userId required: - serviceAccountId - not: anyOf: - required: - organizationId - required: - projectId - required: - serviceAccountId required: - userId properties: organizationId: description: organization_id is the Organization ID this Secret belongs to format: uuid title: organization_id type: string projectId: description: project_id is the Project ID this Secret belongs to format: uuid title: project_id type: string serviceAccountId: description: service_account_id is the Service Account ID this Secret belongs to format: uuid title: service_account_id type: string userId: description: user_id is the User ID this Secret belongs to format: uuid title: user_id type: string title: SecretScope type: object gitpod.v1.SecurityAgentPolicy: additionalProperties: false description: "SecurityAgentPolicy contains security agent configuration for an organization.\n When enabled, security\ \ agents are automatically deployed to all environments." properties: crowdstrike: $ref: '#/components/schemas/gitpod.v1.CrowdStrikeConfig' description: crowdstrike contains CrowdStrike Falcon configuration title: crowdstrike customAgents: description: custom_agents contains custom security agent definitions items: $ref: '#/components/schemas/gitpod.v1.CustomSecurityAgent' title: custom_agents type: array x-stainless-skip: true title: SecurityAgentPolicy type: object gitpod.v1.SendResponseRequest: additionalProperties: false oneOf: - not: anyOf: - required: - callCheckRepositoryAccess - required: - callImprovePromptForAgent - required: - callListScmOrganizations - required: - callParseContext - required: - callPing - required: - callSearchRepositories - required: - callSendMessageToAgentExecution - required: - callValidateConfig - required: - error required: - callCheckAuthenticationForHost - not: anyOf: - required: - callCheckAuthenticationForHost - required: - callImprovePromptForAgent - required: - callListScmOrganizations - required: - callParseContext - required: - callPing - required: - callSearchRepositories - required: - callSendMessageToAgentExecution - required: - callValidateConfig - required: - error required: - callCheckRepositoryAccess - not: anyOf: - required: - callCheckAuthenticationForHost - required: - callCheckRepositoryAccess - required: - callListScmOrganizations - required: - callParseContext - required: - callPing - required: - callSearchRepositories - required: - callSendMessageToAgentExecution - required: - callValidateConfig - required: - error required: - callImprovePromptForAgent - not: anyOf: - required: - callCheckAuthenticationForHost - required: - callCheckRepositoryAccess - required: - callImprovePromptForAgent - required: - callParseContext - required: - callPing - required: - callSearchRepositories - required: - callSendMessageToAgentExecution - required: - callValidateConfig - required: - error required: - callListScmOrganizations - not: anyOf: - required: - callCheckAuthenticationForHost - required: - callCheckRepositoryAccess - required: - callImprovePromptForAgent - required: - callListScmOrganizations - required: - callPing - required: - callSearchRepositories - required: - callSendMessageToAgentExecution - required: - callValidateConfig - required: - error required: - callParseContext - not: anyOf: - required: - callCheckAuthenticationForHost - required: - callCheckRepositoryAccess - required: - callImprovePromptForAgent - required: - callListScmOrganizations - required: - callParseContext - required: - callSearchRepositories - required: - callSendMessageToAgentExecution - required: - callValidateConfig - required: - error required: - callPing - not: anyOf: - required: - callCheckAuthenticationForHost - required: - callCheckRepositoryAccess - required: - callImprovePromptForAgent - required: - callListScmOrganizations - required: - callParseContext - required: - callPing - required: - callSendMessageToAgentExecution - required: - callValidateConfig - required: - error required: - callSearchRepositories - not: anyOf: - required: - callCheckAuthenticationForHost - required: - callCheckRepositoryAccess - required: - callImprovePromptForAgent - required: - callListScmOrganizations - required: - callParseContext - required: - callPing - required: - callSearchRepositories - required: - callValidateConfig - required: - error required: - callSendMessageToAgentExecution - not: anyOf: - required: - callCheckAuthenticationForHost - required: - callCheckRepositoryAccess - required: - callImprovePromptForAgent - required: - callListScmOrganizations - required: - callParseContext - required: - callPing - required: - callSearchRepositories - required: - callSendMessageToAgentExecution - required: - error required: - callValidateConfig - not: anyOf: - required: - callCheckAuthenticationForHost - required: - callCheckRepositoryAccess - required: - callImprovePromptForAgent - required: - callListScmOrganizations - required: - callParseContext - required: - callPing - required: - callSearchRepositories - required: - callSendMessageToAgentExecution - required: - callValidateConfig required: - error properties: callCheckAuthenticationForHost: $ref: '#/components/schemas/gitpod.v1.CallCheckAuthenticationForHost.Response' title: call_check_authentication_for_host callCheckRepositoryAccess: $ref: '#/components/schemas/gitpod.v1.CallCheckRepositoryAccess.Response' title: call_check_repository_access callImprovePromptForAgent: $ref: '#/components/schemas/gitpod.v1.CallImprovePromptForAgent.Response' title: call_improve_prompt_for_agent callListScmOrganizations: $ref: '#/components/schemas/gitpod.v1.CallListSCMOrganizations.Response' title: call_list_scm_organizations callParseContext: $ref: '#/components/schemas/gitpod.v1.CallParseContext.Response' title: call_parse_context callPing: $ref: '#/components/schemas/gitpod.v1.CallPing.Response' title: call_ping callSearchRepositories: $ref: '#/components/schemas/gitpod.v1.CallSearchRepositories.Response' title: call_search_repositories callSendMessageToAgentExecution: $ref: '#/components/schemas/gitpod.v1.CallSendMessageToAgentExecution.Response' title: call_send_message_to_agent_execution callValidateConfig: $ref: '#/components/schemas/gitpod.v1.CallValidateConfig.Response' title: call_validate_config error: $ref: '#/components/schemas/gitpod.v1.SendResponseRequest.CallError' title: error requestId: description: The request's ID we're responding to format: uuid title: request_id type: string runnerId: description: The runner's identity format: uuid title: runner_id type: string title: SendResponseRequest type: object gitpod.v1.SendResponseRequest.CallError: additionalProperties: false properties: code: $ref: '#/components/schemas/gitpod.v1.SendResponseRequest.ErrorCode' description: The error's code title: code details: description: Error details items: $ref: '#/components/schemas/google.protobuf.Any' title: details type: array message: description: The error's message title: message type: string title: CallError type: object gitpod.v1.SendResponseRequest.ErrorCode: enum: - ERROR_CODE_UNSPECIFIED - ERROR_CODE_CANCELED - ERROR_CODE_INVALID_ARGUMENT - ERROR_CODE_DEADLINE_EXCEEDED - ERROR_CODE_NOT_FOUND - ERROR_CODE_ALREADY_EXISTS - ERROR_CODE_PERMISSION_DENIED - ERROR_CODE_RESOURCE_EXHAUSTED - ERROR_CODE_FAILED_PRECONDITION - ERROR_CODE_UNIMPLEMENTED - ERROR_CODE_UNAVAILABLE - ERROR_CODE_UNAUTHENTICATED title: ErrorCode type: string gitpod.v1.SendResponseResponse: additionalProperties: false title: SendResponseResponse type: object gitpod.v1.SendToAgentExecutionRequest: additionalProperties: false oneOf: - not: anyOf: - required: - userInput - required: - wakeEvent required: - agentMessage - not: anyOf: - required: - agentMessage - required: - wakeEvent required: - userInput - not: anyOf: - required: - agentMessage - required: - userInput required: - wakeEvent properties: agentExecutionId: format: uuid title: agent_execution_id type: string agentMessage: $ref: '#/components/schemas/gitpod.v1.AgentMessage' title: agent_message userInput: $ref: '#/components/schemas/gitpod.v1.UserInputBlock' title: user_input wakeEvent: $ref: '#/components/schemas/gitpod.v1.WakeEvent' title: wake_event title: SendToAgentExecutionRequest type: object gitpod.v1.SendToAgentExecutionResponse: additionalProperties: false title: SendToAgentExecutionResponse type: object gitpod.v1.Service: additionalProperties: false properties: environmentId: format: uuid title: environment_id type: string id: format: uuid title: id type: string metadata: $ref: '#/components/schemas/gitpod.v1.ServiceMetadata' title: metadata spec: $ref: '#/components/schemas/gitpod.v1.ServiceSpec' title: spec status: $ref: '#/components/schemas/gitpod.v1.ServiceStatus' title: status required: - id - environment_id title: Service type: object gitpod.v1.ServiceAccount: additionalProperties: false properties: createdAt: $ref: '#/components/schemas/google.protobuf.Timestamp' title: created_at creator: $ref: '#/components/schemas/gitpod.v1.Subject' title: creator description: title: description type: string id: format: uuid title: id type: string name: title: name type: string organizationId: format: uuid title: organization_id type: string suspended: description: "suspended indicates whether the service account has been deleted (soft-delete).\n Suspended service\ \ accounts cannot be used for authentication." title: suspended type: boolean validUntil: $ref: '#/components/schemas/google.protobuf.Timestamp' title: valid_until title: ServiceAccount type: object gitpod.v1.ServiceAccountToken: additionalProperties: false description: "ServiceAccountToken represents metadata about a service account token.\n The actual token value is only\ \ returned once during creation." properties: createdAt: $ref: '#/components/schemas/google.protobuf.Timestamp' title: created_at creator: $ref: '#/components/schemas/gitpod.v1.Subject' title: creator description: title: description type: string expiresAt: $ref: '#/components/schemas/google.protobuf.Timestamp' title: expires_at id: format: uuid title: id type: string lastUsed: $ref: '#/components/schemas/google.protobuf.Timestamp' title: last_used serviceAccountId: format: uuid title: service_account_id type: string title: ServiceAccountToken type: object gitpod.v1.ServiceMetadata: additionalProperties: false properties: createdAt: $ref: '#/components/schemas/google.protobuf.Timestamp' description: created_at is the time the service was created. title: created_at creator: $ref: '#/components/schemas/gitpod.v1.Subject' description: creator describes the principal who created the service. title: creator description: description: description is a user-facing description for the service. It can be used to provide context and documentation for the service. title: description type: string name: description: "name is a user-facing name for the service. Unlike the reference, this field is not unique, and not\ \ referenced by the system.\n This is a short descriptive name for the service." minLength: 1 title: name type: string reference: description: "reference is a user-facing identifier for the service which must be unique on the environment.\n It\ \ is used to express dependencies between services, and to identify the service in user interactions (e.g. the\ \ CLI)." pattern: ^[a-zA-Z0-9_-]{1,128}$ title: reference type: string role: $ref: '#/components/schemas/gitpod.v1.ServiceRole' description: role specifies the intended role or purpose of the service. title: role triggeredBy: description: triggered_by is a list of trigger that start the service. items: $ref: '#/components/schemas/gitpod.v1.AutomationTrigger' title: triggered_by type: array title: ServiceMetadata type: object gitpod.v1.ServicePhase: enum: - SERVICE_PHASE_UNSPECIFIED - SERVICE_PHASE_STARTING - SERVICE_PHASE_RUNNING - SERVICE_PHASE_STOPPING - SERVICE_PHASE_STOPPED - SERVICE_PHASE_FAILED - SERVICE_PHASE_DELETED title: ServicePhase type: string gitpod.v1.ServiceRole: enum: - SERVICE_ROLE_UNSPECIFIED - SERVICE_ROLE_DEFAULT - SERVICE_ROLE_EDITOR - SERVICE_ROLE_AI_AGENT - SERVICE_ROLE_SECURITY_AGENT title: ServiceRole type: string gitpod.v1.ServiceSpec: additionalProperties: false properties: commands: $ref: '#/components/schemas/gitpod.v1.ServiceSpec.Commands' description: commands contains the commands to start, stop and check the readiness of the service title: commands desiredPhase: $ref: '#/components/schemas/gitpod.v1.ServicePhase' description: desired_phase is the phase the service should be in. Used to start or stop the service. title: desired_phase env: description: env specifies environment variables for the service. items: $ref: '#/components/schemas/gitpod.v1.EnvironmentVariableItem' title: env type: array runsOn: $ref: '#/components/schemas/gitpod.v1.RunsOn' description: runs_on specifies the environment the service should run on. title: runs_on session: description: "session should be changed to trigger a restart of the service. If a service exits it will\n not be\ \ restarted until the session is changed." title: session type: string specVersion: description: "version of the spec. The value of this field has no semantic\n meaning (e.g. don't interpret it as\ \ as a timestamp),\n but it can be used to impose a partial order. If a.spec_version <\n b.spec_version then a\ \ was the spec before b." title: spec_version type: string title: ServiceSpec type: object gitpod.v1.ServiceSpec.Commands: additionalProperties: false properties: ready: description: "ready is an optional command that is run repeatedly until it exits with a zero exit code.\n If set,\ \ the service will first go into a Starting phase, and then into a Running phase once the ready\n command exits\ \ with a zero exit code." title: ready type: string start: description: "start is the command to start and run the service.\n If start exits, the service will transition to\ \ the following phase:\n - Stopped: if the exit code is 0\n - Failed: if the exit code is not 0\n If the stop\ \ command is not set, the start command will receive a SIGTERM signal when the service is\n requested to stop.\ \ If it does not exit within 2 minutes, it will receive a SIGKILL signal." minLength: 1 title: start type: string stop: description: "stop is an optional command that runs when the service is requested to stop.\n If set, instead of\ \ sending a SIGTERM signal to the start command, the stop command will be run.\n Once the stop command exits,\ \ the start command will receive a SIGKILL signal.\n If the stop command exits with a non-zero exit code, the\ \ service will transition to the Failed phase.\n If the stop command does not exit within 2 minutes, a SIGKILL\ \ signal will be sent to both the start and\n stop commands." title: stop type: string title: Commands type: object gitpod.v1.ServiceStatus: additionalProperties: false properties: failureMessage: description: "failure_message summarises why the service failed to operate. If this is non-empty\n the service has\ \ failed to operate and will likely transition to a failed state." title: failure_message type: string logUrl: description: log_url contains the URL at which the service logs can be accessed. title: log_url type: string output: additionalProperties: maxLength: 4096 title: value type: string description: "output contains the output of the service.\n setting an output field to empty string will unset it." title: output type: object phase: $ref: '#/components/schemas/gitpod.v1.ServicePhase' description: phase is the current phase of the service. title: phase session: description: session is the current session of the service. title: session type: string statusVersion: description: "version of the status update. Service instances themselves are\n unversioned, but their status has\ \ different versions. The value of this\n field has no semantic meaning (e.g. don't interpret it as as a timestamp),\n\ \ but it can be used to impose a partial order. If a.status_version <\n b.status_version then a was the status\ \ before b." title: status_version type: string title: ServiceStatus type: object gitpod.v1.ServiceStatus.OutputEntry: additionalProperties: false properties: key: title: key type: string value: title: value type: string title: OutputEntry type: object gitpod.v1.Session: additionalProperties: false properties: description: title: description type: string id: title: id type: string name: title: name type: string orchestratorAgentExecutionId: description: "orchestrator_agent_execution_id is the agent execution that drives this session's name.\n The first\ \ agent execution linked to a session becomes its orchestrator." title: orchestrator_agent_execution_id type: string phase: $ref: '#/components/schemas/gitpod.v1.SessionPhase' title: phase resources: items: $ref: '#/components/schemas/gitpod.v1.SessionResource' title: resources type: array title: Session type: object gitpod.v1.SessionPhase: enum: - SESSION_PHASE_UNSPECIFIED - SESSION_PHASE_ACTIVE - SESSION_PHASE_ARCHIVED title: SessionPhase type: string gitpod.v1.SessionResource: additionalProperties: false properties: description: nullable: true title: description type: string id: title: id type: string kind: $ref: '#/components/schemas/gitpod.v1.SessionResourceKind' title: kind role: $ref: '#/components/schemas/gitpod.v1.SessionResourceRole' title: role title: nullable: true title: title type: string url: nullable: true title: url type: string title: SessionResource type: object gitpod.v1.SessionResourceKind: enum: - SESSION_RESOURCE_KIND_UNSPECIFIED - SESSION_RESOURCE_KIND_ISSUE - SESSION_RESOURCE_KIND_PULL_REQUEST - SESSION_RESOURCE_KIND_DOCUMENTATION title: SessionResourceKind type: string gitpod.v1.SessionResourceRole: enum: - SESSION_RESOURCE_ROLE_UNSPECIFIED - SESSION_RESOURCE_ROLE_OWNED - SESSION_RESOURCE_ROLE_PRIMARY - SESSION_RESOURCE_ROLE_SUBAGENT - SESSION_RESOURCE_ROLE_FIXES - SESSION_RESOURCE_ROLE_BLOCKED_BY - SESSION_RESOURCE_ROLE_BLOCKS - SESSION_RESOURCE_ROLE_REVIEWS - SESSION_RESOURCE_ROLE_CREATED - SESSION_RESOURCE_ROLE_REFERENCES title: SessionResourceRole type: string gitpod.v1.SetBillingAddressRequest: additionalProperties: false properties: address: $ref: '#/components/schemas/gitpod.v1.BillingAddress' description: address is the billing address details title: address name: description: name is the name associated with the billing address maxLength: 255 minLength: 1 title: name type: string organizationId: description: organization_id is the ID of the organization to set billing address for format: uuid title: organization_id type: string required: - organizationId - name - address title: SetBillingAddressRequest type: object gitpod.v1.SetBillingAddressResponse: additionalProperties: false title: SetBillingAddressResponse type: object gitpod.v1.SetBillingRealmRequest: additionalProperties: false properties: organizationId: description: organization_id is the ID of the organization to update format: uuid title: organization_id type: string realm: $ref: '#/components/schemas/gitpod.v1.BillingRealm' description: realm is the new billing realm to set for the organization title: realm required: - organizationId - realm title: SetBillingRealmRequest type: object gitpod.v1.SetBillingRealmResponse: additionalProperties: false title: SetBillingRealmResponse type: object gitpod.v1.SetDotfilesConfigurationRequest: additionalProperties: false properties: repository: format: uri maxLength: 255 title: repository type: string title: SetDotfilesConfigurationRequest type: object gitpod.v1.SetDotfilesConfigurationResponse: additionalProperties: false title: SetDotfilesConfigurationResponse type: object gitpod.v1.SetOrganizationCreditGrantRequest: additionalProperties: false properties: creditGrant: description: credit_grant is the contracted credit grant in whole credits. Must be >= 0. title: credit_grant type: string organizationId: format: uuid title: organization_id type: string required: - organizationId - creditGrant title: SetOrganizationCreditGrantRequest type: object gitpod.v1.SetOrganizationCreditGrantResponse: additionalProperties: false title: SetOrganizationCreditGrantResponse type: object gitpod.v1.SetPreferenceRequest: additionalProperties: false properties: key: maxLength: 255 minLength: 1 title: key type: string value: description: "omitting value field will cause an error due to min_len validation,\n to unset a preference use DeletePreference\ \ instead" maxLength: 10240 minLength: 1 title: value type: string title: SetPreferenceRequest type: object gitpod.v1.SetPreferenceResponse: additionalProperties: false title: SetPreferenceResponse type: object gitpod.v1.SetRoleRequest: additionalProperties: false properties: organizationId: format: uuid title: organization_id type: string role: $ref: '#/components/schemas/gitpod.v1.OrganizationRole' title: role userId: format: uuid title: user_id type: string required: - organizationId - userId title: SetRoleRequest type: object gitpod.v1.SetRoleResponse: additionalProperties: false title: SetRoleResponse type: object gitpod.v1.SetStripeCustomerIDRequest: additionalProperties: false properties: organizationId: description: organization_id is the ID of the organization to update format: uuid title: organization_id type: string stripeCustomerId: description: stripe_customer_id is the Stripe customer ID to associate with the organization minLength: 1 title: stripe_customer_id type: string required: - organizationId - stripeCustomerId title: SetStripeCustomerIDRequest type: object gitpod.v1.SetStripeCustomerIDResponse: additionalProperties: false title: SetStripeCustomerIDResponse type: object gitpod.v1.SetSuspendedRequest: additionalProperties: false properties: suspended: title: suspended type: boolean userId: format: uuid title: user_id type: string title: SetSuspendedRequest type: object gitpod.v1.SetSuspendedResponse: additionalProperties: false title: SetSuspendedResponse type: object gitpod.v1.SetTaxIDRequest: additionalProperties: false properties: organizationId: description: organization_id is the ID of the organization to set tax ID for format: uuid title: organization_id type: string taxIdType: description: tax_id_type is the type of tax ID (e.g., "eu_vat", "us_ein", "gb_vat") minLength: 1 title: tax_id_type type: string taxIdValue: description: tax_id_value is the tax ID value minLength: 1 title: tax_id_value type: string required: - organizationId - taxIdType - taxIdValue title: SetTaxIDRequest type: object gitpod.v1.SetTaxIDResponse: additionalProperties: false title: SetTaxIDResponse type: object gitpod.v1.SetTierRequest: additionalProperties: false properties: organizationId: description: organization_id is the ID of the organization to update format: uuid title: organization_id type: string tier: $ref: '#/components/schemas/gitpod.v1.OrganizationTier' description: tier is the new tier to set for the organization title: tier required: - organizationId - tier title: SetTierRequest type: object gitpod.v1.SetTierResponse: additionalProperties: false title: SetTierResponse type: object gitpod.v1.SetupBillingRequest: additionalProperties: false properties: organizationId: description: organization_id is the ID of the organization to update format: uuid title: organization_id type: string required: - organizationId title: SetupBillingRequest type: object gitpod.v1.SetupBillingResponse: additionalProperties: false properties: customerSessionClientSecret: description: customer_session_client_secret is the client secret for the Stripe CustomerSession title: customer_session_client_secret type: string setupIntentClientSecret: description: setup_intent_client_secret is the client secret for the Stripe SetupIntent title: setup_intent_client_secret type: string required: - setupIntentClientSecret - customerSessionClientSecret title: SetupBillingResponse type: object gitpod.v1.SetupEnterpriseBillingRequest: additionalProperties: false properties: contractStartDate: $ref: '#/components/schemas/google.protobuf.Timestamp' description: "contract_start_date is the date from which usage data should be shown/exported.\n Usage events before\ \ this date are still recorded but excluded from reports and Stripe sync." nullable: true title: contract_start_date email: description: email is the email address for the Stripe customer (optional) format: email nullable: true title: email type: string organizationId: description: organization_id is the ID of the organization to set up enterprise billing for format: uuid title: organization_id type: string sandbox: description: sandbox selects the sandbox billing environment. If false or unset, production is used. title: sandbox type: boolean setEnterpriseTier: description: "set_enterprise_tier also sets the organization tier to Enterprise.\n If false or unset, the organization\ \ must already be on Enterprise tier." title: set_enterprise_tier type: boolean required: - organizationId title: SetupEnterpriseBillingRequest type: object gitpod.v1.SetupEnterpriseBillingResponse: additionalProperties: false properties: stripeCustomerId: description: stripe_customer_id is the created or existing Stripe customer ID title: stripe_customer_id type: string required: - stripeCustomerId title: SetupEnterpriseBillingResponse type: object gitpod.v1.ShareResourceWithPrincipalRequest: additionalProperties: false description: ShareResourceWithPrincipal messages properties: principal: $ref: '#/components/schemas/gitpod.v1.Principal' description: Type of principal to share with (user or service account) enum: - 2 - 5 title: principal principalId: description: ID of the principal (user or service account) to share with format: uuid title: principal_id type: string resourceId: description: ID of the resource to share format: uuid title: resource_id type: string resourceType: $ref: '#/components/schemas/gitpod.v1.ResourceType' description: Type of resource to share (runner, project, etc.) not: enum: - 0 title: resource_type role: $ref: '#/components/schemas/gitpod.v1.ResourceRole' description: Role to grant the principal on the resource not: enum: - 0 title: role title: ShareResourceWithPrincipalRequest type: object gitpod.v1.ShareResourceWithPrincipalResponse: additionalProperties: false description: Empty response on success title: ShareResourceWithPrincipalResponse type: object gitpod.v1.SignupRequest: additionalProperties: false properties: environmentClasses: description: The environment classes this runner has to offer items: $ref: '#/components/schemas/gitpod.v1.EnvironmentClass' title: environment_classes type: array publicKey: description: The runner's public key. Must be an ECDH public key encoded in PKIX, ASN.1 DER format. format: byte maxLength: 32 minLength: 32 title: public_key type: string title: SignupRequest type: object gitpod.v1.SignupResponse: additionalProperties: false properties: runnerId: description: The runner's identity format: uuid title: runner_id type: string title: SignupResponse type: object gitpod.v1.Sort: additionalProperties: false properties: field: description: Field name to sort by, in camelCase. title: field type: string order: $ref: '#/components/schemas/gitpod.v1.SortOrder' title: order title: Sort type: object gitpod.v1.SortOrder: enum: - SORT_ORDER_UNSPECIFIED - SORT_ORDER_ASC - SORT_ORDER_DESC title: SortOrder type: string gitpod.v1.StackFrame: additionalProperties: false description: Stack trace frame information (Sentry-compatible) properties: colno: description: Column number in the line format: int32 title: colno type: integer contextLine: maxLength: 1000 title: context_line type: string filename: description: File name or path maxLength: 1000 title: filename type: string function: description: Function name maxLength: 1000 title: function type: string inApp: description: Whether this frame is in application code (vs library/framework code) title: in_app type: boolean lineno: description: Line number in the file format: int32 title: lineno type: integer module: description: Module or package name maxLength: 1000 title: module type: string postContext: items: maxItems: 10 type: string maxItems: 10 title: post_context type: array preContext: description: Source code context around the error line items: maxItems: 10 type: string maxItems: 10 title: pre_context type: array vars: additionalProperties: maxLength: 1000 title: value type: string description: Additional frame-specific variables/locals maxProperties: 20 title: vars type: object title: StackFrame type: object gitpod.v1.StackFrame.VarsEntry: additionalProperties: false properties: key: title: key type: string value: title: value type: string title: VarsEntry type: object gitpod.v1.StartAgentRequest: additionalProperties: false properties: agentId: format: uuid title: agent_id type: string annotations: additionalProperties: title: value type: string description: "annotations are key-value pairs for tracking external context\n (e.g., integration session IDs, GitHub\ \ issue references).\n Keys should follow domain/name convention (e.g., \"agent-client-session/id\")." title: annotations type: object codeContext: $ref: '#/components/schemas/gitpod.v1.AgentCodeContext' title: code_context mode: $ref: '#/components/schemas/gitpod.v1.AgentMode' description: "mode specifies the operational mode for this agent execution\n If not specified, defaults to AGENT_MODE_EXECUTION" title: mode name: maxLength: 100 title: name type: string runnerId: description: "runner_id specifies a runner for this agent execution.\n When set, the agent execution is routed to\ \ this runner instead of the\n runner associated with the environment." format: uuid title: runner_id type: string sessionId: description: "session_id is the ID of the session this agent execution belongs to.\n If empty, a new session is\ \ created implicitly." format: uuid title: session_id type: string workflowActionId: description: "workflow_action_id is an optional reference to the workflow execution action\n that created this agent\ \ execution. Used for tracking and event correlation." format: uuid nullable: true title: workflow_action_id type: string title: StartAgentRequest type: object gitpod.v1.StartAgentRequest.AnnotationsEntry: additionalProperties: false properties: key: title: key type: string value: title: value type: string title: AnnotationsEntry type: object gitpod.v1.StartAgentResponse: additionalProperties: false properties: agentExecutionId: format: uuid title: agent_execution_id type: string title: StartAgentResponse type: object gitpod.v1.StartEnvironmentRequest: additionalProperties: false properties: environmentId: description: environment_id specifies which environment should be started. format: uuid title: environment_id type: string title: StartEnvironmentRequest type: object gitpod.v1.StartEnvironmentResponse: additionalProperties: false title: StartEnvironmentResponse type: object gitpod.v1.StartServiceRequest: additionalProperties: false properties: id: format: uuid title: id type: string title: StartServiceRequest type: object gitpod.v1.StartServiceResponse: additionalProperties: false title: StartServiceResponse type: object gitpod.v1.StartTaskRequest: additionalProperties: false properties: id: format: uuid title: id type: string title: StartTaskRequest type: object gitpod.v1.StartTaskResponse: additionalProperties: false properties: taskExecution: $ref: '#/components/schemas/gitpod.v1.TaskExecution' title: task_execution required: - taskExecution title: StartTaskResponse type: object gitpod.v1.StartWorkflowRequest: additionalProperties: false description: StartWorkflowRequest starts a workflow execution. properties: contextOverride: $ref: '#/components/schemas/gitpod.v1.WorkflowTriggerContext' description: "Optional context override for the execution.\n When provided, replaces the workflow's default trigger\ \ context.\n User must have appropriate permissions on the overridden resources.\n Supports Projects, Repositories,\ \ and Agent context types.\n FromTrigger context type is not supported for manual overrides." nullable: true title: context_override parameters: additionalProperties: title: value type: string description: "Parameters to substitute into workflow steps using Go template syntax.\n Use {{ .Parameters.key_name\ \ }} in templatable fields (task.command, agent.prompt,\n pull_request.title/description/branch, trigger context\ \ agent.prompt).\n Keys must match pattern ^[a-zA-Z_][a-zA-Z0-9_]*$\n Maximum 10 parameters allowed.\n Empty map\ \ is treated as no parameters provided." maxProperties: 10 title: parameters type: object workflowId: format: uuid title: workflow_id type: string title: StartWorkflowRequest type: object gitpod.v1.StartWorkflowRequest.ParametersEntry: additionalProperties: false properties: key: title: key type: string value: title: value type: string title: ParametersEntry type: object gitpod.v1.StartWorkflowResponse: additionalProperties: false properties: workflowExecution: $ref: '#/components/schemas/gitpod.v1.WorkflowExecution' title: workflow_execution title: StartWorkflowResponse type: object gitpod.v1.StaticLLMIntegration: additionalProperties: false properties: encryptedApiKey: description: encrypted_api_key is the LLM provider's API key encrypted with the runner's public key. format: byte title: encrypted_api_key type: string endpoint: title: endpoint type: string id: description: "id is a unique identifier for the LLM integration template.\n This field must be provided by the client\ \ when creating the integration.\n It is required for identifying and updating the integration, since there is\ \ no other unique identifier." format: uuid title: id type: string maxTokens: description: max_tokens is the maximum number of tokens to generate before stopping. 0 is a model default. title: max_tokens type: string models: description: models represents the LLM models this integration supports items: $ref: '#/components/schemas/gitpod.v1.SupportedModel' title: models type: array requestHeaders: description: "request_headers contains custom request headers for this integration (e.g., for portkey compatibility).\n\ \ Header values will be encrypted with the runner's public key." items: $ref: '#/components/schemas/gitpod.v1.LLMIntegrationRequestHeader' title: request_headers type: array title: StaticLLMIntegration type: object gitpod.v1.StaticSCMIntegration: additionalProperties: false properties: host: title: host type: string oauth: $ref: '#/components/schemas/gitpod.v1.SCMIntegrationOAuthConfig' title: oauth pat: title: pat type: boolean scmId: maxLength: 127 minLength: 1 title: scm_id type: string virtualDirectory: description: "virtual_directory is the virtual directory path for Azure DevOps Server (e.g., \"/tfs\").\n This field\ \ is only used for Azure DevOps Server SCM integrations and should be empty for other SCM types.\n Azure DevOps\ \ Server APIs work without collection when PAT scope is 'All accessible organizations'." nullable: true title: virtual_directory type: string title: StaticSCMIntegration type: object gitpod.v1.StopAgentExecutionRequest: additionalProperties: false properties: agentExecutionId: format: uuid title: agent_execution_id type: string title: StopAgentExecutionRequest type: object gitpod.v1.StopAgentExecutionResponse: additionalProperties: false title: StopAgentExecutionResponse type: object gitpod.v1.StopEnvironmentRequest: additionalProperties: false properties: environmentId: description: "environment_id specifies which environment should be stopped.\n\n +required" format: uuid title: environment_id type: string title: StopEnvironmentRequest type: object gitpod.v1.StopEnvironmentResponse: additionalProperties: false title: StopEnvironmentResponse type: object gitpod.v1.StopServiceRequest: additionalProperties: false properties: id: format: uuid title: id type: string title: StopServiceRequest type: object gitpod.v1.StopServiceResponse: additionalProperties: false title: StopServiceResponse type: object gitpod.v1.StopTaskExecutionRequest: additionalProperties: false properties: id: format: uuid title: id type: string title: StopTaskExecutionRequest type: object gitpod.v1.StopTaskExecutionResponse: additionalProperties: false title: StopTaskExecutionResponse type: object gitpod.v1.Subject: additionalProperties: false properties: id: description: id is the UUID of the subject format: uuid title: id type: string principal: $ref: '#/components/schemas/gitpod.v1.Principal' description: Principal is the principal of the subject title: principal title: Subject type: object gitpod.v1.Subscription: additionalProperties: false properties: cancelledAt: $ref: '#/components/schemas/google.protobuf.Timestamp' description: cancelled_at is when the subscription was cancelled (if applicable) title: cancelled_at contractId: description: contract_id is the unique identifier for the contract title: contract_id type: string endsAt: $ref: '#/components/schemas/google.protobuf.Timestamp' description: ends_at is when the subscription access will end (if cancelled) title: ends_at organizationId: description: organization_id is the ID of the organization that owns the subscription title: organization_id type: string startsAt: $ref: '#/components/schemas/google.protobuf.Timestamp' description: starts_at is when the subscription was created title: starts_at status: $ref: '#/components/schemas/gitpod.v1.SubscriptionStatus' description: status is the current status of the subscription title: status subscriptionType: $ref: '#/components/schemas/gitpod.v1.SubscriptionType' description: subscription_type is the type of subscription title: subscription_type title: Subscription type: object gitpod.v1.SubscriptionStatus: enum: - SUBSCRIPTION_STATUS_UNSPECIFIED - SUBSCRIPTION_STATUS_ACTIVE - SUBSCRIPTION_STATUS_CANCELLED - SUBSCRIPTION_STATUS_EXPIRED - SUBSCRIPTION_STATUS_PENDING title: SubscriptionStatus type: string gitpod.v1.SubscriptionType: enum: - SUBSCRIPTION_TYPE_UNSPECIFIED - SUBSCRIPTION_TYPE_CORE title: SubscriptionType type: string gitpod.v1.SupportedModel: enum: - SUPPORTED_MODEL_UNSPECIFIED - SUPPORTED_MODEL_SONNET_3_5 - SUPPORTED_MODEL_SONNET_3_7 - SUPPORTED_MODEL_SONNET_3_7_EXTENDED - SUPPORTED_MODEL_SONNET_4 - SUPPORTED_MODEL_SONNET_4_EXTENDED - SUPPORTED_MODEL_SONNET_4_5 - SUPPORTED_MODEL_SONNET_4_5_EXTENDED - SUPPORTED_MODEL_SONNET_4_6 - SUPPORTED_MODEL_SONNET_4_6_EXTENDED - SUPPORTED_MODEL_OPUS_4 - SUPPORTED_MODEL_OPUS_4_EXTENDED - SUPPORTED_MODEL_OPUS_4_5 - SUPPORTED_MODEL_OPUS_4_5_EXTENDED - SUPPORTED_MODEL_OPUS_4_6 - SUPPORTED_MODEL_OPUS_4_6_EXTENDED - SUPPORTED_MODEL_HAIKU_4_5 - SUPPORTED_MODEL_OPENAI_4O - SUPPORTED_MODEL_OPENAI_4O_MINI - SUPPORTED_MODEL_OPENAI_O1 - SUPPORTED_MODEL_OPENAI_O1_MINI title: SupportedModel type: string gitpod.v1.Task: additionalProperties: false properties: dependsOn: description: dependencies specifies the IDs of the automations this task depends on. items: format: uuid type: string title: depends_on type: array environmentId: format: uuid title: environment_id type: string id: format: uuid title: id type: string metadata: $ref: '#/components/schemas/gitpod.v1.TaskMetadata' title: metadata spec: $ref: '#/components/schemas/gitpod.v1.TaskSpec' title: spec required: - id - environment_id title: Task type: object gitpod.v1.TaskExecution: additionalProperties: false properties: id: format: uuid title: id type: string metadata: $ref: '#/components/schemas/gitpod.v1.TaskExecutionMetadata' title: metadata spec: $ref: '#/components/schemas/gitpod.v1.TaskExecutionSpec' title: spec status: $ref: '#/components/schemas/gitpod.v1.TaskExecutionStatus' title: status required: - id title: TaskExecution type: object gitpod.v1.TaskExecutionMetadata: additionalProperties: false properties: completedAt: $ref: '#/components/schemas/google.protobuf.Timestamp' description: completed_at is the time the task execution was done. title: completed_at createdAt: $ref: '#/components/schemas/google.protobuf.Timestamp' description: created_at is the time the task was created. title: created_at creator: $ref: '#/components/schemas/gitpod.v1.Subject' description: creator describes the principal who created/started the task run. title: creator environmentId: description: environment_id is the ID of the environment in which the task run is executed. format: uuid title: environment_id type: string startedAt: $ref: '#/components/schemas/google.protobuf.Timestamp' description: started_at is the time the task execution actually started to run. title: started_at startedBy: description: started_by describes the trigger that started the task execution. title: started_by type: string taskId: description: task_id is the ID of the main task being executed. format: uuid title: task_id type: string title: TaskExecutionMetadata type: object gitpod.v1.TaskExecutionPhase: enum: - TASK_EXECUTION_PHASE_UNSPECIFIED - TASK_EXECUTION_PHASE_PENDING - TASK_EXECUTION_PHASE_RUNNING - TASK_EXECUTION_PHASE_SUCCEEDED - TASK_EXECUTION_PHASE_FAILED - TASK_EXECUTION_PHASE_STOPPED title: TaskExecutionPhase type: string gitpod.v1.TaskExecutionSpec: additionalProperties: false properties: desiredPhase: $ref: '#/components/schemas/gitpod.v1.TaskExecutionPhase' description: desired_phase is the phase the task execution should be in. Used to stop a running task execution early. title: desired_phase plan: description: "plan is a list of groups of steps. The steps in a group are executed concurrently, while the groups\ \ are executed sequentially.\n The order of the groups is the order in which they are executed." items: $ref: '#/components/schemas/gitpod.v1.TaskExecutionSpec.Group' title: plan type: array title: TaskExecutionSpec type: object gitpod.v1.TaskExecutionSpec.Group: additionalProperties: false properties: steps: items: $ref: '#/components/schemas/gitpod.v1.TaskExecutionSpec.Step' title: steps type: array title: Group type: object gitpod.v1.TaskExecutionSpec.Step: additionalProperties: false oneOf: - not: anyOf: - required: - task required: - serviceId - not: anyOf: - required: - serviceId required: - task properties: dependsOn: items: type: string title: depends_on type: array id: description: ID is the ID of the execution step format: uuid title: id type: string label: title: label type: string serviceId: format: uuid title: service_id type: string task: $ref: '#/components/schemas/gitpod.v1.TaskExecutionSpec.Task' title: task title: Step type: object gitpod.v1.TaskExecutionSpec.Task: additionalProperties: false properties: id: format: uuid title: id type: string spec: $ref: '#/components/schemas/gitpod.v1.TaskSpec' title: spec title: Task type: object gitpod.v1.TaskExecutionStatus: additionalProperties: false properties: failureMessage: description: "failure_message summarises why the task execution failed to operate. If this is non-empty\n the task\ \ execution has failed to operate and will likely transition to a failed state." title: failure_message type: string logUrl: description: "log_url is the URL to the logs of the task's steps. If this is empty, the task either has no logs\n\ \ or has not yet started." title: log_url type: string phase: $ref: '#/components/schemas/gitpod.v1.TaskExecutionPhase' description: the phase of a task execution represents the aggregated phase of all steps. title: phase statusVersion: description: "version of the status update. Task executions themselves are\n unversioned, but their status has different\ \ versions. The value of this\n field has no semantic meaning (e.g. don't interpret it as as a timestamp),\n but\ \ it can be used to impose a partial order. If a.status_version <\n b.status_version then a was the status before\ \ b." title: status_version type: string steps: description: "steps provides the status for each individual step of the task execution. If a step is missing it\n\ \ has not yet started." items: $ref: '#/components/schemas/gitpod.v1.TaskExecutionStatus.Step' title: steps type: array title: TaskExecutionStatus type: object gitpod.v1.TaskExecutionStatus.Step: additionalProperties: false properties: failureMessage: description: "failure_message summarises why the step failed to operate. If this is non-empty\n the step has failed\ \ to operate and will likely transition to a failed state." title: failure_message type: string id: description: ID is the ID of the execution step format: uuid title: id type: string output: additionalProperties: maxLength: 4096 title: value type: string description: "output contains the output of the task execution.\n setting an output field to empty string will unset\ \ it." title: output type: object phase: $ref: '#/components/schemas/gitpod.v1.TaskExecutionPhase' description: phase is the current phase of the execution step title: phase title: Step type: object gitpod.v1.TaskExecutionStatus.Step.OutputEntry: additionalProperties: false properties: key: title: key type: string value: title: value type: string title: OutputEntry type: object gitpod.v1.TaskMetadata: additionalProperties: false properties: createdAt: $ref: '#/components/schemas/google.protobuf.Timestamp' description: created_at is the time the task was created. title: created_at creator: $ref: '#/components/schemas/gitpod.v1.Subject' description: creator describes the principal who created the task. title: creator description: description: description is a user-facing description for the task. It can be used to provide context and documentation for the task. title: description type: string name: description: "name is a user-facing name for the task. Unlike the reference, this field is not unique, and not referenced\ \ by the system.\n This is a short descriptive name for the task." minLength: 1 title: name type: string reference: description: "reference is a user-facing identifier for the task which must be unique on the environment.\n It is\ \ used to express dependencies between tasks, and to identify the task in user interactions (e.g. the CLI)." pattern: ^[a-zA-Z0-9_-]{1,128}$ title: reference type: string triggeredBy: description: triggered_by is a list of trigger that start the task. items: $ref: '#/components/schemas/gitpod.v1.AutomationTrigger' title: triggered_by type: array title: TaskMetadata type: object gitpod.v1.TaskSpec: additionalProperties: false properties: command: description: command contains the command the task should execute title: command type: string env: description: env specifies environment variables for the task. items: $ref: '#/components/schemas/gitpod.v1.EnvironmentVariableItem' title: env type: array runsOn: $ref: '#/components/schemas/gitpod.v1.RunsOn' description: runs_on specifies the environment the task should run on. title: runs_on title: TaskSpec type: object gitpod.v1.Team: additionalProperties: false description: Team represents a team within an organization. properties: createdAt: $ref: '#/components/schemas/google.protobuf.Timestamp' title: created_at creatorId: description: "creator_id is the ID of the user who created this team.\n May be empty for system-created or migrated\ \ teams." format: uuid nullable: true title: creator_id type: string id: format: uuid title: id type: string memberCount: description: member_count is the total number of members in this team. format: int32 title: member_count type: integer name: maxLength: 80 minLength: 3 title: name type: string organizationId: format: uuid title: organization_id type: string updatedAt: $ref: '#/components/schemas/google.protobuf.Timestamp' title: updated_at title: Team type: object gitpod.v1.TeamCreditAllocationInfo: additionalProperties: false description: TeamCreditAllocationInfo represents a team's credit budget allocation. properties: createdAt: $ref: '#/components/schemas/google.protobuf.Timestamp' title: created_at creditBudget: description: credit_budget is the allocated credit budget in whole credits. title: credit_budget type: string id: format: uuid title: id type: string organizationId: format: uuid title: organization_id type: string teamId: format: uuid title: team_id type: string updatedAt: $ref: '#/components/schemas/google.protobuf.Timestamp' title: updated_at title: TeamCreditAllocationInfo type: object gitpod.v1.TeamCreditUsage: additionalProperties: false description: TeamCreditUsage contains a single team's credit usage for a day, broken down by type. properties: displayName: title: display_name type: string teamId: description: Empty when representing the "Others" aggregation bucket. title: team_id type: string usage: items: $ref: '#/components/schemas/gitpod.v1.CreditsByType' title: usage type: array title: TeamCreditUsage type: object gitpod.v1.TeamCumulativeCreditUsage: additionalProperties: false description: TeamCumulativeCreditUsage contains a team's cumulative credit usage and allocation. properties: creditBudget: description: "The team's credit allocation (budget) in whole credits, if set.\n Not set means no allocation has\ \ been configured for this team." nullable: true title: credit_budget type: string displayName: title: display_name type: string teamId: title: team_id type: string usage: $ref: '#/components/schemas/gitpod.v1.CumulativeCreditUsage' description: Cumulative credit usage for this team. title: usage title: TeamCumulativeCreditUsage type: object gitpod.v1.TeamMember: additionalProperties: false description: TeamMember represents a user's membership in a team. properties: avatarUrl: description: avatar_url is the user's avatar URL, populated at query time. title: avatar_url type: string createdAt: $ref: '#/components/schemas/google.protobuf.Timestamp' title: created_at id: description: Unique identifier for the team membership. format: uuid title: id type: string name: description: name is the user's display name, populated at query time. title: name type: string teamId: format: uuid title: team_id type: string userId: format: uuid title: user_id type: string title: TeamMember type: object gitpod.v1.TimeSeriesPoint: additionalProperties: false properties: time: $ref: '#/components/schemas/google.protobuf.Timestamp' description: Timestamp for this data point. title: time value: description: The numerical value for this data point. format: int32 title: value type: integer title: TimeSeriesPoint type: object gitpod.v1.ToolBreakdown: additionalProperties: false description: ToolBreakdown contains stats for a single AI tool (or human). properties: commits: description: Number of commits attributed to this tool. title: commits type: string distinctAuthors: description: Distinct authors who used this tool. title: distinct_authors type: string linesAdded: description: Lines added by this tool. title: lines_added type: string linesRemoved: description: Lines removed by this tool. title: lines_removed type: string tool: $ref: '#/components/schemas/gitpod.v1.CoAuthorTool' description: The tool these stats are for. title: tool title: ToolBreakdown type: object gitpod.v1.TopupPaymentFailureInfo: additionalProperties: false description: TopupPaymentFailureInfo contains information about a failed topup payment properties: errorMessage: description: error_message describes why the topup payment failed title: error_message type: string failedAt: $ref: '#/components/schemas/google.protobuf.Timestamp' description: failed_at is when the topup payment failure occurred title: failed_at title: TopupPaymentFailureInfo type: object gitpod.v1.UnarchiveEnvironmentRequest: additionalProperties: false properties: environmentId: description: "environment_id specifies the environment to unarchive.\n\n +required" format: uuid title: environment_id type: string title: UnarchiveEnvironmentRequest type: object gitpod.v1.UnarchiveEnvironmentResponse: additionalProperties: false title: UnarchiveEnvironmentResponse type: object gitpod.v1.UnblockAccountRequest: additionalProperties: false properties: accountId: description: account_id is the UUID of the account to unblock format: uuid title: account_id type: string required: - accountId title: UnblockAccountRequest type: object gitpod.v1.UnblockAccountResponse: additionalProperties: false title: UnblockAccountResponse type: object gitpod.v1.UnshareResourceWithPrincipalRequest: additionalProperties: false description: UnshareResourceWithPrincipal messages properties: principal: $ref: '#/components/schemas/gitpod.v1.Principal' description: Type of principal to remove access from (user or service account) enum: - 2 - 5 title: principal principalId: description: ID of the principal (user or service account) to remove access from format: uuid title: principal_id type: string resourceId: description: ID of the resource to unshare format: uuid title: resource_id type: string resourceType: $ref: '#/components/schemas/gitpod.v1.ResourceType' description: Type of resource to unshare not: enum: - 0 title: resource_type title: UnshareResourceWithPrincipalRequest type: object gitpod.v1.UnshareResourceWithPrincipalResponse: additionalProperties: false description: Empty response on success title: UnshareResourceWithPrincipalResponse type: object gitpod.v1.UpdateAgentExecutionRequest: additionalProperties: false properties: agentExecutionId: format: uuid title: agent_execution_id type: string metadata: $ref: '#/components/schemas/gitpod.v1.UpdateAgentExecutionRequest.Metadata' description: Metadata updates. If not provided, existing metadata is kept. title: metadata spec: $ref: '#/components/schemas/gitpod.v1.UpdateAgentExecutionRequest.Spec' description: Spec updates. If not provided, existing spec is kept. title: spec title: UpdateAgentExecutionRequest type: object gitpod.v1.UpdateAgentExecutionRequest.Metadata: additionalProperties: false properties: annotations: additionalProperties: title: value type: string description: "annotations are key-value pairs for tracking external context.\n Keys with the \"gitpod.io/\" prefix\ \ are reserved and cannot be set through this API.\n Provided annotations are merged with existing annotations." title: annotations type: object title: Metadata type: object gitpod.v1.UpdateAgentExecutionRequest.Metadata.AnnotationsEntry: additionalProperties: false properties: key: title: key type: string value: title: value type: string title: AnnotationsEntry type: object gitpod.v1.UpdateAgentExecutionRequest.Spec: additionalProperties: false properties: loopConditions: items: $ref: '#/components/schemas/gitpod.v1.AgentExecution.Spec.LoopCondition' maxItems: 10 title: loop_conditions type: array title: Spec type: object gitpod.v1.UpdateAgentExecutionResponse: additionalProperties: false properties: agentExecution: $ref: '#/components/schemas/gitpod.v1.AgentExecution' title: agent_execution title: UpdateAgentExecutionResponse type: object gitpod.v1.UpdateAgentRequest: additionalProperties: false properties: agentId: description: The ID of the agent to update format: uuid title: agent_id type: string metadata: $ref: '#/components/schemas/gitpod.v1.UpdateAgentRequest.Metadata' description: "Optional metadata which will replace the existing metadata partially\n If not provided, the existing\ \ metadata will be kept." title: metadata spec: $ref: '#/components/schemas/gitpod.v1.UpdateAgentRequest.Spec' description: Optional spec which will replace the existing spec partially title: spec title: UpdateAgentRequest type: object gitpod.v1.UpdateAgentRequest.Metadata: additionalProperties: false properties: description: description: A description of what the agent does nullable: true title: description type: string name: description: The name of the agent nullable: true title: name type: string title: Metadata type: object gitpod.v1.UpdateAgentRequest.Spec: additionalProperties: false properties: prompts: description: "The prompts configuration for each supported model.\n Setting the system prompt of a model to the\ \ empty value will remove the system prompt for that model.\n Adding a prompt for a model that already has a prompt\ \ will replace the existing prompt for that model.\n Adding a prompt for a model that does not exist adds a new\ \ prompt for that model." items: $ref: '#/components/schemas/gitpod.v1.RunnerSideAgentSpec.Prompts' title: prompts type: array requiredTools: description: "The list of tools required by this agent to function.\n Providing a value here will replace the existing\ \ list of required tools." items: type: string title: required_tools type: array title: Spec type: object gitpod.v1.UpdateAgentResponse: additionalProperties: false properties: agent: $ref: '#/components/schemas/gitpod.v1.Agent' description: The updated agent title: agent title: UpdateAgentResponse type: object gitpod.v1.UpdateAnnouncementBannerRequest: additionalProperties: false properties: enabled: description: enabled controls whether the banner is displayed nullable: true title: enabled type: boolean message: description: message is the banner message. Supports basic Markdown. Maximum 1000 characters. maxLength: 1000 nullable: true title: message type: string organizationId: description: organization_id is the ID of the organization format: uuid title: organization_id type: string required: - organizationId title: UpdateAnnouncementBannerRequest type: object gitpod.v1.UpdateAnnouncementBannerResponse: additionalProperties: false properties: banner: $ref: '#/components/schemas/gitpod.v1.AnnouncementBanner' description: banner is the updated announcement banner configuration title: banner required: - banner title: UpdateAnnouncementBannerResponse type: object gitpod.v1.UpdateAutoTopupSettingsRequest: additionalProperties: false properties: organizationId: description: organization_id is the ID of the organization to update auto-topup settings for format: uuid title: organization_id type: string settings: $ref: '#/components/schemas/gitpod.v1.AutoTopupSettings' description: settings contains the new auto-topup configuration title: settings required: - organizationId - settings title: UpdateAutoTopupSettingsRequest type: object gitpod.v1.UpdateAutoTopupSettingsResponse: additionalProperties: false properties: settings: $ref: '#/components/schemas/gitpod.v1.AutoTopupSettings' description: settings contains the updated auto-topup configuration title: settings title: UpdateAutoTopupSettingsResponse type: object gitpod.v1.UpdateBillingRecordRequest: additionalProperties: false properties: amountCentsUsd: description: amount_cents contains the amount of cents to charge the organization nullable: true title: amount_cents_usd type: string billingRecordId: description: billing_record_id is the ID of the billing record to update format: uuid title: billing_record_id type: string kind: $ref: '#/components/schemas/gitpod.v1.BillingPlanKind' description: kind contains the kind of plan nullable: true title: kind required: - billingRecordId - amountCentsUsd title: UpdateBillingRecordRequest type: object gitpod.v1.UpdateBillingRecordResponse: additionalProperties: false title: UpdateBillingRecordResponse type: object gitpod.v1.UpdateCustomDomainRequest: additionalProperties: false description: UpdateCustomDomainRequest is the request message for updating a custom domain properties: awsAccountId: deprecated: true description: 'aws_account_id is the AWS account ID (deprecated: use cloud_account_id)' nullable: true title: aws_account_id type: string cloudAccountId: description: cloud_account_id is the unified cloud account identifier (AWS Account ID or GCP Project ID) nullable: true title: cloud_account_id type: string domainName: description: domain_name is the custom domain name maxLength: 253 minLength: 4 title: domain_name type: string organizationId: description: organization_id is the ID of the organization to update custom domain for format: uuid title: organization_id type: string provider: $ref: '#/components/schemas/gitpod.v1.CustomDomainProvider' description: provider is the cloud provider for this custom domain nullable: true title: provider required: - organizationId - domainName title: UpdateCustomDomainRequest type: object gitpod.v1.UpdateCustomDomainResponse: additionalProperties: false description: UpdateCustomDomainResponse is the response message for updating a custom domain properties: customDomain: $ref: '#/components/schemas/gitpod.v1.CustomDomain' description: custom_domain is the updated custom domain title: custom_domain required: - customDomain title: UpdateCustomDomainResponse type: object gitpod.v1.UpdateEnvironmentClassRequest: additionalProperties: false properties: description: maxLength: 200 minLength: 3 nullable: true title: description type: string displayName: maxLength: 127 minLength: 3 nullable: true title: display_name type: string enabled: nullable: true title: enabled type: boolean environmentClassId: format: uuid title: environment_class_id type: string title: UpdateEnvironmentClassRequest type: object gitpod.v1.UpdateEnvironmentClassResponse: additionalProperties: false title: UpdateEnvironmentClassResponse type: object gitpod.v1.UpdateEnvironmentRequest: additionalProperties: false properties: environmentId: description: "environment_id specifies which environment should be updated.\n\n +required" format: uuid title: environment_id type: string metadata: $ref: '#/components/schemas/gitpod.v1.UpdateEnvironmentRequest.Metadata' nullable: true title: metadata spec: $ref: '#/components/schemas/gitpod.v1.UpdateEnvironmentRequest.Spec' nullable: true title: spec title: UpdateEnvironmentRequest type: object gitpod.v1.UpdateEnvironmentRequest.AutomationsFile: additionalProperties: false properties: automationsFilePath: description: "automations_file_path is the path to the automations file that is applied in the environment,\n relative\ \ to the repo root.\npath must not be absolute (start with a /):\n```\nthis.matches('^$|^[^/].*')\n```\n\n" nullable: true title: automations_file_path type: string session: nullable: true title: session type: string title: AutomationsFile type: object gitpod.v1.UpdateEnvironmentRequest.Content: additionalProperties: false properties: gitEmail: description: The Git email address nullable: true title: git_email type: string gitUsername: description: The Git username nullable: true title: git_username type: string initializer: $ref: '#/components/schemas/gitpod.v1.EnvironmentInitializer' description: initializer configures how the environment is to be initialized nullable: true title: initializer session: description: session should be changed to trigger a content reinitialization nullable: true title: session type: string title: Content type: object gitpod.v1.UpdateEnvironmentRequest.DevContainer: additionalProperties: false properties: devcontainerFilePath: description: 'devcontainer_file_path is the path to the devcontainer file relative to the repo root path must not be absolute (start with a /): ``` this.matches(''^$|^[^/].*'') ``` ' nullable: true title: devcontainer_file_path type: string session: description: session should be changed to trigger a devcontainer rebuild nullable: true title: session type: string title: DevContainer type: object gitpod.v1.UpdateEnvironmentRequest.Metadata: additionalProperties: false properties: lockdownAt: $ref: '#/components/schemas/google.protobuf.Timestamp' description: "lockdown_at sets or clears the lockdown time for this environment.\n Only org admins can set this\ \ field. When set to a future time, the\n environment will become blocked at that time. When cleared (set to\n\ \ epoch zero), the lockdown is removed. Setting to a past time is rejected." nullable: true title: lockdown_at x-stainless-skip: true name: description: name is the user-defined display name of the environment maxLength: 128 nullable: true title: name type: string title: Metadata type: object gitpod.v1.UpdateEnvironmentRequest.SSHPublicKey: additionalProperties: false properties: id: description: id is the unique identifier of the public key title: id type: string value: description: "value is the actual public key in the public key file format\n if not provided, the public key will\ \ be removed" nullable: true title: value type: string title: SSHPublicKey type: object gitpod.v1.UpdateEnvironmentRequest.Spec: additionalProperties: false properties: automationsFile: $ref: '#/components/schemas/gitpod.v1.UpdateEnvironmentRequest.AutomationsFile' description: automations_file is the automations file spec of the environment nullable: true title: automations_file content: $ref: '#/components/schemas/gitpod.v1.UpdateEnvironmentRequest.Content' nullable: true title: content devcontainer: $ref: '#/components/schemas/gitpod.v1.UpdateEnvironmentRequest.DevContainer' nullable: true title: devcontainer kernelControlsConfig: $ref: '#/components/schemas/gitpod.v1.KernelControlsConfig' description: kernel_controls_config configures kernel-level controls for this environment nullable: true title: kernel_controls_config ports: description: ports controls port sharing items: $ref: '#/components/schemas/gitpod.v1.EnvironmentSpec.EnvironmentPort' title: ports type: array sshPublicKeys: description: "ssh_public_keys are the public keys to update\n empty array means nothing to update" items: $ref: '#/components/schemas/gitpod.v1.UpdateEnvironmentRequest.SSHPublicKey' title: ssh_public_keys type: array timeout: $ref: '#/components/schemas/gitpod.v1.UpdateEnvironmentRequest.Timeout' description: Timeout configures the environment timeout nullable: true title: timeout title: Spec type: object gitpod.v1.UpdateEnvironmentRequest.Timeout: additionalProperties: false properties: disconnected: $ref: '#/components/schemas/google.protobuf.Duration' description: "inacitivity is the maximum time of disconnection before the environment is\n stopped or paused. Minimum\ \ duration is 30 minutes. Set to 0 to disable.\nvalue must be 0s (disabled) or at least 1800s (30 minutes):\n\ ```\nthis == duration('0s') || this >= duration('1800s')\n```\n\n" nullable: true title: disconnected title: Timeout type: object gitpod.v1.UpdateEnvironmentResponse: additionalProperties: false title: UpdateEnvironmentResponse type: object gitpod.v1.UpdateGroupRequest: additionalProperties: false description: UpdateGroup messages properties: description: maxLength: 255 title: description type: string groupId: format: uuid title: group_id type: string name: maxLength: 80 minLength: 3 title: name type: string title: UpdateGroupRequest type: object gitpod.v1.UpdateGroupResponse: additionalProperties: false properties: group: $ref: '#/components/schemas/gitpod.v1.Group' title: group title: UpdateGroupResponse type: object gitpod.v1.UpdateHostAuthenticationTokenRequest: additionalProperties: false properties: expiresAt: $ref: '#/components/schemas/google.protobuf.Timestamp' nullable: true title: expires_at id: format: uuid title: id type: string refreshToken: nullable: true title: refresh_token type: string scopes: items: type: string title: scopes type: array token: minLength: 1 nullable: true title: token type: string title: UpdateHostAuthenticationTokenRequest type: object gitpod.v1.UpdateHostAuthenticationTokenResponse: additionalProperties: false title: UpdateHostAuthenticationTokenResponse type: object gitpod.v1.UpdateIntegrationDefinitionRequest: additionalProperties: false properties: auth: $ref: '#/components/schemas/gitpod.v1.IntegrationAuthentication' description: auth defines the authentication requirements for this integration nullable: true title: auth capabilities: $ref: '#/components/schemas/gitpod.v1.IntegrationCapabilities' description: capabilities defines what this integration can do nullable: true title: capabilities description: description: description provides a human-readable description of the integration nullable: true title: description type: string experimental: description: experimental indicates if this integration is experimental and requires feature flag nullable: true title: experimental type: boolean host: description: host is the hostname for this integration (e.g., "linear.app") nullable: true title: host type: string iconUrl: description: icon_url is the URL for this integration's icon nullable: true title: icon_url type: string id: minLength: 1 title: id type: string name: description: name is the human-readable name for this integration type nullable: true title: name type: string title: UpdateIntegrationDefinitionRequest type: object gitpod.v1.UpdateIntegrationDefinitionResponse: additionalProperties: false properties: definition: $ref: '#/components/schemas/gitpod.v1.IntegrationDefinition' title: definition required: - definition title: UpdateIntegrationDefinitionResponse type: object gitpod.v1.UpdateIntegrationRequest: additionalProperties: false properties: auth: $ref: '#/components/schemas/gitpod.v1.IntegrationAuthentication' description: auth defines which authentication methods are enabled for this integration nullable: true title: auth capabilities: $ref: '#/components/schemas/gitpod.v1.IntegrationCapabilities' description: capabilities defines which capabilities are enabled for this integration nullable: true title: capabilities enabled: description: enabled indicates if this integration is enabled nullable: true title: enabled type: boolean host: description: host is the hostname for this integration (e.g., "linear.app") - optional, inherits from definition nullable: true title: host type: string id: format: uuid title: id type: string title: UpdateIntegrationRequest type: object gitpod.v1.UpdateIntegrationResponse: additionalProperties: false properties: integration: $ref: '#/components/schemas/gitpod.v1.Integration' title: integration required: - integration title: UpdateIntegrationResponse type: object gitpod.v1.UpdateLLMIntegrationRequest: additionalProperties: false properties: apiKey: description: "api_key can be set to update the LLM provider's API key.\n The cleartext secret will be encrypted\ \ with the runner's public key before being stored." nullable: true title: api_key type: string endpoint: nullable: true title: endpoint type: string id: format: uuid title: id type: string maxTokens: description: max_tokens can be set to update the maximum number of tokens to generate before stopping. nullable: true title: max_tokens type: string models: description: "models can be updated to change the supported LLM models\n Set list of supported models to the given\ \ list.\n Empty list means no updates to the models." items: $ref: '#/components/schemas/gitpod.v1.SupportedModel' title: models type: array phase: $ref: '#/components/schemas/gitpod.v1.LLMIntegrationPhase' description: phase can be set to update the status/phase of the LLM integration nullable: true title: phase requestHeaders: description: request_headers set optional headers for the LLM integration. items: $ref: '#/components/schemas/gitpod.v1.LLMIntegrationRequestHeader' title: request_headers type: array title: UpdateLLMIntegrationRequest type: object gitpod.v1.UpdateLLMIntegrationResponse: additionalProperties: false title: UpdateLLMIntegrationResponse type: object gitpod.v1.UpdateOIDCConfigRequest: additionalProperties: false description: UpdateOIDCConfigRequest is the request message for updating OIDC token configuration. properties: oidcConfig: $ref: '#/components/schemas/gitpod.v1.OIDCConfig' description: oidc_config is the desired OIDC token configuration. title: oidc_config organizationId: description: organization_id is the ID of the organization. format: uuid title: organization_id type: string required: - organizationId - oidcConfig title: UpdateOIDCConfigRequest type: object gitpod.v1.UpdateOIDCConfigResponse: additionalProperties: false description: UpdateOIDCConfigResponse is the response message for updating OIDC token configuration. properties: oidcConfig: $ref: '#/components/schemas/gitpod.v1.OIDCConfig' description: oidc_config is the updated OIDC token configuration. title: oidc_config required: - oidcConfig title: UpdateOIDCConfigResponse type: object gitpod.v1.UpdateOrganizationLLMConfigurationRequest: additionalProperties: false properties: apiKey: description: api_key is the plaintext Anthropic API key to encrypt and store (optional) maxLength: 512 minLength: 1 nullable: true title: api_key type: string organizationId: description: organization_id is the ID of the organization to update format: uuid title: organization_id type: string title: UpdateOrganizationLLMConfigurationRequest type: object gitpod.v1.UpdateOrganizationLLMConfigurationResponse: additionalProperties: false properties: configuration: $ref: '#/components/schemas/gitpod.v1.OrganizationLLMConfiguration' description: configuration contains metadata about the stored configuration title: configuration title: UpdateOrganizationLLMConfigurationResponse type: object gitpod.v1.UpdateOrganizationPoliciesRequest: additionalProperties: false properties: agentPolicy: $ref: '#/components/schemas/gitpod.v1.UpdateOrganizationPoliciesRequest.UpdateAgentPolicy' description: agent_policy contains agent-specific policy settings nullable: true title: agent_policy allowLocalRunners: description: allow_local_runners controls whether local runners are allowed to be used in the organization nullable: true title: allow_local_runners type: boolean allowedEditorIds: description: allowed_editor_ids is the list of editor IDs that are allowed to be used in the organization items: type: string title: allowed_editor_ids type: array defaultEditorId: description: default_editor_id is the default editor ID to be used when a user doesn't specify one nullable: true title: default_editor_id type: string defaultEnvironmentImage: description: default_environment_image is the default container image when none is defined in repo nullable: true title: default_environment_image type: string deleteArchivedEnvironmentsAfter: $ref: '#/components/schemas/google.protobuf.Duration' description: "delete_archived_environments_after controls how long archived environments are kept before automatic\ \ deletion.\n 0 means no automatic deletion. Maximum duration is 4 weeks (2419200 seconds)." nullable: true title: delete_archived_environments_after editorVersionRestrictions: additionalProperties: $ref: '#/components/schemas/gitpod.v1.EditorVersionPolicy' title: value description: "editor_version_restrictions restricts which editor versions can be used.\n Maps editor ID to version\ \ policy with allowed major versions." title: editor_version_restrictions type: object maximumEnvironmentLifetime: $ref: '#/components/schemas/google.protobuf.Duration' description: "maximum_environment_lifetime controls for how long environments are allowed to be reused.\n 0 means\ \ no maximum lifetime. Maximum duration is 180 days (15552000 seconds)." nullable: true title: maximum_environment_lifetime maximumEnvironmentLifetimeStrict: description: "maximum_environment_lifetime_strict controls whether environments past their\n lockdown_at timestamp\ \ are blocked from starting." nullable: true title: maximum_environment_lifetime_strict type: boolean x-stainless-skip: true maximumEnvironmentTimeout: $ref: '#/components/schemas/google.protobuf.Duration' description: "maximum_environment_timeout controls the maximum timeout allowed for environments in seconds.\n 0\ \ means no limit (never). Minimum duration is 30 minutes (1800 seconds).\nvalue must be 0s (no limit) or at least\ \ 1800s (30 minutes):\n```\nthis == duration('0s') || this >= duration('1800s')\n```\n\n" nullable: true title: maximum_environment_timeout maximumEnvironmentsPerUser: description: maximum_environments_per_user limits total environments (running or stopped) per user nullable: true title: maximum_environments_per_user type: string maximumRunningEnvironmentsPerUser: description: maximum_running_environments_per_user limits simultaneously running environments per user nullable: true title: maximum_running_environments_per_user type: string membersCreateProjects: description: members_create_projects controls whether members can create projects nullable: true title: members_create_projects type: boolean membersRequireProjects: description: members_require_projects controls whether environments can only be created from projects by non-admin users nullable: true title: members_require_projects type: boolean organizationId: description: organization_id is the ID of the organization to update policies for format: uuid title: organization_id type: string portSharingDisabled: description: "port_sharing_disabled controls whether user-initiated port sharing is disabled in the organization.\n\ \ System ports (VS Code Browser, agents) are always exempt from this policy." nullable: true title: port_sharing_disabled type: boolean requireCustomDomainAccess: description: "require_custom_domain_access controls whether users must access via custom domain\n when one is configured.\ \ When true, access via app.gitpod.io is blocked." nullable: true title: require_custom_domain_access type: boolean restrictAccountCreationToScim: description: "restrict_account_creation_to_scim controls whether account creation is restricted to SCIM-provisioned\ \ users only.\n When true and SCIM is configured for the organization, only users provisioned via SCIM can create\ \ accounts." nullable: true title: restrict_account_creation_to_scim type: boolean securityAgentPolicy: $ref: '#/components/schemas/gitpod.v1.UpdateOrganizationPoliciesRequest.UpdateSecurityAgentPolicy' description: security_agent_policy contains security agent configuration updates nullable: true title: security_agent_policy vetoExecPolicy: $ref: '#/components/schemas/gitpod.v1.VetoExecPolicy' description: veto_exec_policy contains the veto exec policy for environments. nullable: true title: veto_exec_policy required: - organizationId title: UpdateOrganizationPoliciesRequest type: object gitpod.v1.UpdateOrganizationPoliciesRequest.EditorVersionRestrictionsEntry: additionalProperties: false properties: key: title: key type: string value: $ref: '#/components/schemas/gitpod.v1.EditorVersionPolicy' title: value title: EditorVersionRestrictionsEntry type: object gitpod.v1.UpdateOrganizationPoliciesRequest.UpdateAgentPolicy: additionalProperties: false properties: commandDenyList: description: command_deny_list contains a list of commands that agents are not allowed to execute items: type: string title: command_deny_list type: array conversationSharingPolicy: $ref: '#/components/schemas/gitpod.v1.ConversationSharingPolicy' description: conversation_sharing_policy controls whether agent conversations can be shared nullable: true title: conversation_sharing_policy maxSubagentsPerEnvironment: description: "max_subagents_per_environment limits the number of non-terminal sub-agents\n a parent can have running\ \ simultaneously in the same environment.\n Valid range: 0-10. Zero means use the default (5)." format: int32 maximum: 10 nullable: true title: max_subagents_per_environment type: integer mcpDisabled: description: mcp_disabled controls whether MCP (Model Context Protocol) is disabled for agents nullable: true title: mcp_disabled type: boolean scmToolsAllowedGroupId: description: "scm_tools_allowed_group_id restricts SCM tools access to members of this group.\n Empty means no restriction\ \ (all users can use SCM tools if not disabled)." nullable: true title: scm_tools_allowed_group_id type: string scmToolsDisabled: description: scm_tools_disabled controls whether SCM (Source Control Management) tools are disabled for agents nullable: true title: scm_tools_disabled type: boolean title: UpdateAgentPolicy type: object gitpod.v1.UpdateOrganizationPoliciesRequest.UpdateCrowdStrikeConfig: additionalProperties: false description: UpdateCrowdStrikeConfig contains CrowdStrike Falcon configuration updates properties: additionalOptions: additionalProperties: title: value type: string description: additional_options contains additional FALCONCTL_OPT_* options as key-value pairs title: additional_options type: object cidSecretId: description: cid_secret_id references an organization secret containing the Customer ID (CID) format: uuid nullable: true title: cid_secret_id type: string enabled: description: enabled controls whether CrowdStrike Falcon is deployed to environments nullable: true title: enabled type: boolean image: description: image is the CrowdStrike Falcon sensor container image reference nullable: true title: image type: string tags: description: tags are optional tags to apply to the Falcon sensor nullable: true title: tags type: string title: UpdateCrowdStrikeConfig type: object gitpod.v1.UpdateOrganizationPoliciesRequest.UpdateCrowdStrikeConfig.AdditionalOptionsEntry: additionalProperties: false properties: key: title: key type: string value: title: value type: string title: AdditionalOptionsEntry type: object gitpod.v1.UpdateOrganizationPoliciesRequest.UpdateSecurityAgentPolicy: additionalProperties: false description: UpdateSecurityAgentPolicy contains security agent configuration updates properties: crowdstrike: $ref: '#/components/schemas/gitpod.v1.UpdateOrganizationPoliciesRequest.UpdateCrowdStrikeConfig' description: crowdstrike contains CrowdStrike Falcon configuration updates nullable: true title: crowdstrike customAgents: description: "custom_agents contains custom security agent definitions.\n Callers must read-then-write the full\ \ list." items: $ref: '#/components/schemas/gitpod.v1.CustomSecurityAgent' title: custom_agents type: array x-stainless-skip: true title: UpdateSecurityAgentPolicy type: object gitpod.v1.UpdateOrganizationPoliciesResponse: additionalProperties: false title: UpdateOrganizationPoliciesResponse type: object gitpod.v1.UpdateOrganizationRequest: additionalProperties: false properties: inviteDomains: $ref: '#/components/schemas/gitpod.v1.InviteDomains' description: invite_domains is the domain allowlist of the organization nullable: true title: invite_domains name: description: name is the new name of the organization nullable: true title: name type: string organizationId: description: organization_id is the ID of the organization to update the settings for. format: uuid title: organization_id type: string required: - organizationId title: UpdateOrganizationRequest type: object gitpod.v1.UpdateOrganizationResponse: additionalProperties: false properties: organization: $ref: '#/components/schemas/gitpod.v1.Organization' description: organization is the updated organization title: organization required: - organization title: UpdateOrganizationResponse type: object gitpod.v1.UpdateProjectEnvironmentClassesRequest: additionalProperties: false description: UpdateProjectEnvironmentClassesRequest updates all project environment classes of a project. properties: projectEnvironmentClasses: items: $ref: '#/components/schemas/gitpod.v1.ProjectEnvironmentClass' maxItems: 30 minItems: 1 title: project_environment_classes type: array projectId: description: project_id specifies the project identifier format: uuid title: project_id type: string title: UpdateProjectEnvironmentClassesRequest type: object gitpod.v1.UpdateProjectEnvironmentClassesResponse: additionalProperties: false title: UpdateProjectEnvironmentClassesResponse type: object gitpod.v1.UpdateProjectPolicyRequest: additionalProperties: false description: UpdateProjectPolicyRequest updates a Project Policy. properties: groupId: description: group_id specifies the group_id identifier format: uuid title: group_id type: string projectId: description: project_id specifies the project identifier format: uuid title: project_id type: string role: $ref: '#/components/schemas/gitpod.v1.ProjectRole' title: role title: UpdateProjectPolicyRequest type: object gitpod.v1.UpdateProjectPolicyResponse: additionalProperties: false properties: policy: $ref: '#/components/schemas/gitpod.v1.ProjectPolicy' title: policy title: UpdateProjectPolicyResponse type: object gitpod.v1.UpdateProjectRequest: additionalProperties: false properties: automationsFilePath: description: 'automations_file_path is the path to the automations file relative to the repo root path must not be absolute (start with a /): ``` this.matches(''^$|^[^/].*'') ``` ' nullable: true title: automations_file_path type: string devcontainerFilePath: description: 'devcontainer_file_path is the path to the devcontainer file relative to the repo root path must not be absolute (start with a /): ``` this.matches(''^$|^[^/].*'') ``` ' nullable: true title: devcontainer_file_path type: string initializer: $ref: '#/components/schemas/gitpod.v1.EnvironmentInitializer' description: initializer is the content initializer nullable: true title: initializer name: maxLength: 80 minLength: 1 nullable: true title: name type: string prebuildConfiguration: $ref: '#/components/schemas/gitpod.v1.ProjectPrebuildConfiguration' description: "prebuild_configuration defines how prebuilds are created for this project.\n If not provided, the\ \ existing prebuild configuration is not modified.\n To disable prebuilds, set enabled to false." nullable: true title: prebuild_configuration projectId: description: project_id specifies the project identifier format: uuid title: project_id type: string recommendedEditors: $ref: '#/components/schemas/gitpod.v1.RecommendedEditors' description: "recommended_editors specifies the editors recommended for this project.\n If not provided, the existing\ \ recommended editors are not modified.\n To clear all recommended editors, set to an empty RecommendedEditors\ \ message." nullable: true title: recommended_editors technicalDescription: description: "technical_description is a detailed technical description of the project\n This field is not returned\ \ by default in GetProject or ListProjects responses 8KB max" maxLength: 8192 nullable: true title: technical_description type: string title: UpdateProjectRequest type: object gitpod.v1.UpdateProjectResponse: additionalProperties: false properties: project: $ref: '#/components/schemas/gitpod.v1.Project' title: project title: UpdateProjectResponse type: object gitpod.v1.UpdateProjectsRequest: additionalProperties: false properties: projects: items: $ref: '#/components/schemas/gitpod.v1.UpdateProjectRequest' maxItems: 100 minItems: 1 title: projects type: array title: UpdateProjectsRequest type: object gitpod.v1.UpdateProjectsResponse: additionalProperties: false properties: failedProjects: description: failed_projects contains details about projects that failed to update items: $ref: '#/components/schemas/gitpod.v1.UpdateProjectsResponse.Failure' title: failed_projects type: array updatedProjects: description: updated_projects contains the successfully updated projects items: $ref: '#/components/schemas/gitpod.v1.Project' title: updated_projects type: array title: UpdateProjectsResponse type: object gitpod.v1.UpdateProjectsResponse.Failure: additionalProperties: false properties: error: description: error describes why the project update failed title: error type: string index: description: index is the position in the request array (0-based) format: int32 title: index type: integer projectId: description: project_id is the project ID that failed title: project_id type: string title: Failure type: object gitpod.v1.UpdatePromptRequest: additionalProperties: false properties: metadata: $ref: '#/components/schemas/gitpod.v1.UpdatePromptRequest.Metadata' description: Metadata updates nullable: true title: metadata promptId: description: The ID of the prompt to update format: uuid title: prompt_id type: string spec: $ref: '#/components/schemas/gitpod.v1.UpdatePromptRequest.Spec' description: Spec updates nullable: true title: spec title: UpdatePromptRequest type: object gitpod.v1.UpdatePromptRequest.Metadata: additionalProperties: false properties: description: description: A description of what the prompt does maxLength: 500 minLength: 1 nullable: true title: description type: string name: description: The name of the prompt maxLength: 255 nullable: true title: name type: string title: Metadata type: object gitpod.v1.UpdatePromptRequest.Spec: additionalProperties: false properties: command: description: The command string (unique within organization) maxLength: 50 nullable: true pattern: ^[a-zA-Z0-9_-]*$ title: command type: string isCommand: description: Whether this prompt is a command nullable: true title: is_command type: boolean isSkill: description: Whether this prompt is a skill nullable: true title: is_skill type: boolean isTemplate: description: Whether this prompt is a template nullable: true title: is_template type: boolean prompt: description: The prompt content maxLength: 20000 nullable: true title: prompt type: string title: Spec type: object gitpod.v1.UpdatePromptResponse: additionalProperties: false properties: prompt: $ref: '#/components/schemas/gitpod.v1.Prompt' title: prompt title: UpdatePromptResponse type: object gitpod.v1.UpdateRunnerAgentExecutionRequest: additionalProperties: false properties: agentExecutionId: format: uuid title: agent_execution_id type: string description: nullable: true title: description type: string name: nullable: true title: name type: string runnerId: format: uuid title: runner_id type: string status: $ref: '#/components/schemas/gitpod.v1.AgentExecution.Status' title: status title: UpdateRunnerAgentExecutionRequest type: object gitpod.v1.UpdateRunnerAgentExecutionResponse: additionalProperties: false title: UpdateRunnerAgentExecutionResponse type: object gitpod.v1.UpdateRunnerConfigurationSchemaRequest: additionalProperties: false properties: configSchema: $ref: '#/components/schemas/gitpod.v1.RunnerConfigurationSchema' description: config_schema is the schema for the runner's configuration title: config_schema runnerId: description: The runner's identity format: uuid title: runner_id type: string title: UpdateRunnerConfigurationSchemaRequest type: object gitpod.v1.UpdateRunnerConfigurationSchemaResponse: additionalProperties: false title: UpdateRunnerConfigurationSchemaResponse type: object gitpod.v1.UpdateRunnerEnvironmentSnapshotStatusRequest: additionalProperties: false properties: runnerId: description: The runner's identity format: uuid title: runner_id type: string snapshotId: description: snapshot_id specifies the snapshot to delete format: uuid title: snapshot_id type: string status: $ref: '#/components/schemas/gitpod.v1.RunnerEnvironmentSnapshotStatus' description: status is the new status for the snapshot title: status required: - runnerId - snapshotId title: UpdateRunnerEnvironmentSnapshotStatusRequest type: object gitpod.v1.UpdateRunnerEnvironmentSnapshotStatusResponse: additionalProperties: false title: UpdateRunnerEnvironmentSnapshotStatusResponse type: object gitpod.v1.UpdateRunnerEnvironmentStatusRequest: additionalProperties: false properties: environmentId: description: The environment's ID format: uuid title: environment_id type: string runnerId: description: The runner's identity format: uuid title: runner_id type: string status: $ref: '#/components/schemas/gitpod.v1.EnvironmentStatus' description: The environment's status title: status title: UpdateRunnerEnvironmentStatusRequest type: object gitpod.v1.UpdateRunnerEnvironmentStatusResponse: additionalProperties: false title: UpdateRunnerEnvironmentStatusResponse type: object gitpod.v1.UpdateRunnerManagerRequest: additionalProperties: false properties: name: description: The runner manager's name which is shown to users maxLength: 127 minLength: 1 nullable: true title: name type: string region: description: Region where the runner manager operates maxLength: 127 minLength: 1 nullable: true title: region type: string runnerManagerId: description: "runner_manager_id specifies which runner manager to be updated.\n\n +required" format: uuid title: runner_manager_id type: string spec: $ref: '#/components/schemas/gitpod.v1.UpdateRunnerManagerRequest.Spec' nullable: true title: spec title: UpdateRunnerManagerRequest type: object gitpod.v1.UpdateRunnerManagerRequest.RunnerManagerConfiguration: additionalProperties: false properties: collectDebugProfile: description: "When set to true, triggers a one-shot profile collection that uploads\n pprof profiles to the logs\ \ S3 bucket." nullable: true title: collect_debug_profile type: boolean llmIntegrationTemplatesUpdate: $ref: '#/components/schemas/gitpod.v1.UpdateRunnerManagerRequest.RunnerManagerConfiguration.StaticLLMIntegrationsUpdate' description: "llm_integration_templates_update contains the new values for the LLM integration templates.\n when\ \ set, the runner manager's LLM integration templates will be replaced with the new templates." nullable: true title: llm_integration_templates_update logLevel: $ref: '#/components/schemas/gitpod.v1.LogLevel' description: log_level is the log level for the runner manager nullable: true title: log_level metrics: $ref: '#/components/schemas/gitpod.v1.UpdateRunnerManagerRequest.RunnerManagerMetricsConfiguration' description: metrics contains configuration for the runner manager's metrics collection nullable: true title: metrics releaseChannel: $ref: '#/components/schemas/gitpod.v1.RunnerManagerReleaseChannel' description: release_channel can be updated to control the runner manager release channel nullable: true title: release_channel scmIntegrationTemplatesUpdate: $ref: '#/components/schemas/gitpod.v1.UpdateRunnerManagerRequest.RunnerManagerConfiguration.StaticSCMIntegrationsUpdate' description: "scm_integration_templates_update contains the new values for the SCM integration templates.\n when\ \ set, the runner manager's SCM integration templates will be replaced with the new templates." nullable: true title: scm_integration_templates_update title: RunnerManagerConfiguration type: object gitpod.v1.UpdateRunnerManagerRequest.RunnerManagerConfiguration.StaticLLMIntegrationsUpdate: additionalProperties: false properties: llmIntegrationTemplates: items: $ref: '#/components/schemas/gitpod.v1.StaticLLMIntegration' title: llm_integration_templates type: array title: StaticLLMIntegrationsUpdate type: object gitpod.v1.UpdateRunnerManagerRequest.RunnerManagerConfiguration.StaticSCMIntegrationsUpdate: additionalProperties: false properties: scmIntegrationTemplates: items: $ref: '#/components/schemas/gitpod.v1.StaticSCMIntegration' title: scm_integration_templates type: array title: StaticSCMIntegrationsUpdate type: object gitpod.v1.UpdateRunnerManagerRequest.RunnerManagerMetricsConfiguration: additionalProperties: false properties: enabled: description: enabled indicates whether the runner manager should collect metrics nullable: true title: enabled type: boolean password: description: password is the password to use for the metrics collector nullable: true title: password type: string url: description: url is the URL of the metrics collector nullable: true title: url type: string username: description: username is the username to use for the metrics collector nullable: true title: username type: string title: RunnerManagerMetricsConfiguration type: object gitpod.v1.UpdateRunnerManagerRequest.Spec: additionalProperties: false properties: configuration: $ref: '#/components/schemas/gitpod.v1.UpdateRunnerManagerRequest.RunnerManagerConfiguration' nullable: true title: configuration desiredPhase: $ref: '#/components/schemas/gitpod.v1.RunnerManagerPhase' description: desired_phase can be updated to control the runner manager state nullable: true title: desired_phase title: Spec type: object gitpod.v1.UpdateRunnerManagerResponse: additionalProperties: false title: UpdateRunnerManagerResponse type: object gitpod.v1.UpdateRunnerPolicyRequest: additionalProperties: false description: UpdateRunnerPolicyRequest updates a Project Policy. properties: groupId: description: group_id specifies the group_id identifier format: uuid title: group_id type: string role: $ref: '#/components/schemas/gitpod.v1.RunnerRole' title: role runnerId: description: runner_id specifies the project identifier format: uuid title: runner_id type: string title: UpdateRunnerPolicyRequest type: object gitpod.v1.UpdateRunnerPolicyResponse: additionalProperties: false properties: policy: $ref: '#/components/schemas/gitpod.v1.RunnerPolicy' title: policy required: - policy title: UpdateRunnerPolicyResponse type: object gitpod.v1.UpdateRunnerRequest: additionalProperties: false properties: name: description: The runner's name which is shown to users maxLength: 127 minLength: 3 nullable: true title: name type: string runnerId: description: "runner_id specifies which runner to be updated.\n\n +required" format: uuid title: runner_id type: string spec: $ref: '#/components/schemas/gitpod.v1.UpdateRunnerRequest.Spec' nullable: true title: spec title: UpdateRunnerRequest type: object gitpod.v1.UpdateRunnerRequest.MetricsConfiguration: additionalProperties: false properties: enabled: description: enabled indicates whether the runner should collect metrics nullable: true title: enabled type: boolean managedMetricsEnabled: description: "When true, the runner pushes metrics to the management plane via\n ReportRunnerMetrics instead of\ \ directly to the remote_write endpoint." nullable: true title: managed_metrics_enabled type: boolean password: description: password is the password to use for the metrics collector nullable: true title: password type: string url: description: url is the URL of the metrics collector nullable: true title: url type: string username: description: username is the username to use for the metrics collector nullable: true title: username type: string title: MetricsConfiguration type: object gitpod.v1.UpdateRunnerRequest.RunnerConfiguration: additionalProperties: false properties: autoUpdate: description: auto_update indicates whether the runner should automatically update itself. nullable: true title: auto_update type: boolean continuousProfiling: description: "continuous_profiling enables continuous profiling on the runner.\n This is an internal-only field\ \ used for debugging." nullable: true title: continuous_profiling type: boolean x-stainless-skip: true devcontainerImageCacheEnabled: description: devcontainer_image_cache_enabled controls whether the shared devcontainer build cache is enabled for this runner. nullable: true title: devcontainer_image_cache_enabled type: boolean honeycombApiKey: description: "honeycomb_api_key is the plaintext API key for Honeycomb tracing.\n The backend encrypts it with the\ \ runner's public key before storing.\n This is an internal-only field used for debugging." nullable: true title: honeycomb_api_key type: string x-stainless-skip: true logLevel: $ref: '#/components/schemas/gitpod.v1.LogLevel' description: log_level is the log level for the runner nullable: true title: log_level metrics: $ref: '#/components/schemas/gitpod.v1.UpdateRunnerRequest.MetricsConfiguration' description: metrics contains configuration for the runner's metrics collection nullable: true title: metrics releaseChannel: $ref: '#/components/schemas/gitpod.v1.RunnerReleaseChannel' description: The release channel the runner is on nullable: true title: release_channel updateWindow: $ref: '#/components/schemas/gitpod.v1.UpdateWindow' description: "update_window defines the daily time window (UTC) during which auto-updates are allowed.\n start_hour\ \ is required. If end_hour is omitted, it defaults to start_hour + 2.\n Send an empty UpdateWindow (no start_hour\ \ or end_hour) to clear a custom window\n and allow updates at any time." nullable: true title: update_window title: RunnerConfiguration type: object gitpod.v1.UpdateRunnerRequest.Spec: additionalProperties: false properties: configuration: $ref: '#/components/schemas/gitpod.v1.UpdateRunnerRequest.RunnerConfiguration' nullable: true title: configuration desiredPhase: $ref: '#/components/schemas/gitpod.v1.RunnerPhase' description: "desired_phase can currently only be updated on local-configuration runners,\n to toggle whether local\ \ runners are allowed for running environments in the\n organization.\n Set to:\n - ACTIVE to enable local runners.\n\ \ - INACTIVE to disable all local runners. Existing local runners and their\n environments will stop, and cannot\ \ be started again until the desired_phase\n is set to ACTIVE. Use this carefully, as it will affect all users\ \ in the\n organization who use local runners." nullable: true title: desired_phase title: Spec type: object gitpod.v1.UpdateRunnerResponse: additionalProperties: false title: UpdateRunnerResponse type: object gitpod.v1.UpdateRunnerStatusRequest: additionalProperties: false properties: additionalInfo: description: additional_info updates fields in the runner's additional_info. items: $ref: '#/components/schemas/gitpod.v1.FieldValueUpdate' title: additional_info type: array capabilities: description: "capabilities contains the runner's supported capabilities.\n Optional field, only overwrites previous\ \ capabilities if set to a non-empty list.\n To clear capabilities, set this to a list with a single UNSPECIFIED\ \ capability." items: $ref: '#/components/schemas/gitpod.v1.RunnerCapability' title: capabilities type: array degredationMessage: description: "Degredation message is an optional message that is shown to users when the runner is in a degraded\ \ state.\n Setting this to \"\" changes the runner's phase back from \"degraded\" to \"active\"." nullable: true title: degredation_message type: string gatewayInfo: $ref: '#/components/schemas/gitpod.v1.GatewayInfo' description: GatewayInfo contains information about the gateway that the runner is running on. title: gateway_info llmUrl: description: llm_url is the URL of the LLM service to which the runner is connected. nullable: true title: llm_url type: string logUrl: description: log_url is the URL to the runner's logs format: uri nullable: true title: log_url type: string region: description: region is the region the runner is running in, if applicable. nullable: true title: region type: string runnerId: description: The runner's identity format: uuid title: runner_id type: string supportBundleUrl: nullable: true title: support_bundle_url type: string systemDetails: description: "system_details is a runner specific system detail string. Think of this like a user agent string.\n\ \ It's intended to be used for debugging and support purposes and might be shown to the user." nullable: true title: system_details type: string version: description: version is the version of the runner. This is used to detect if the runner is outdated. nullable: true title: version type: string title: UpdateRunnerStatusRequest type: object gitpod.v1.UpdateRunnerStatusResponse: additionalProperties: false title: UpdateRunnerStatusResponse type: object gitpod.v1.UpdateRunnerWarmPoolStatusRequest: additionalProperties: false properties: runnerId: description: The runner's identity format: uuid title: runner_id type: string status: $ref: '#/components/schemas/gitpod.v1.WarmPoolStatus' description: status is the new status for the warm pool title: status warmPoolId: description: warm_pool_id specifies the warm pool to update format: uuid title: warm_pool_id type: string required: - runnerId - warmPoolId - status title: UpdateRunnerWarmPoolStatusRequest type: object gitpod.v1.UpdateRunnerWarmPoolStatusResponse: additionalProperties: false title: UpdateRunnerWarmPoolStatusResponse type: object gitpod.v1.UpdateSCIMConfigurationRequest: additionalProperties: false properties: enabled: description: enabled controls whether SCIM provisioning is active nullable: true title: enabled type: boolean name: description: name is a human-readable name for the SCIM configuration maxLength: 128 nullable: true title: name type: string scimConfigurationId: description: scim_configuration_id is the ID of the SCIM configuration to update format: uuid title: scim_configuration_id type: string ssoConfigurationId: description: sso_configuration_id is the SSO configuration to link format: uuid nullable: true title: sso_configuration_id type: string required: - scimConfigurationId title: UpdateSCIMConfigurationRequest type: object gitpod.v1.UpdateSCIMConfigurationResponse: additionalProperties: false properties: scimConfiguration: $ref: '#/components/schemas/gitpod.v1.SCIMConfiguration' description: scim_configuration is the updated SCIM configuration title: scim_configuration required: - scimConfiguration title: UpdateSCIMConfigurationResponse type: object gitpod.v1.UpdateSCMIntegrationRequest: additionalProperties: false properties: id: format: uuid title: id type: string issuerUrl: description: issuer_url can be set to override the authentication provider URL, if it doesn't match the SCM host. nullable: true title: issuer_url type: string oauthClientId: description: "oauth_client_id can be set to update the OAuth app's client ID.\n If an empty string is set, the OAuth\ \ configuration will be removed (regardless\n of whether a client secret is set), and any existing Host Authentication\ \ Tokens for the\n SCM integration's runner and host that were created using the OAuth app will be deleted.\n\ \ This might lead to users being unable to access their repositories until they re-authenticate." nullable: true title: oauth_client_id type: string oauthPlaintextClientSecret: description: "oauth_plaintext_client_secret can be set to update the OAuth app's client secret.\n The cleartext\ \ secret will be encrypted with the runner's public key before being stored." nullable: true title: oauth_plaintext_client_secret type: string pat: description: "pat can be set to enable or disable Personal Access Tokens support.\n When disabling PATs, any existing\ \ Host Authentication Tokens for the SCM integration's\n runner and host that were created using a PAT will be\ \ deleted. This might lead to users\n being unable to access their repositories until they re-authenticate." nullable: true title: pat type: boolean virtualDirectory: description: "virtual_directory is the virtual directory path for Azure DevOps Server (e.g., \"/tfs\").\n This field\ \ is only used for Azure DevOps Server SCM integrations and should be empty for other SCM types.\n Azure DevOps\ \ Server APIs work without collection when PAT scope is 'All accessible organizations'." nullable: true title: virtual_directory type: string title: UpdateSCMIntegrationRequest type: object gitpod.v1.UpdateSCMIntegrationResponse: additionalProperties: false title: UpdateSCMIntegrationResponse type: object gitpod.v1.UpdateSSOConfigurationRequest: additionalProperties: false properties: additionalScopes: $ref: '#/components/schemas/gitpod.v1.AdditionalScopesUpdate' description: "additional_scopes replaces the configured OIDC scopes when present.\n When absent (nil), scopes are\ \ left unchanged.\n When present with an empty scopes list, all additional scopes are cleared." nullable: true title: additional_scopes claims: additionalProperties: title: value type: string description: claims are key/value pairs that defines a mapping of claims issued by the IdP. title: claims type: object claimsExpression: description: "claims_expression is a CEL expression evaluated against OIDC token claims during login.\n When set,\ \ the expression must evaluate to true for the login to succeed.\n When present with an empty string, the expression\ \ is cleared." maxLength: 4096 nullable: true title: claims_expression type: string clientId: description: client_id is the client ID of the SSO provider minLength: 1 nullable: true title: client_id type: string clientSecret: description: client_secret is the client secret of the SSO provider minLength: 1 nullable: true title: client_secret type: string displayName: maxLength: 128 nullable: true title: display_name type: string emailDomain: minLength: 4 nullable: true title: email_domain type: string emailDomains: items: maxLength: 253 minLength: 4 pattern: ^(?:[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?\.)+[a-zA-Z]{2,}$ type: string uniqueItems: true title: email_domains type: array uniqueItems: true issuerUrl: description: issuer_url is the URL of the IdP issuer format: uri nullable: true title: issuer_url type: string ssoConfigurationId: description: sso_configuration_id is the ID of the SSO configuration to update format: uuid title: sso_configuration_id type: string state: $ref: '#/components/schemas/gitpod.v1.SSOConfigurationState' description: state is the state of the SSO configuration nullable: true title: state required: - ssoConfigurationId title: UpdateSSOConfigurationRequest type: object gitpod.v1.UpdateSSOConfigurationRequest.ClaimsEntry: additionalProperties: false properties: key: title: key type: string value: title: value type: string title: ClaimsEntry type: object gitpod.v1.UpdateSSOConfigurationResponse: additionalProperties: false title: UpdateSSOConfigurationResponse type: object gitpod.v1.UpdateSecretValueRequest: additionalProperties: false properties: secretId: format: uuid title: secret_id type: string value: description: value is the plaintext value of the secret maxLength: 10240 minLength: 1 title: value type: string title: UpdateSecretValueRequest type: object gitpod.v1.UpdateSecretValueResponse: additionalProperties: false title: UpdateSecretValueResponse type: object gitpod.v1.UpdateServiceAccountRequest: additionalProperties: false properties: description: description: 'Note: valid_until is immutable and cannot be updated' maxLength: 500 nullable: true title: description type: string name: description: Optional fields for update maxLength: 64 minLength: 1 nullable: true title: name type: string serviceAccountId: format: uuid title: service_account_id type: string title: UpdateServiceAccountRequest type: object gitpod.v1.UpdateServiceAccountResponse: additionalProperties: false properties: serviceAccount: $ref: '#/components/schemas/gitpod.v1.ServiceAccount' title: service_account required: - serviceAccount title: UpdateServiceAccountResponse type: object gitpod.v1.UpdateServiceRequest: additionalProperties: false properties: id: format: uuid title: id type: string metadata: $ref: '#/components/schemas/gitpod.v1.UpdateServiceRequest.ServiceMetadata' title: metadata spec: $ref: '#/components/schemas/gitpod.v1.UpdateServiceRequest.ServiceSpec' description: "Changing the spec of a service is a complex operation. The spec of a service\n can only be updated\ \ if the service is in a stopped state. If the service is\n running, it must be stopped first." title: spec status: $ref: '#/components/schemas/gitpod.v1.UpdateServiceRequest.ServiceStatus' description: "Service status updates are only expected from the executing environment. As a client\n of this API\ \ you are not expected to provide this field. Updating this field requires\n the `environmentservice:update_status`\ \ permission." title: status title: UpdateServiceRequest type: object gitpod.v1.UpdateServiceRequest.AutomationTriggerUpdate: additionalProperties: false properties: trigger: items: $ref: '#/components/schemas/gitpod.v1.AutomationTrigger' title: trigger type: array title: AutomationTriggerUpdate type: object gitpod.v1.UpdateServiceRequest.ServiceMetadata: additionalProperties: false properties: description: nullable: true title: description type: string name: minLength: 1 nullable: true title: name type: string role: $ref: '#/components/schemas/gitpod.v1.ServiceRole' nullable: true title: role triggeredBy: $ref: '#/components/schemas/gitpod.v1.UpdateServiceRequest.AutomationTriggerUpdate' nullable: true title: triggered_by title: ServiceMetadata type: object gitpod.v1.UpdateServiceRequest.ServiceSpec: additionalProperties: false properties: commands: $ref: '#/components/schemas/gitpod.v1.UpdateServiceRequest.ServiceSpec.Commands' nullable: true title: commands env: items: $ref: '#/components/schemas/gitpod.v1.EnvironmentVariableItem' title: env type: array runsOn: $ref: '#/components/schemas/gitpod.v1.RunsOn' nullable: true title: runs_on title: ServiceSpec type: object gitpod.v1.UpdateServiceRequest.ServiceSpec.Commands: additionalProperties: false properties: ready: nullable: true title: ready type: string start: nullable: true title: start type: string stop: nullable: true title: stop type: string title: Commands type: object gitpod.v1.UpdateServiceRequest.ServiceStatus: additionalProperties: false properties: failureMessage: nullable: true title: failure_message type: string logUrl: nullable: true title: log_url type: string output: additionalProperties: title: value type: string description: setting an output field to empty string will unset it. title: output type: object phase: $ref: '#/components/schemas/gitpod.v1.ServicePhase' nullable: true title: phase session: nullable: true title: session type: string title: ServiceStatus type: object gitpod.v1.UpdateServiceRequest.ServiceStatus.OutputEntry: additionalProperties: false properties: key: title: key type: string value: title: value type: string title: OutputEntry type: object gitpod.v1.UpdateServiceResponse: additionalProperties: false title: UpdateServiceResponse type: object gitpod.v1.UpdateSessionRequest: additionalProperties: false properties: description: nullable: true title: description type: string name: nullable: true title: name type: string orchestratorAgentExecutionId: format: uuid nullable: true title: orchestrator_agent_execution_id type: string phase: $ref: '#/components/schemas/gitpod.v1.SessionPhase' nullable: true title: phase sessionId: format: uuid title: session_id type: string title: UpdateSessionRequest type: object gitpod.v1.UpdateSessionResourceRequest: additionalProperties: false properties: description: nullable: true title: description type: string resourceId: format: uuid title: resource_id type: string role: $ref: '#/components/schemas/gitpod.v1.SessionResourceRole' nullable: true title: role sessionId: format: uuid title: session_id type: string title: nullable: true title: title type: string title: UpdateSessionResourceRequest type: object gitpod.v1.UpdateSessionResourceResponse: additionalProperties: false properties: resource: $ref: '#/components/schemas/gitpod.v1.SessionResource' title: resource title: UpdateSessionResourceResponse type: object gitpod.v1.UpdateSessionResponse: additionalProperties: false properties: session: $ref: '#/components/schemas/gitpod.v1.Session' title: session title: UpdateSessionResponse type: object gitpod.v1.UpdateSubscriptionRequest: additionalProperties: false properties: newAmountCents: description: new_amount_cents is the new amount in cents to charge the organization enum: - 2000 - 5000 - 10000 - 20000 - 50000 title: new_amount_cents type: string organizationId: description: organization_id is the ID of the organization whose subscription to update format: uuid title: organization_id type: string required: - organizationId - newAmountCents title: UpdateSubscriptionRequest type: object gitpod.v1.UpdateSubscriptionResponse: additionalProperties: false properties: subscription: $ref: '#/components/schemas/gitpod.v1.Subscription' title: subscription title: UpdateSubscriptionResponse type: object gitpod.v1.UpdateTaskExecutionStatusRequest: additionalProperties: false properties: failureMessage: description: "failure_message marks the task execution as failed and provides a message explaining the failure.\n\ \ If an individual step has failed, callers are NOT expected to set this message; only if the task execution as\ \ a whole has failed/cannot be started." nullable: true title: failure_message type: string id: format: uuid title: id type: string logUrl: description: log_url is the URL to the logs of the task's steps. If this is empty, the task either has no logs or has not yet started. nullable: true title: log_url type: string steps: items: $ref: '#/components/schemas/gitpod.v1.TaskExecutionStatus.Step' title: steps type: array title: UpdateTaskExecutionStatusRequest type: object gitpod.v1.UpdateTaskExecutionStatusResponse: additionalProperties: false title: UpdateTaskExecutionStatusResponse type: object gitpod.v1.UpdateTaskRequest: additionalProperties: false properties: dependsOn: description: dependencies specifies the IDs of the automations this task depends on. items: format: uuid type: string title: depends_on type: array id: format: uuid title: id type: string metadata: $ref: '#/components/schemas/gitpod.v1.UpdateTaskRequest.TaskMetadata' title: metadata spec: $ref: '#/components/schemas/gitpod.v1.UpdateTaskRequest.TaskSpec' title: spec title: UpdateTaskRequest type: object gitpod.v1.UpdateTaskRequest.AutomationTriggerUpdate: additionalProperties: false properties: trigger: items: $ref: '#/components/schemas/gitpod.v1.AutomationTrigger' title: trigger type: array title: AutomationTriggerUpdate type: object gitpod.v1.UpdateTaskRequest.TaskMetadata: additionalProperties: false properties: description: nullable: true title: description type: string name: minLength: 1 nullable: true title: name type: string triggeredBy: $ref: '#/components/schemas/gitpod.v1.UpdateTaskRequest.AutomationTriggerUpdate' nullable: true title: triggered_by title: TaskMetadata type: object gitpod.v1.UpdateTaskRequest.TaskSpec: additionalProperties: false properties: command: nullable: true title: command type: string env: items: $ref: '#/components/schemas/gitpod.v1.EnvironmentVariableItem' title: env type: array runsOn: $ref: '#/components/schemas/gitpod.v1.RunsOn' nullable: true title: runs_on title: TaskSpec type: object gitpod.v1.UpdateTaskResponse: additionalProperties: false title: UpdateTaskResponse type: object gitpod.v1.UpdateTeamCreditAllocationRequest: additionalProperties: false properties: creditBudget: description: credit_budget is the new allocated credit budget in whole credits. Must be > 0. exclusiveMinimum: true minimum: 0 title: credit_budget type: string organizationId: format: uuid title: organization_id type: string teamId: format: uuid title: team_id type: string required: - organizationId - teamId - creditBudget title: UpdateTeamCreditAllocationRequest type: object gitpod.v1.UpdateTeamCreditAllocationResponse: additionalProperties: false properties: allocation: $ref: '#/components/schemas/gitpod.v1.TeamCreditAllocationInfo' title: allocation title: UpdateTeamCreditAllocationResponse type: object gitpod.v1.UpdateTeamRequest: additionalProperties: false properties: name: maxLength: 80 minLength: 3 nullable: true title: name type: string teamId: format: uuid title: team_id type: string title: UpdateTeamRequest type: object gitpod.v1.UpdateTeamResponse: additionalProperties: false properties: team: $ref: '#/components/schemas/gitpod.v1.Team' title: team title: UpdateTeamResponse type: object gitpod.v1.UpdateWarmPoolRequest: additionalProperties: false properties: desiredSize: deprecated: true description: "desired_size updates the number of warm instances to maintain.\n Deprecated: Use min_size and max_size\ \ instead for dynamic scaling." format: int32 maximum: 20 minimum: 1 nullable: true title: desired_size type: integer maxSize: description: "max_size updates the maximum number of warm instances to maintain.\n The pool will never scale above\ \ this value.\n Must be >= min_size and <= 20." format: int32 maximum: 20 minimum: 1 nullable: true title: max_size type: integer minSize: description: "min_size updates the minimum number of warm instances to maintain.\n The pool will never scale below\ \ this value.\n Must be >= 0 and <= max_size. Set to 0 to allow full scale-down." format: int32 maximum: 20 nullable: true title: min_size type: integer warmPoolId: description: warm_pool_id specifies the warm pool to update format: uuid title: warm_pool_id type: string required: - warmPoolId title: UpdateWarmPoolRequest type: object gitpod.v1.UpdateWarmPoolResponse: additionalProperties: false properties: warmPool: $ref: '#/components/schemas/gitpod.v1.WarmPool' title: warm_pool required: - warmPool title: UpdateWarmPoolResponse type: object gitpod.v1.UpdateWebhookRequest: additionalProperties: false description: UpdateWebhookRequest updates a webhook's configuration. properties: description: description: description is an optional description of the webhook's purpose maxLength: 500 nullable: true title: description type: string name: description: name is the display name of the webhook maxLength: 80 minLength: 1 nullable: true title: name type: string organizationScope: $ref: '#/components/schemas/gitpod.v1.WebhookOrganizationScope' description: "organization_scope replaces the webhook's organization scope.\n For ORGANIZATION type: identifies\ \ the organization and its SCM host.\n When provided, takes precedence over the deprecated scope field.\n Note:\ \ The webhook type and provider cannot be changed after creation." title: organization_scope scope: deprecated: true description: "Deprecated: Use scopes instead.\n scope is the target of the webhook:\n - For REPOSITORY type: \"\ owner/repo\" (e.g., \"gitpod-io/gitpod\")\n - For ORGANIZATION type: \"owner\" (e.g., \"gitpod-io\")\n Note: The\ \ webhook type and provider cannot be changed after creation." maxLength: 255 nullable: true title: scope type: string scopes: description: "scopes replaces the webhook's repository scopes.\n For REPOSITORY type: each entry represents a specific\ \ repository with full SCM data.\n When provided, takes precedence over the deprecated scope field.\n Note: The\ \ webhook type and provider cannot be changed after creation." items: $ref: '#/components/schemas/gitpod.v1.WebhookRepositoryScope' maxItems: 100 title: scopes type: array webhookId: format: uuid title: webhook_id type: string title: UpdateWebhookRequest type: object gitpod.v1.UpdateWebhookResponse: additionalProperties: false properties: webhook: $ref: '#/components/schemas/gitpod.v1.Webhook' title: webhook title: UpdateWebhookResponse type: object gitpod.v1.UpdateWindow: additionalProperties: false description: "UpdateWindow defines a daily time window (UTC) during which auto-updates are allowed.\n The window must\ \ be at least 2 hours long.\n Overnight windows are supported (e.g., start_hour=22, end_hour=4)." properties: endHour: description: "end_hour is the end of the update window as a UTC hour (0-23).\n If not set, defaults to start_hour\ \ + 2." nullable: true title: end_hour type: integer startHour: description: "start_hour is the beginning of the update window as a UTC hour (0-23).\n +required" nullable: true title: start_hour type: integer title: UpdateWindow type: object gitpod.v1.UpdateWorkflowRequest: additionalProperties: false description: UpdateWorkflowRequest updates a workflow's configuration. properties: action: $ref: '#/components/schemas/gitpod.v1.WorkflowAction' nullable: true title: action description: description: 'Description must be at most 500 characters: ``` size(this) <= 500 ``` ' nullable: true title: description type: string disabled: description: "When set, enables or disables the workflow. A disabled workflow will not\n be triggered by any automatic\ \ trigger and manual starts are rejected." nullable: true title: disabled type: boolean executor: $ref: '#/components/schemas/gitpod.v1.Subject' nullable: true title: executor name: description: 'Name must be between 1 and 80 characters: ``` size(this) >= 1 && size(this) <= 80 ``` ' nullable: true title: name type: string report: $ref: '#/components/schemas/gitpod.v1.WorkflowAction' nullable: true title: report triggers: description: 'Automation can have at most 10 triggers: ``` size(this) <= 10 ``` ' items: $ref: '#/components/schemas/gitpod.v1.WorkflowTrigger' title: triggers type: array workflowId: format: uuid title: workflow_id type: string title: UpdateWorkflowRequest type: object gitpod.v1.UpdateWorkflowResponse: additionalProperties: false properties: workflow: $ref: '#/components/schemas/gitpod.v1.Workflow' title: workflow title: UpdateWorkflowResponse type: object gitpod.v1.UpsertAutomationsFileRequest: additionalProperties: false properties: automationsFile: $ref: '#/components/schemas/gitpod.v1.AutomationsFile' title: automations_file environmentId: format: uuid title: environment_id type: string title: UpsertAutomationsFileRequest type: object gitpod.v1.UpsertAutomationsFileResponse: additionalProperties: false properties: updatedServiceIds: items: type: string title: updated_service_ids type: array updatedTaskIds: items: type: string title: updated_task_ids type: array title: UpsertAutomationsFileResponse type: object gitpod.v1.UsageEventCorrectionResult: additionalProperties: false properties: error: description: Error message if correction failed (e.g., event not found, already cancelled). title: error type: string idempotencyKey: title: idempotency_key type: string success: title: success type: boolean title: UsageEventCorrectionResult type: object gitpod.v1.UsageEventInput: additionalProperties: false properties: eventName: description: 'Must be a known event type: "environment_usage" or "llm_usage".' minLength: 1 title: event_name type: string organizationId: format: uuid title: organization_id type: string payloadJson: description: JSON-encoded payload metadata. Validated per event_name by the service. title: payload_json type: string timestamp: description: "Unix epoch seconds. Raw int64 (not google.protobuf.Timestamp) to match\n the storage model and allow\ \ direct CSV round-tripping." exclusiveMinimum: true minimum: 0 title: timestamp type: string userId: nullable: true title: user_id type: string value: title: value type: string title: UsageEventInput type: object gitpod.v1.UsageEventInsertResult: additionalProperties: false properties: eventName: title: event_name type: string idempotencyKey: description: Generated idempotency key (empty for validation errors before key generation). title: idempotency_key type: string message: description: Error/skip reason (empty for status "ok"). title: message type: string organizationId: description: Original input fields echoed back. title: organization_id type: string payloadJson: title: payload_json type: string status: description: '"ok", "skipped", or "error".' title: status type: string timestamp: description: Unix epoch seconds (echoed from input). title: timestamp type: string userId: title: user_id type: string value: title: value type: string title: UsageEventInsertResult type: object gitpod.v1.UsageType: description: UsageType identifies the category of usage. enum: - USAGE_TYPE_UNSPECIFIED - USAGE_TYPE_ENVIRONMENT - USAGE_TYPE_AGENTIC title: UsageType type: string gitpod.v1.User: additionalProperties: false properties: avatarUrl: description: avatar_url is a link to the user avatar title: avatar_url type: string createdAt: $ref: '#/components/schemas/google.protobuf.Timestamp' description: created_at is the creation time title: created_at email: description: email is the user's email address title: email type: string id: description: id is a UUID of the user format: uuid title: id type: string name: description: name is the full name of the user title: name type: string organizationId: description: "organization_id is the id of the organization this account is owned by.\n\n +optional if not set,\ \ this account is owned by the installation." format: uuid title: organization_id type: string status: $ref: '#/components/schemas/gitpod.v1.UserStatus' description: status is the status the user is in title: status required: - id title: User type: object gitpod.v1.UserCreditUsage: additionalProperties: false description: UserCreditUsage contains a single user's credit usage, broken down by type. properties: displayName: title: display_name type: string usage: items: $ref: '#/components/schemas/gitpod.v1.CreditsByType' title: usage type: array userId: description: Empty when representing the "Others" aggregation bucket. title: user_id type: string title: UserCreditUsage type: object gitpod.v1.UserInputBlock: additionalProperties: false oneOf: - not: anyOf: - required: - text required: - image - not: anyOf: - required: - image required: - text properties: createdAt: $ref: '#/components/schemas/google.protobuf.Timestamp' description: Timestamp when this block was created. Used for debugging and support bundles. title: created_at id: title: id type: string image: $ref: '#/components/schemas/gitpod.v1.UserInputBlock.ImageInput' deprecated: true title: image inputs: items: $ref: '#/components/schemas/gitpod.v1.UserInputBlock.Input' maxItems: 10 title: inputs type: array text: $ref: '#/components/schemas/gitpod.v1.UserInputBlock.TextInput' deprecated: true title: text title: UserInputBlock type: object gitpod.v1.UserInputBlock.ImageInput: additionalProperties: false description: "ImageInput allows sending images to the agent.\n Client must provide the MIME type; backend validates\ \ against magic bytes." properties: data: description: 'Raw image data (max 4MB). Supported formats: PNG, JPEG.' format: byte maxLength: 4194304 minLength: 1 title: data type: string dataRef: description: "Content-addressed reference to offloaded image data.\n Set by the runner when storing in the conversation\ \ store; data is cleared.\n Clients never send this field." title: data_ref type: string x-stainless-skip: true mimeType: enum: - image/png - image/jpeg title: mime_type type: string title: ImageInput type: object gitpod.v1.UserInputBlock.Input: additionalProperties: false oneOf: - not: anyOf: - required: - text required: - image - not: anyOf: - required: - image required: - text properties: image: $ref: '#/components/schemas/gitpod.v1.UserInputBlock.ImageInput' title: image text: $ref: '#/components/schemas/gitpod.v1.UserInputBlock.TextInput' title: text title: Input type: object gitpod.v1.UserInputBlock.TextInput: additionalProperties: false properties: content: minLength: 1 title: content type: string title: TextInput type: object gitpod.v1.UserPreference: additionalProperties: false properties: createdAt: $ref: '#/components/schemas/google.protobuf.Timestamp' title: created_at id: format: uuid title: id type: string key: maxLength: 255 minLength: 1 title: key type: string updatedAt: $ref: '#/components/schemas/google.protobuf.Timestamp' title: updated_at value: description: "omitting value field will cause an error due to min_len validation,\n to unset a preference use DeletePreference\ \ instead" maxLength: 2480 minLength: 1 title: value type: string title: UserPreference type: object gitpod.v1.UserStatus: enum: - USER_STATUS_UNSPECIFIED - USER_STATUS_ACTIVE - USER_STATUS_SUSPENDED - USER_STATUS_LEFT title: UserStatus type: string gitpod.v1.ValidateIntegrationRequest: additionalProperties: false properties: integrationId: minLength: 1 title: integration_id type: string title: ValidateIntegrationRequest type: object gitpod.v1.ValidateIntegrationResponse: additionalProperties: false properties: checks: description: "checks contains the result of every check performed.\n Passing checks have empty message and action_hint." items: $ref: '#/components/schemas/gitpod.v1.ValidationCheck' title: checks type: array valid: description: valid is true when all checks pass (convenience field). title: valid type: boolean title: ValidateIntegrationResponse type: object gitpod.v1.ValidateRunnerConfigurationRequest: additionalProperties: false oneOf: - not: anyOf: - required: - scmIntegration required: - environmentClass - not: anyOf: - required: - environmentClass required: - scmIntegration properties: environmentClass: $ref: '#/components/schemas/gitpod.v1.EnvironmentClass' title: environment_class runnerId: format: uuid title: runner_id type: string scmIntegration: $ref: '#/components/schemas/gitpod.v1.ValidateRunnerConfigurationRequest.ValidateSCMIntegration' title: scm_integration title: ValidateRunnerConfigurationRequest type: object gitpod.v1.ValidateRunnerConfigurationRequest.ValidateSCMIntegration: additionalProperties: false oneOf: - not: anyOf: - required: - oauthPlaintextClientSecret required: - oauthEncryptedClientSecret - not: anyOf: - required: - oauthEncryptedClientSecret required: - oauthPlaintextClientSecret properties: host: title: host type: string id: description: id is the unique identifier of the SCM integration title: id type: string issuerUrl: description: issuer_url can be set to override the authentication provider URL, if it doesn't match the SCM host. nullable: true title: issuer_url type: string oauthClientId: description: "oauth_client_id is the OAuth app's client ID, if OAuth is configured.\n If configured, oauth_client_secret\ \ must also be set." nullable: true title: oauth_client_id type: string oauthEncryptedClientSecret: description: "oauth_encrypted_client_secret is the OAuth app's client secret encrypted with the runner's public\ \ key,\n if OAuth is configured.\n This can be used to e.g. validate an already encrypted client secret of an\ \ existing SCM integration." format: byte title: oauth_encrypted_client_secret type: string oauthPlaintextClientSecret: description: "oauth_plaintext_client_secret is the OAuth app's client secret in clear text, if OAuth is configured.\n\ \ This can be set to validate any new client secret before it is encrypted and stored. This value will\n not be\ \ stored and get encrypted with the runner's public key before passing it to the runner." title: oauth_plaintext_client_secret type: string pat: title: pat type: boolean scmId: description: scm_id references the scm_id in the runner's configuration schema that this integration is for title: scm_id type: string virtualDirectory: description: "virtual_directory is the virtual directory path for Azure DevOps Server (e.g., \"/tfs\").\n This field\ \ is only used for Azure DevOps Server SCM integrations and should be empty for other SCM types.\n Azure DevOps\ \ Server APIs work without collection when PAT scope is 'All accessible organizations'." nullable: true title: virtual_directory type: string title: ValidateSCMIntegration type: object gitpod.v1.ValidateRunnerConfigurationResponse: additionalProperties: false oneOf: - not: anyOf: - required: - scmIntegration required: - environmentClass - not: anyOf: - required: - environmentClass required: - scmIntegration properties: environmentClass: $ref: '#/components/schemas/gitpod.v1.EnvironmentClassValidationResult' title: environment_class scmIntegration: $ref: '#/components/schemas/gitpod.v1.SCMIntegrationValidationResult' title: scm_integration title: ValidateRunnerConfigurationResponse type: object gitpod.v1.ValidationCheck: additionalProperties: false properties: actionHint: description: "Machine-readable hint the frontend uses to resolve the issue (e.g. \"app_installation_oauth\").\n\ \ Empty when the check passes or no automated fix is available." title: action_hint type: string check: $ref: '#/components/schemas/gitpod.v1.ValidationCheck.Check' description: Which check this result is for. title: check documentationUrl: description: "URL to documentation explaining this check failure and resolution steps.\n Empty when the check passes\ \ or no docs exist for this check." title: documentation_url type: string message: description: Human-readable description of the problem. Empty when the check passes. title: message type: string title: ValidationCheck type: object gitpod.v1.ValidationCheck.Check: enum: - CHECK_UNSPECIFIED - CHECK_APP_TOKEN - CHECK_APP_INSTALLATION title: Check type: string gitpod.v1.VerifyDomainRequest: additionalProperties: false properties: domainVerificationId: format: uuid title: domain_verification_id type: string required: - domainVerificationId title: VerifyDomainRequest type: object gitpod.v1.VerifyDomainResponse: additionalProperties: false properties: domainVerification: $ref: '#/components/schemas/gitpod.v1.DomainVerification' title: domain_verification required: - domainVerification title: VerifyDomainResponse type: object gitpod.v1.Veto: additionalProperties: false description: Veto controls kernel-level blocking mechanisms properties: exec: $ref: '#/components/schemas/gitpod.v1.Veto.Exec' description: exec controls executable blocking title: exec title: Veto type: object gitpod.v1.Veto.Exec: additionalProperties: false description: Exec controls executable blocking properties: action: $ref: '#/components/schemas/gitpod.v1.KernelControlsAction' description: action specifies what action kernel-level controls take on policy violations title: action denyBlockDevices: description: "deny_block_devices blocks opening of block devices (S_ISBLK) system-wide\n inside the environment.\ \ Prevents direct disk access. Gated by a feature flag." title: deny_block_devices type: boolean x-stainless-skip: true denylist: description: denylist is the list of executable paths or names to block items: type: string title: denylist type: array enabled: description: enabled controls whether executable blocking is active title: enabled type: boolean resolveBareNames: description: "resolve_bare_names enables the discovery agent to resolve bare executable\n names in the denylist\ \ to full filesystem paths. Gated by a feature flag\n for incremental rollout." title: resolve_bare_names type: boolean x-stainless-skip: true untouchable: description: "untouchable enables file I/O blocking on denylisted files. When true,\n every read()/write() on a\ \ denylisted file is blocked via the\n security_file_permission LSM hook. Gated by a feature flag." title: untouchable type: boolean x-stainless-skip: true watch: description: "watch enables the BPF file watcher that emits events when denylisted\n files are modified, unlinked,\ \ or renamed. Used by the self-healing\n responder to keep the hash denylist up to date." title: watch type: boolean x-stainless-skip: true title: Exec type: object gitpod.v1.VetoExecPolicy: additionalProperties: false description: VetoExecPolicy defines the policy for blocking or auditing executable execution in environments. properties: action: $ref: '#/components/schemas/gitpod.v1.KernelControlsAction' description: action specifies what action kernel-level controls take on policy violations title: action enabled: description: enabled controls whether executable blocking is active title: enabled type: boolean executables: description: executables is the list of executable paths or names to block items: type: string title: executables type: array safelist: description: "Output only. Executable paths that are protected by the safelist and cannot\n be blocked by the denylist.\ \ Populated by the server from the built-in\n default safelist. Ignored on update requests." items: type: string title: safelist type: array x-stainless-skip: true title: VetoExecPolicy type: object gitpod.v1.WakeEvent: additionalProperties: false description: "WakeEvent is sent by the backend to wake an agent when a registered interest fires.\n Delivered via SendToAgentExecution\ \ as a new oneof variant." oneOf: - not: anyOf: - required: - loopRetrigger - required: - timer required: - environment - not: anyOf: - required: - environment - required: - timer required: - loopRetrigger - not: anyOf: - required: - environment - required: - loopRetrigger required: - timer properties: environment: $ref: '#/components/schemas/gitpod.v1.WakeEvent.EnvironmentPhaseReached' title: environment interestId: description: The interest ID that fired (from WaitingInfo.Interest.id). title: interest_id type: string loopRetrigger: $ref: '#/components/schemas/gitpod.v1.WakeEvent.LoopRetrigger' title: loop_retrigger timer: $ref: '#/components/schemas/gitpod.v1.WakeEvent.TimerFired' title: timer title: WakeEvent type: object gitpod.v1.WakeEvent.EnvironmentPhaseReached: additionalProperties: false properties: environmentId: title: environment_id type: string failureMessage: items: type: string title: failure_message type: array phase: description: The phase the environment reached (e.g. "running", "stopped", "deleted"). title: phase type: string title: EnvironmentPhaseReached type: object gitpod.v1.WakeEvent.LoopRetrigger: additionalProperties: false properties: outputs: additionalProperties: title: value type: string title: outputs type: object unmetConditions: items: $ref: '#/components/schemas/gitpod.v1.WakeEvent.LoopRetrigger.UnmetCondition' title: unmet_conditions type: array title: LoopRetrigger type: object gitpod.v1.WakeEvent.LoopRetrigger.OutputsEntry: additionalProperties: false properties: key: title: key type: string value: title: value type: string title: OutputsEntry type: object gitpod.v1.WakeEvent.LoopRetrigger.UnmetCondition: additionalProperties: false properties: description: title: description type: string expression: title: expression type: string id: title: id type: string iteration: format: int32 title: iteration type: integer maxIterations: format: int32 title: max_iterations type: integer reason: title: reason type: string title: UnmetCondition type: object gitpod.v1.WakeEvent.TimerFired: additionalProperties: false properties: firedAt: $ref: '#/components/schemas/google.protobuf.Timestamp' description: The actual time the timer was evaluated as expired. title: fired_at title: TimerFired type: object gitpod.v1.WarmPool: additionalProperties: false description: "WarmPool maintains pre-created environment instances from a prebuild snapshot\n for near-instant environment\ \ startup.\n One warm pool exists per pair." properties: id: description: id is the unique identifier for the warm pool format: uuid title: id type: string metadata: $ref: '#/components/schemas/gitpod.v1.WarmPoolMetadata' description: metadata contains organizational and ownership information title: metadata spec: $ref: '#/components/schemas/gitpod.v1.WarmPoolSpec' description: spec contains the desired configuration for this warm pool title: spec status: $ref: '#/components/schemas/gitpod.v1.WarmPoolStatus' description: status contains the current status reported by the runner title: status required: - metadata - spec - status title: WarmPool type: object gitpod.v1.WarmPoolMetadata: additionalProperties: false description: WarmPoolMetadata contains metadata about the warm pool properties: createdAt: $ref: '#/components/schemas/google.protobuf.Timestamp' description: created_at is when the warm pool was created title: created_at environmentClassId: description: environment_class_id is the environment class whose instances are warmed format: uuid title: environment_class_id type: string organizationId: description: organization_id is the ID of the organization that owns the warm pool format: uuid title: organization_id type: string projectId: description: project_id is the ID of the project this warm pool belongs to format: uuid title: project_id type: string runnerId: description: "runner_id is the runner that manages this warm pool.\n Derived from the environment class." format: uuid title: runner_id type: string updatedAt: $ref: '#/components/schemas/google.protobuf.Timestamp' description: updated_at is when the warm pool was last updated title: updated_at required: - createdAt - updatedAt title: WarmPoolMetadata type: object gitpod.v1.WarmPoolPhase: description: WarmPoolPhase represents the lifecycle phase of a warm pool enum: - WARM_POOL_PHASE_UNSPECIFIED - WARM_POOL_PHASE_PENDING - WARM_POOL_PHASE_READY - WARM_POOL_PHASE_DEGRADED - WARM_POOL_PHASE_DELETING - WARM_POOL_PHASE_DELETED title: WarmPoolPhase type: string gitpod.v1.WarmPoolSpec: additionalProperties: false description: WarmPoolSpec contains the desired configuration for a warm pool properties: desiredPhase: $ref: '#/components/schemas/gitpod.v1.WarmPoolPhase' description: "desired_phase is the intended lifecycle phase for this warm pool.\n Managed by the API and reconciler." title: desired_phase desiredSize: deprecated: true description: "desired_size is the number of warm instances to maintain.\n Deprecated: Use min_size and max_size\ \ instead for dynamic scaling.\n Existing pools will be migrated to min_size=max_size=desired_size." format: int32 maximum: 20 minimum: 1 title: desired_size type: integer maxSize: description: "max_size is the maximum number of warm instances to maintain.\n The pool will never scale above this\ \ value.\n Must be >= min_size and <= 20." format: int32 maximum: 20 minimum: 1 nullable: true title: max_size type: integer minSize: description: "min_size is the minimum number of warm instances to maintain.\n The pool will never scale below this\ \ value.\n Must be >= 0 and <= max_size. Set to 0 to allow full scale-down." format: int32 maximum: 20 nullable: true title: min_size type: integer snapshotId: description: "snapshot_id is the prebuild snapshot to warm up in the pool.\n Updated by the reconciler when a new\ \ prebuild completes for this\n project and environment class. Empty when no completed prebuild exists yet." format: uuid nullable: true title: snapshot_id type: string specVersion: description: "spec_version is incremented each time the spec is updated.\n Used for optimistic concurrency control." title: spec_version type: string title: WarmPoolSpec type: object gitpod.v1.WarmPoolStatus: additionalProperties: false description: WarmPoolStatus contains the current status of a warm pool as reported by the runner properties: desiredSize: description: "desired_size is the current target number of instances the autoscaler\n has decided on. Unlike running_instances,\ \ this value is stable and\n does not fluctuate as instances are claimed and backfilled." format: int32 title: desired_size type: integer failureMessage: description: failure_message contains details about why the warm pool is degraded or failed title: failure_message type: string phase: $ref: '#/components/schemas/gitpod.v1.WarmPoolPhase' description: phase is the current phase of the warm pool lifecycle title: phase runningInstances: description: "running_instances is the number of running warm instances in the pool,\n ready to be claimed for near-instant\ \ environment startup." format: int32 title: running_instances type: integer statusVersion: description: "status_version is incremented each time the status is updated.\n Used for optimistic concurrency control." title: status_version type: string stoppedInstances: description: "stopped_instances is the number of pre-provisioned but stopped instances\n in the pool. When a running\ \ instance is claimed, stopped instances are\n used to backfill the running pool faster than provisioning from\ \ scratch.\n Stopped instances only incur storage costs, allowing a larger total pool\n at lower cost than keeping\ \ all instances running." format: int32 title: stopped_instances type: integer required: - phase title: WarmPoolStatus type: object gitpod.v1.WatchEventsRequest: additionalProperties: false oneOf: - not: anyOf: - required: - organization required: - environmentId - not: anyOf: - required: - environmentId required: - organization properties: environmentId: description: "Environment scope produces events for the environment itself, all tasks, task executions,\n and services\ \ associated with that environment." title: environment_id type: string organization: description: "Organization scope produces events for all projects, runners and environments\n the caller can see\ \ within their organization. No task, task execution or service events\n are produed." title: organization type: boolean resourceTypeFilters: description: "Filters to limit which events are delivered on organization-scoped streams.\n When empty, all events\ \ for the scope are delivered.\n When populated, only events matching at least one filter entry are forwarded.\n\ \ Not supported for environment-scoped streams; setting this field returns an error." items: $ref: '#/components/schemas/gitpod.v1.WatchEventsRequest.ResourceTypeFilter' maxItems: 50 title: resource_type_filters type: array title: WatchEventsRequest type: object gitpod.v1.WatchEventsRequest.ResourceTypeFilter: additionalProperties: false description: ResourceTypeFilter restricts which events are delivered for a specific resource type. properties: creatorIds: description: "If non-empty, only events where the resource was created by one of these user IDs\n are delivered.\ \ Skipped for DELETE operations (creator info is unavailable after deletion).\n Events with no creator information\ \ are skipped when this filter is set (fail-closed)." items: format: uuid maxItems: 25 type: string maxItems: 25 title: creator_ids type: array resourceIds: description: If non-empty, only events for these specific resource IDs are delivered. items: format: uuid maxItems: 25 type: string maxItems: 25 title: resource_ids type: array resourceType: $ref: '#/components/schemas/gitpod.v1.ResourceType' description: The resource type to filter for. not: enum: - 0 title: resource_type title: ResourceTypeFilter type: object gitpod.v1.WatchEventsResponse: additionalProperties: false properties: operation: $ref: '#/components/schemas/gitpod.v1.ResourceOperation' title: operation resourceId: format: uuid title: resource_id type: string resourceType: $ref: '#/components/schemas/gitpod.v1.ResourceType' title: resource_type title: WatchEventsResponse type: object gitpod.v1.WatchManagedRunnersRequest: additionalProperties: false properties: empty: type: boolean title: WatchManagedRunnersRequest type: object gitpod.v1.WatchManagedRunnersResponse: additionalProperties: false properties: eventType: $ref: '#/components/schemas/gitpod.v1.WatchManagedRunnersResponse.EventType' description: The type of event that occurred title: event_type runnerId: description: The runner's ID format: uuid title: runner_id type: string title: WatchManagedRunnersResponse type: object gitpod.v1.WatchManagedRunnersResponse.EventType: enum: - EVENT_TYPE_UNSPECIFIED - EVENT_TYPE_CREATED - EVENT_TYPE_DELETED - EVENT_TYPE_HIBERNATED - EVENT_TYPE_WAKE title: EventType type: string gitpod.v1.WatchRequestsRequest: additionalProperties: false properties: runnerId: description: The runner's identity format: uuid title: runner_id type: string title: WatchRequestsRequest type: object gitpod.v1.WatchRequestsResponse: additionalProperties: false oneOf: - not: anyOf: - required: - callCheckRepositoryAccess - required: - callImprovePromptForAgent - required: - callListScmOrganizations - required: - callParseContext - required: - callPing - required: - callSearchRepositories - required: - callSendMessageToAgentExecution - required: - callValidateConfig - required: - eventAgentExecutionSpecChange - required: - eventEnvironmentMarkedActive - required: - eventEnvironmentSpecChange - required: - eventHostAuthenticationTokenDeleted - required: - eventIntegrationChange - required: - eventLlmIntegrationChange - required: - eventRunnerConfigurationChange - required: - eventScmIntegrationChange - required: - eventSnapshotSpecChange - required: - eventWarmPoolSpecChange required: - callCheckAuthenticationForHost - not: anyOf: - required: - callCheckAuthenticationForHost - required: - callImprovePromptForAgent - required: - callListScmOrganizations - required: - callParseContext - required: - callPing - required: - callSearchRepositories - required: - callSendMessageToAgentExecution - required: - callValidateConfig - required: - eventAgentExecutionSpecChange - required: - eventEnvironmentMarkedActive - required: - eventEnvironmentSpecChange - required: - eventHostAuthenticationTokenDeleted - required: - eventIntegrationChange - required: - eventLlmIntegrationChange - required: - eventRunnerConfigurationChange - required: - eventScmIntegrationChange - required: - eventSnapshotSpecChange - required: - eventWarmPoolSpecChange required: - callCheckRepositoryAccess - not: anyOf: - required: - callCheckAuthenticationForHost - required: - callCheckRepositoryAccess - required: - callListScmOrganizations - required: - callParseContext - required: - callPing - required: - callSearchRepositories - required: - callSendMessageToAgentExecution - required: - callValidateConfig - required: - eventAgentExecutionSpecChange - required: - eventEnvironmentMarkedActive - required: - eventEnvironmentSpecChange - required: - eventHostAuthenticationTokenDeleted - required: - eventIntegrationChange - required: - eventLlmIntegrationChange - required: - eventRunnerConfigurationChange - required: - eventScmIntegrationChange - required: - eventSnapshotSpecChange - required: - eventWarmPoolSpecChange required: - callImprovePromptForAgent - not: anyOf: - required: - callCheckAuthenticationForHost - required: - callCheckRepositoryAccess - required: - callImprovePromptForAgent - required: - callParseContext - required: - callPing - required: - callSearchRepositories - required: - callSendMessageToAgentExecution - required: - callValidateConfig - required: - eventAgentExecutionSpecChange - required: - eventEnvironmentMarkedActive - required: - eventEnvironmentSpecChange - required: - eventHostAuthenticationTokenDeleted - required: - eventIntegrationChange - required: - eventLlmIntegrationChange - required: - eventRunnerConfigurationChange - required: - eventScmIntegrationChange - required: - eventSnapshotSpecChange - required: - eventWarmPoolSpecChange required: - callListScmOrganizations - not: anyOf: - required: - callCheckAuthenticationForHost - required: - callCheckRepositoryAccess - required: - callImprovePromptForAgent - required: - callListScmOrganizations - required: - callPing - required: - callSearchRepositories - required: - callSendMessageToAgentExecution - required: - callValidateConfig - required: - eventAgentExecutionSpecChange - required: - eventEnvironmentMarkedActive - required: - eventEnvironmentSpecChange - required: - eventHostAuthenticationTokenDeleted - required: - eventIntegrationChange - required: - eventLlmIntegrationChange - required: - eventRunnerConfigurationChange - required: - eventScmIntegrationChange - required: - eventSnapshotSpecChange - required: - eventWarmPoolSpecChange required: - callParseContext - not: anyOf: - required: - callCheckAuthenticationForHost - required: - callCheckRepositoryAccess - required: - callImprovePromptForAgent - required: - callListScmOrganizations - required: - callParseContext - required: - callSearchRepositories - required: - callSendMessageToAgentExecution - required: - callValidateConfig - required: - eventAgentExecutionSpecChange - required: - eventEnvironmentMarkedActive - required: - eventEnvironmentSpecChange - required: - eventHostAuthenticationTokenDeleted - required: - eventIntegrationChange - required: - eventLlmIntegrationChange - required: - eventRunnerConfigurationChange - required: - eventScmIntegrationChange - required: - eventSnapshotSpecChange - required: - eventWarmPoolSpecChange required: - callPing - not: anyOf: - required: - callCheckAuthenticationForHost - required: - callCheckRepositoryAccess - required: - callImprovePromptForAgent - required: - callListScmOrganizations - required: - callParseContext - required: - callPing - required: - callSendMessageToAgentExecution - required: - callValidateConfig - required: - eventAgentExecutionSpecChange - required: - eventEnvironmentMarkedActive - required: - eventEnvironmentSpecChange - required: - eventHostAuthenticationTokenDeleted - required: - eventIntegrationChange - required: - eventLlmIntegrationChange - required: - eventRunnerConfigurationChange - required: - eventScmIntegrationChange - required: - eventSnapshotSpecChange - required: - eventWarmPoolSpecChange required: - callSearchRepositories - not: anyOf: - required: - callCheckAuthenticationForHost - required: - callCheckRepositoryAccess - required: - callImprovePromptForAgent - required: - callListScmOrganizations - required: - callParseContext - required: - callPing - required: - callSearchRepositories - required: - callValidateConfig - required: - eventAgentExecutionSpecChange - required: - eventEnvironmentMarkedActive - required: - eventEnvironmentSpecChange - required: - eventHostAuthenticationTokenDeleted - required: - eventIntegrationChange - required: - eventLlmIntegrationChange - required: - eventRunnerConfigurationChange - required: - eventScmIntegrationChange - required: - eventSnapshotSpecChange - required: - eventWarmPoolSpecChange required: - callSendMessageToAgentExecution - not: anyOf: - required: - callCheckAuthenticationForHost - required: - callCheckRepositoryAccess - required: - callImprovePromptForAgent - required: - callListScmOrganizations - required: - callParseContext - required: - callPing - required: - callSearchRepositories - required: - callSendMessageToAgentExecution - required: - eventAgentExecutionSpecChange - required: - eventEnvironmentMarkedActive - required: - eventEnvironmentSpecChange - required: - eventHostAuthenticationTokenDeleted - required: - eventIntegrationChange - required: - eventLlmIntegrationChange - required: - eventRunnerConfigurationChange - required: - eventScmIntegrationChange - required: - eventSnapshotSpecChange - required: - eventWarmPoolSpecChange required: - callValidateConfig - not: anyOf: - required: - callCheckAuthenticationForHost - required: - callCheckRepositoryAccess - required: - callImprovePromptForAgent - required: - callListScmOrganizations - required: - callParseContext - required: - callPing - required: - callSearchRepositories - required: - callSendMessageToAgentExecution - required: - callValidateConfig - required: - eventEnvironmentMarkedActive - required: - eventEnvironmentSpecChange - required: - eventHostAuthenticationTokenDeleted - required: - eventIntegrationChange - required: - eventLlmIntegrationChange - required: - eventRunnerConfigurationChange - required: - eventScmIntegrationChange - required: - eventSnapshotSpecChange - required: - eventWarmPoolSpecChange required: - eventAgentExecutionSpecChange - not: anyOf: - required: - callCheckAuthenticationForHost - required: - callCheckRepositoryAccess - required: - callImprovePromptForAgent - required: - callListScmOrganizations - required: - callParseContext - required: - callPing - required: - callSearchRepositories - required: - callSendMessageToAgentExecution - required: - callValidateConfig - required: - eventAgentExecutionSpecChange - required: - eventEnvironmentSpecChange - required: - eventHostAuthenticationTokenDeleted - required: - eventIntegrationChange - required: - eventLlmIntegrationChange - required: - eventRunnerConfigurationChange - required: - eventScmIntegrationChange - required: - eventSnapshotSpecChange - required: - eventWarmPoolSpecChange required: - eventEnvironmentMarkedActive - not: anyOf: - required: - callCheckAuthenticationForHost - required: - callCheckRepositoryAccess - required: - callImprovePromptForAgent - required: - callListScmOrganizations - required: - callParseContext - required: - callPing - required: - callSearchRepositories - required: - callSendMessageToAgentExecution - required: - callValidateConfig - required: - eventAgentExecutionSpecChange - required: - eventEnvironmentMarkedActive - required: - eventHostAuthenticationTokenDeleted - required: - eventIntegrationChange - required: - eventLlmIntegrationChange - required: - eventRunnerConfigurationChange - required: - eventScmIntegrationChange - required: - eventSnapshotSpecChange - required: - eventWarmPoolSpecChange required: - eventEnvironmentSpecChange - not: anyOf: - required: - callCheckAuthenticationForHost - required: - callCheckRepositoryAccess - required: - callImprovePromptForAgent - required: - callListScmOrganizations - required: - callParseContext - required: - callPing - required: - callSearchRepositories - required: - callSendMessageToAgentExecution - required: - callValidateConfig - required: - eventAgentExecutionSpecChange - required: - eventEnvironmentMarkedActive - required: - eventEnvironmentSpecChange - required: - eventIntegrationChange - required: - eventLlmIntegrationChange - required: - eventRunnerConfigurationChange - required: - eventScmIntegrationChange - required: - eventSnapshotSpecChange - required: - eventWarmPoolSpecChange required: - eventHostAuthenticationTokenDeleted - not: anyOf: - required: - callCheckAuthenticationForHost - required: - callCheckRepositoryAccess - required: - callImprovePromptForAgent - required: - callListScmOrganizations - required: - callParseContext - required: - callPing - required: - callSearchRepositories - required: - callSendMessageToAgentExecution - required: - callValidateConfig - required: - eventAgentExecutionSpecChange - required: - eventEnvironmentMarkedActive - required: - eventEnvironmentSpecChange - required: - eventHostAuthenticationTokenDeleted - required: - eventLlmIntegrationChange - required: - eventRunnerConfigurationChange - required: - eventScmIntegrationChange - required: - eventSnapshotSpecChange - required: - eventWarmPoolSpecChange required: - eventIntegrationChange - not: anyOf: - required: - callCheckAuthenticationForHost - required: - callCheckRepositoryAccess - required: - callImprovePromptForAgent - required: - callListScmOrganizations - required: - callParseContext - required: - callPing - required: - callSearchRepositories - required: - callSendMessageToAgentExecution - required: - callValidateConfig - required: - eventAgentExecutionSpecChange - required: - eventEnvironmentMarkedActive - required: - eventEnvironmentSpecChange - required: - eventHostAuthenticationTokenDeleted - required: - eventIntegrationChange - required: - eventRunnerConfigurationChange - required: - eventScmIntegrationChange - required: - eventSnapshotSpecChange - required: - eventWarmPoolSpecChange required: - eventLlmIntegrationChange - not: anyOf: - required: - callCheckAuthenticationForHost - required: - callCheckRepositoryAccess - required: - callImprovePromptForAgent - required: - callListScmOrganizations - required: - callParseContext - required: - callPing - required: - callSearchRepositories - required: - callSendMessageToAgentExecution - required: - callValidateConfig - required: - eventAgentExecutionSpecChange - required: - eventEnvironmentMarkedActive - required: - eventEnvironmentSpecChange - required: - eventHostAuthenticationTokenDeleted - required: - eventIntegrationChange - required: - eventLlmIntegrationChange - required: - eventScmIntegrationChange - required: - eventSnapshotSpecChange - required: - eventWarmPoolSpecChange required: - eventRunnerConfigurationChange - not: anyOf: - required: - callCheckAuthenticationForHost - required: - callCheckRepositoryAccess - required: - callImprovePromptForAgent - required: - callListScmOrganizations - required: - callParseContext - required: - callPing - required: - callSearchRepositories - required: - callSendMessageToAgentExecution - required: - callValidateConfig - required: - eventAgentExecutionSpecChange - required: - eventEnvironmentMarkedActive - required: - eventEnvironmentSpecChange - required: - eventHostAuthenticationTokenDeleted - required: - eventIntegrationChange - required: - eventLlmIntegrationChange - required: - eventRunnerConfigurationChange - required: - eventSnapshotSpecChange - required: - eventWarmPoolSpecChange required: - eventScmIntegrationChange - not: anyOf: - required: - callCheckAuthenticationForHost - required: - callCheckRepositoryAccess - required: - callImprovePromptForAgent - required: - callListScmOrganizations - required: - callParseContext - required: - callPing - required: - callSearchRepositories - required: - callSendMessageToAgentExecution - required: - callValidateConfig - required: - eventAgentExecutionSpecChange - required: - eventEnvironmentMarkedActive - required: - eventEnvironmentSpecChange - required: - eventHostAuthenticationTokenDeleted - required: - eventIntegrationChange - required: - eventLlmIntegrationChange - required: - eventRunnerConfigurationChange - required: - eventScmIntegrationChange - required: - eventWarmPoolSpecChange required: - eventSnapshotSpecChange - not: anyOf: - required: - callCheckAuthenticationForHost - required: - callCheckRepositoryAccess - required: - callImprovePromptForAgent - required: - callListScmOrganizations - required: - callParseContext - required: - callPing - required: - callSearchRepositories - required: - callSendMessageToAgentExecution - required: - callValidateConfig - required: - eventAgentExecutionSpecChange - required: - eventEnvironmentMarkedActive - required: - eventEnvironmentSpecChange - required: - eventHostAuthenticationTokenDeleted - required: - eventIntegrationChange - required: - eventLlmIntegrationChange - required: - eventRunnerConfigurationChange - required: - eventScmIntegrationChange - required: - eventSnapshotSpecChange required: - eventWarmPoolSpecChange properties: callCheckAuthenticationForHost: $ref: '#/components/schemas/gitpod.v1.CallCheckAuthenticationForHost.Request' title: call_check_authentication_for_host callCheckRepositoryAccess: $ref: '#/components/schemas/gitpod.v1.CallCheckRepositoryAccess.Request' title: call_check_repository_access callImprovePromptForAgent: $ref: '#/components/schemas/gitpod.v1.CallImprovePromptForAgent.Request' title: call_improve_prompt_for_agent callListScmOrganizations: $ref: '#/components/schemas/gitpod.v1.CallListSCMOrganizations.Request' title: call_list_scm_organizations callParseContext: $ref: '#/components/schemas/gitpod.v1.CallParseContext.Request' title: call_parse_context callPing: $ref: '#/components/schemas/gitpod.v1.CallPing.Request' title: call_ping callSearchRepositories: $ref: '#/components/schemas/gitpod.v1.CallSearchRepositories.Request' title: call_search_repositories callSendMessageToAgentExecution: $ref: '#/components/schemas/gitpod.v1.CallSendMessageToAgentExecution.Request' title: call_send_message_to_agent_execution callValidateConfig: $ref: '#/components/schemas/gitpod.v1.CallValidateConfig.Request' title: call_validate_config eventAgentExecutionSpecChange: $ref: '#/components/schemas/gitpod.v1.EventAgentExecutionSpecChange' title: event_agent_execution_spec_change eventEnvironmentMarkedActive: $ref: '#/components/schemas/gitpod.v1.EventEnvironmentMarkedActive' title: event_environment_marked_active eventEnvironmentSpecChange: $ref: '#/components/schemas/gitpod.v1.EventEnvironmentSpecChange' title: event_environment_spec_change eventHostAuthenticationTokenDeleted: $ref: '#/components/schemas/gitpod.v1.EventHostAuthenticationTokenDeleted' title: event_host_authentication_token_deleted eventIntegrationChange: $ref: '#/components/schemas/gitpod.v1.EventIntegrationChange' title: event_integration_change eventLlmIntegrationChange: $ref: '#/components/schemas/gitpod.v1.EventLLMIntegrationChange' title: event_llm_integration_change eventRunnerConfigurationChange: $ref: '#/components/schemas/gitpod.v1.EventRunnerConfigurationChange' title: event_runner_configuration_change eventScmIntegrationChange: $ref: '#/components/schemas/gitpod.v1.EventSCMIntegrationChange' title: event_scm_integration_change eventSnapshotSpecChange: $ref: '#/components/schemas/gitpod.v1.EventSnapshotSpecChange' title: event_snapshot_spec_change eventWarmPoolSpecChange: $ref: '#/components/schemas/gitpod.v1.EventWarmPoolSpecChange' title: event_warm_pool_spec_change requestId: description: The request's ID format: uuid title: request_id type: string title: WatchRequestsResponse type: object gitpod.v1.Webhook: additionalProperties: false description: Webhook represents a webhook endpoint for receiving SCM events. properties: boundWorkflowCount: description: "bound_workflow_count is the number of workflows bound to this webhook\n Read-only, computed from workflow_webhook_bindings" format: int32 title: bound_workflow_count type: integer id: description: id is the unique identifier of the webhook format: uuid title: id type: string lastTriggeredAt: $ref: '#/components/schemas/google.protobuf.Timestamp' description: "last_triggered_at is when the webhook was last triggered by an incoming event\n Read-only, updated\ \ automatically when the webhook receives an event" title: last_triggered_at metadata: $ref: '#/components/schemas/gitpod.v1.Webhook.Metadata' description: metadata contains organizational and ownership information title: metadata spec: $ref: '#/components/schemas/gitpod.v1.Webhook.Spec' description: spec contains the webhook configuration title: spec url: description: "url is the generated webhook endpoint URL\n Format: https://{domain}/webhooks/{id}\n Read-only, computed\ \ from id" title: url type: string title: Webhook type: object gitpod.v1.Webhook.Metadata: additionalProperties: false description: Metadata contains organizational and ownership information. properties: createdAt: $ref: '#/components/schemas/google.protobuf.Timestamp' description: created_at is when the webhook was created title: created_at creator: $ref: '#/components/schemas/gitpod.v1.Subject' description: creator is the identity of who created the webhook title: creator description: description: description is an optional description of the webhook's purpose title: description type: string name: description: name is the display name of the webhook title: name type: string organizationId: description: organization_id is the ID of the organization that owns this webhook format: uuid title: organization_id type: string updatedAt: $ref: '#/components/schemas/google.protobuf.Timestamp' description: updated_at is when the webhook was last updated title: updated_at title: Metadata type: object gitpod.v1.Webhook.Spec: additionalProperties: false description: Spec contains the webhook configuration. properties: organizationScope: $ref: '#/components/schemas/gitpod.v1.WebhookOrganizationScope' description: "organization_scope is the SCM organization scope for this webhook.\n For ORGANIZATION type: identifies\ \ the organization and its SCM host.\n When set, takes precedence over the deprecated scope field." title: organization_scope provider: $ref: '#/components/schemas/gitpod.v1.WebhookProvider' description: provider is the Git provider (github, gitlab) title: provider scope: deprecated: true description: "Deprecated: Use scopes instead. Kept for backward compatibility.\n scope is the target of the webhook:\n\ \ - For REPOSITORY type: \"owner/repo\" (e.g., \"gitpod-io/gitpod\")\n - For ORGANIZATION type: \"owner\" (e.g.,\ \ \"gitpod-io\")" title: scope type: string scopes: description: "scopes is the list of repository scopes for this webhook.\n For REPOSITORY type: each entry represents\ \ a specific repository.\n When scopes is non-empty, it takes precedence over the deprecated scope field." items: $ref: '#/components/schemas/gitpod.v1.WebhookRepositoryScope' maxItems: 100 title: scopes type: array type: $ref: '#/components/schemas/gitpod.v1.WebhookType' description: type determines the scope level of the webhook title: type title: Spec type: object gitpod.v1.WebhookOrganizationScope: additionalProperties: false description: WebhookOrganizationScope represents an SCM organization in the webhook's scope. properties: host: description: host is the SCM host (e.g., "github.com", "gitlab.com") minLength: 1 title: host type: string name: description: name is the organization or group name (e.g., "gitpod-io") minLength: 1 title: name type: string title: WebhookOrganizationScope type: object gitpod.v1.WebhookProvider: description: WebhookProvider identifies the Git provider. enum: - WEBHOOK_PROVIDER_UNSPECIFIED - WEBHOOK_PROVIDER_GITHUB - WEBHOOK_PROVIDER_GITLAB title: WebhookProvider type: string gitpod.v1.WebhookRepositoryScope: additionalProperties: false description: "WebhookRepositoryScope represents a repository in the webhook's scope.\n Contains SCM repository information\ \ needed to generate execution contexts.\n The clone URL can be derived as https://{host}/{owner}/{name}.git" properties: host: description: host is the SCM host (e.g., "github.com", "gitlab.com") minLength: 1 title: host type: string name: description: name is the repository name (e.g., "gitpod") minLength: 1 title: name type: string owner: description: owner is the repository owner or organization (e.g., "gitpod-io") minLength: 1 title: owner type: string title: WebhookRepositoryScope type: object gitpod.v1.WebhookType: description: WebhookType determines the scope level of the webhook. enum: - WEBHOOK_TYPE_UNSPECIFIED - WEBHOOK_TYPE_SCM_REPOSITORY - WEBHOOK_TYPE_SCM_ORGANIZATION title: WebhookType type: string gitpod.v1.Workflow: additionalProperties: false description: Workflow represents a workflow configuration. properties: id: format: uuid title: id type: string metadata: $ref: '#/components/schemas/gitpod.v1.Workflow.Metadata' title: metadata spec: $ref: '#/components/schemas/gitpod.v1.Workflow.Spec' title: spec webhookUrl: description: "Webhook URL for triggering this workflow via HTTP POST\n Format: {base_url}/workflows/{workflow_id}/webhooks" title: webhook_url type: string title: Workflow type: object 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.Workflow.Spec: additionalProperties: false properties: action: $ref: '#/components/schemas/gitpod.v1.WorkflowAction' title: action deleting: description: Marks workflow as pending deletion title: deleting type: boolean x-stainless-skip: true disabled: description: "When true, the workflow will not be triggered by any automatic trigger\n (cron, webhook, pull request).\ \ Manual starts via StartWorkflow are also\n rejected while disabled." title: disabled type: boolean x-stainless-skip: true report: $ref: '#/components/schemas/gitpod.v1.WorkflowAction' title: report triggers: items: $ref: '#/components/schemas/gitpod.v1.WorkflowTrigger' title: triggers type: array title: Spec type: object gitpod.v1.WorkflowAction: additionalProperties: false description: WorkflowAction defines the actions to be executed in a workflow. properties: limits: $ref: '#/components/schemas/gitpod.v1.WorkflowAction.Limits' title: limits steps: description: 'Automation must have between 1 and 50 steps: ``` size(this) >= 1 && size(this) <= 50 ``` ' items: $ref: '#/components/schemas/gitpod.v1.WorkflowStep' title: steps type: array required: - limits title: WorkflowAction type: object gitpod.v1.WorkflowAction.Limits: additionalProperties: false description: 'Limits defines execution limits for workflow actions. Concurrent actions limit cannot exceed total actions limit: ``` this.max_parallel <= this.max_total ``` ' properties: maxParallel: description: 'Maximum parallel actions must be between 1 and 25: ``` this >= 1 && this <= 25 ``` ' format: int32 title: max_parallel type: integer maxTotal: description: 'Maximum total actions must be between 1 and 100: ``` this >= 1 && this <= 100 ``` ' format: int32 title: max_total type: integer perExecution: $ref: '#/components/schemas/gitpod.v1.WorkflowAction.Limits.PerExecution' title: per_execution title: Limits type: object gitpod.v1.WorkflowAction.Limits.PerExecution: additionalProperties: false description: PerExecution defines limits per execution action. properties: maxTime: $ref: '#/components/schemas/google.protobuf.Duration' description: "Maximum time allowed for a single execution action.\n Use standard duration format (e.g., \"30m\"\ \ for 30 minutes, \"2h\" for 2 hours)." title: max_time title: PerExecution 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. nullable: true title: retry title: WorkflowError type: object gitpod.v1.WorkflowError.MetaEntry: additionalProperties: false properties: key: title: key type: string value: title: value type: string title: MetaEntry type: object gitpod.v1.WorkflowError.Retry: additionalProperties: false description: Retry configuration for the error. properties: retriable: description: Whether the error is retriable. title: retriable type: boolean retryAfter: $ref: '#/components/schemas/google.protobuf.Duration' description: "Suggested duration to wait before retrying.\n Only meaningful when retriable is true." title: retry_after title: Retry type: object gitpod.v1.WorkflowErrorCode: description: "WorkflowErrorCode defines error codes specific to workflows.\n These codes help distinguish retriable\ \ vs non-retriable errors and provide actionable information\n to both the reconciler and the frontend.\n\n Error\ \ code ranges:\n - 0: Unspecified\n - 1-999: Reserved for future use\n - 1000-1999: Environment-related errors\n -\ \ 2000-2999: Agent-related errors\n - 3000-3999: Resource-related errors" enum: - WORKFLOW_ERROR_CODE_UNSPECIFIED - WORKFLOW_ERROR_CODE_ENVIRONMENT_ERROR - WORKFLOW_ERROR_CODE_AGENT_ERROR title: WorkflowErrorCode type: string gitpod.v1.WorkflowExecution: additionalProperties: false description: WorkflowExecution represents a workflow execution instance. properties: id: format: uuid title: id type: string metadata: $ref: '#/components/schemas/gitpod.v1.WorkflowExecution.Metadata' title: metadata spec: $ref: '#/components/schemas/gitpod.v1.WorkflowExecution.Spec' title: spec status: $ref: '#/components/schemas/gitpod.v1.WorkflowExecution.Status' title: status title: WorkflowExecution type: object gitpod.v1.WorkflowExecution.Metadata: additionalProperties: false description: WorkflowExecutionMetadata contains workflow execution metadata. properties: creator: $ref: '#/components/schemas/gitpod.v1.Subject' title: creator executor: $ref: '#/components/schemas/gitpod.v1.Subject' title: executor finishedAt: $ref: '#/components/schemas/google.protobuf.Timestamp' title: finished_at startedAt: $ref: '#/components/schemas/google.protobuf.Timestamp' title: started_at workflowId: format: uuid title: workflow_id type: string title: Metadata 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.WorkflowExecution.Status: additionalProperties: false description: WorkflowExecutionStatus contains the current status of a workflow execution. properties: doneActionCount: format: int32 title: done_action_count type: integer failedActionCount: format: int32 title: failed_action_count type: integer failureMessage: description: "FailureMessage summarises why the workflow execution failed to operate. If this is non-empty\n the\ \ workflow execution has failed to operate and will likely transition to a stopped state.\n Deprecated: Use errors\ \ field instead for structured error information." title: failure_message type: string x-stainless-skip: true failures: description: "Structured failures that caused the workflow execution to fail.\n Provides detailed error codes, messages,\ \ and retry information." items: $ref: '#/components/schemas/gitpod.v1.WorkflowError' title: failures type: array pendingActionCount: format: int32 title: pending_action_count type: integer phase: $ref: '#/components/schemas/gitpod.v1.WorkflowExecutionPhase' title: phase runningActionCount: format: int32 title: running_action_count type: integer session: title: session type: string x-stainless-skip: true stoppedActionCount: format: int32 title: stopped_action_count type: integer warningMessage: description: "WarningMessage summarises why the workflow execution is in a warning state. If this is non-empty\n\ \ the workflow execution is in a warning state and likely does not match the users expectations.\n Deprecated:\ \ Use warnings field instead for structured warning information." title: warning_message type: string x-stainless-skip: true warnings: description: "Structured warnings about the workflow execution.\n Provides detailed warning codes and messages." items: $ref: '#/components/schemas/gitpod.v1.WorkflowError' title: warnings type: array title: Status 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.WorkflowExecutionAction.Metadata: additionalProperties: false description: WorkflowExecutionActionMetadata contains workflow execution action metadata. properties: actionName: description: "Human-readable name for this action based on its context.\n Examples: \"gitpod-io/gitpod-next\" for\ \ repository context, \"My Project\" for project context.\n Will be empty string for actions created before this\ \ field was added." title: action_name type: string finishedAt: $ref: '#/components/schemas/google.protobuf.Timestamp' title: finished_at startedAt: $ref: '#/components/schemas/google.protobuf.Timestamp' title: started_at workflowExecutionId: format: uuid title: workflow_execution_id type: string workflowId: format: uuid title: workflow_id type: string title: Metadata type: object gitpod.v1.WorkflowExecutionAction.Spec: additionalProperties: false description: WorkflowExecutionActionSpec contains the specification for this execution action. properties: context: $ref: '#/components/schemas/gitpod.v1.AgentCodeContext' description: "Context for the execution action - specifies where and how the action executes.\n This is resolved\ \ from the workflow trigger context and contains the specific\n project, repository, or agent context for this\ \ execution instance." title: context desiredPhase: $ref: '#/components/schemas/gitpod.v1.WorkflowExecutionActionPhase' title: desired_phase x-stainless-skip: true limits: $ref: '#/components/schemas/gitpod.v1.WorkflowAction.Limits.PerExecution' title: limits session: title: session type: string x-stainless-skip: true title: Spec type: object gitpod.v1.WorkflowExecutionAction.Status: additionalProperties: false description: WorkflowExecutionActionStatus contains the current status of a workflow execution action. properties: agentExecutionId: title: agent_execution_id type: string environmentId: format: uuid title: environment_id type: string failureMessage: description: "FailureMessage summarises why the workflow execution action failed to operate. If this is non-empty\n\ \ the workflow execution action has failed to operate and will likely transition to a stopped state.\n Deprecated:\ \ Use errors field instead for structured error information." title: failure_message type: string x-stainless-skip: true failures: description: "Structured failures that caused the workflow execution action to fail.\n Provides detailed error codes,\ \ messages, and retry information." items: $ref: '#/components/schemas/gitpod.v1.WorkflowError' title: failures type: array phase: $ref: '#/components/schemas/gitpod.v1.WorkflowExecutionActionPhase' title: phase session: title: session type: string x-stainless-skip: true stepStatuses: description: Step-level progress tracking items: $ref: '#/components/schemas/gitpod.v1.WorkflowExecutionAction.Status.StepStatus' title: step_statuses type: array warningMessage: description: "WarningMessage summarises why the workflow execution action is in a warning state. If this is non-empty\n\ \ the workflow execution action is in a warning state and likely does not match the users expectations.\n Deprecated:\ \ Use warnings field instead for structured warning information." title: warning_message type: string x-stainless-skip: true warnings: description: "Structured warnings about the workflow execution action.\n Provides detailed warning codes and messages." items: $ref: '#/components/schemas/gitpod.v1.WorkflowError' title: warnings type: array title: Status type: object gitpod.v1.WorkflowExecutionAction.Status.StepStatus: additionalProperties: false description: WorkflowExecutionActionStepStatus represents the status of a single step execution. properties: error: $ref: '#/components/schemas/gitpod.v1.WorkflowError' description: "Structured error that caused the step to fail.\n Provides detailed error code, message, and retry\ \ information." title: error failureMessage: description: 'Deprecated: Use error field instead for structured error information.' title: failure_message type: string x-stainless-skip: true finishedAt: $ref: '#/components/schemas/google.protobuf.Timestamp' title: finished_at phase: $ref: '#/components/schemas/gitpod.v1.WorkflowExecutionAction.Status.StepStatus.StepPhase' title: phase startedAt: $ref: '#/components/schemas/google.protobuf.Timestamp' title: started_at step: $ref: '#/components/schemas/gitpod.v1.WorkflowStep' description: "The step definition captured at execution time for immutability.\n This ensures the UI shows the correct\ \ step even if the workflow definition changes." title: step stepIndex: description: Index of the step in the workflow action steps array format: int32 title: step_index type: integer title: StepStatus type: object gitpod.v1.WorkflowExecutionAction.Status.StepStatus.StepPhase: enum: - STEP_PHASE_UNSPECIFIED - STEP_PHASE_PENDING - STEP_PHASE_RUNNING - STEP_PHASE_DONE - STEP_PHASE_FAILED - STEP_PHASE_CANCELLED title: StepPhase type: string gitpod.v1.WorkflowExecutionActionPhase: description: WorkflowExecutionActionPhase defines the phases of workflow execution action. enum: - WORKFLOW_EXECUTION_ACTION_PHASE_UNSPECIFIED - WORKFLOW_EXECUTION_ACTION_PHASE_PENDING - WORKFLOW_EXECUTION_ACTION_PHASE_RUNNING - WORKFLOW_EXECUTION_ACTION_PHASE_STOPPING - WORKFLOW_EXECUTION_ACTION_PHASE_STOPPED - WORKFLOW_EXECUTION_ACTION_PHASE_DELETING - WORKFLOW_EXECUTION_ACTION_PHASE_DELETED - WORKFLOW_EXECUTION_ACTION_PHASE_DONE title: WorkflowExecutionActionPhase type: string gitpod.v1.WorkflowExecutionPhase: enum: - WORKFLOW_EXECUTION_PHASE_UNSPECIFIED - WORKFLOW_EXECUTION_PHASE_PENDING - WORKFLOW_EXECUTION_PHASE_RUNNING - WORKFLOW_EXECUTION_PHASE_STOPPING - WORKFLOW_EXECUTION_PHASE_STOPPED - WORKFLOW_EXECUTION_PHASE_DELETING - WORKFLOW_EXECUTION_PHASE_DELETED - WORKFLOW_EXECUTION_PHASE_COMPLETED title: WorkflowExecutionPhase type: string gitpod.v1.WorkflowExecutionTrigger: additionalProperties: false description: WorkflowExecutionTrigger represents a workflow execution trigger instance. oneOf: - not: anyOf: - required: - pullRequest - required: - time required: - manual - not: anyOf: - required: - manual - required: - time required: - pullRequest - not: anyOf: - required: - manual - required: - pullRequest required: - time properties: context: $ref: '#/components/schemas/gitpod.v1.WorkflowTriggerContext' description: "Context from the workflow trigger - copied at execution time for immutability.\n This allows the reconciler\ \ to create actions without fetching the workflow definition." title: context manual: $ref: '#/components/schemas/gitpod.v1.WorkflowExecutionTrigger.Manual' title: manual pullRequest: $ref: '#/components/schemas/gitpod.v1.PullRequest' title: pull_request time: $ref: '#/components/schemas/gitpod.v1.WorkflowExecutionTrigger.Time' title: time required: - context title: WorkflowExecutionTrigger type: object gitpod.v1.WorkflowExecutionTrigger.Manual: additionalProperties: false description: Manual trigger - empty message since no additional data needed title: Manual type: object gitpod.v1.WorkflowExecutionTrigger.Time: additionalProperties: false description: Time trigger - just the timestamp when it was triggered properties: triggeredAt: $ref: '#/components/schemas/google.protobuf.Timestamp' title: triggered_at title: Time type: object gitpod.v1.WorkflowStep: additionalProperties: false description: WorkflowStep defines a single step in a workflow action. oneOf: - not: anyOf: - required: - pullRequest - required: - report - required: - task required: - agent - not: anyOf: - required: - agent - required: - report - required: - task required: - pullRequest - not: anyOf: - required: - agent - required: - pullRequest - required: - task required: - report - not: anyOf: - required: - agent - required: - pullRequest - required: - report required: - task properties: agent: $ref: '#/components/schemas/gitpod.v1.WorkflowStep.Agent' title: agent pullRequest: $ref: '#/components/schemas/gitpod.v1.WorkflowStep.PullRequest' title: pull_request report: $ref: '#/components/schemas/gitpod.v1.WorkflowStep.Report' title: report task: $ref: '#/components/schemas/gitpod.v1.WorkflowStep.Task' title: task title: WorkflowStep type: object gitpod.v1.WorkflowStep.Agent: additionalProperties: false description: WorkflowAgentStep represents an agent step that executes with a prompt. properties: prompt: description: 'Prompt must be between 1 and 20,000 characters: ``` size(this) >= 1 && size(this) <= 20000 ``` ' title: prompt type: string title: Agent type: object gitpod.v1.WorkflowStep.PullRequest: additionalProperties: false description: WorkflowPullRequestStep represents a pull request creation step. properties: branch: description: 'Branch name must be between 1 and 255 characters: ``` size(this) >= 1 && size(this) <= 255 ``` ' title: branch type: string description: description: 'Description must be at most 20,000 characters: ``` size(this) <= 20000 ``` ' title: description type: string draft: title: draft type: boolean title: description: 'Title must be between 1 and 500 characters: ``` size(this) >= 1 && size(this) <= 500 ``` ' title: title type: string title: PullRequest type: object gitpod.v1.WorkflowStep.Report: additionalProperties: false properties: outputs: description: 'Report must have at least one output: ``` size(this) >= 1 ``` ' items: $ref: '#/components/schemas/gitpod.v1.WorkflowStep.Report.OutputSpec' title: outputs type: array title: Report type: object gitpod.v1.WorkflowStep.Report.BooleanSchema: additionalProperties: false title: BooleanSchema type: object gitpod.v1.WorkflowStep.Report.FloatSchema: additionalProperties: false properties: max: format: float nullable: true title: max type: number min: format: float nullable: true title: min type: number title: FloatSchema type: object gitpod.v1.WorkflowStep.Report.IntegerSchema: additionalProperties: false properties: max: format: int32 nullable: true title: max type: integer min: format: int32 nullable: true title: min type: integer title: IntegerSchema type: object gitpod.v1.WorkflowStep.Report.OutputSpec: additionalProperties: false allOf: - anyOf: - required: - command - required: - prompt - not: anyOf: - required: - command - required: - prompt - anyOf: - required: - boolean - required: - float - required: - integer - required: - string - not: anyOf: - required: - boolean - required: - float - required: - integer - required: - string properties: acceptanceCriteria: description: "Optional CEL expression that decides if the value is acceptable,\n e.g. is the test coverage high\ \ enough. Has one variable (value), must eval to boolean." nullable: true title: acceptance_criteria type: string boolean: $ref: '#/components/schemas/gitpod.v1.WorkflowStep.Report.BooleanSchema' title: boolean command: description: 'Extraction command must be between 1 and 20,000 characters: ``` size(this) >= 1 && size(this) <= 20000 ``` ' title: command type: string float: $ref: '#/components/schemas/gitpod.v1.WorkflowStep.Report.FloatSchema' title: float integer: $ref: '#/components/schemas/gitpod.v1.WorkflowStep.Report.IntegerSchema' title: integer key: description: 'Output key must be between 1 and 50 characters: ``` size(this) >= 1 && size(this) <= 50 ``` Output key must be snake_case (e.g., my_output_key): ``` this.matches(''^[a-z]+(_[a-z]+)*$'') ``` ' title: key type: string prompt: description: 'Extraction prompt must be between 1 and 20,000 characters: ``` size(this) >= 1 && size(this) <= 20000 ``` ' title: prompt type: string string: $ref: '#/components/schemas/gitpod.v1.WorkflowStep.Report.StringSchema' title: string title: description: 'Output title must be between 1 and 200 characters: ``` size(this) >= 1 && size(this) <= 200 ``` ' title: title type: string title: OutputSpec type: object gitpod.v1.WorkflowStep.Report.StringSchema: additionalProperties: false properties: pattern: title: pattern type: string title: StringSchema type: object gitpod.v1.WorkflowStep.Task: additionalProperties: false description: WorkflowTaskStep represents a task step that executes a command. properties: command: description: 'Command must be between 1 and 20,000 characters: ``` size(this) >= 1 && size(this) <= 20000 ``` ' title: command type: string title: Task type: object gitpod.v1.WorkflowTrigger: additionalProperties: false description: "WorkflowTrigger defines when a workflow should be executed.\n\n Each trigger type defines a specific condition\ \ that will cause the workflow to execute:\n - Manual: Triggered explicitly by user action via StartWorkflow RPC\n\ \ - Time: Triggered automatically based on cron schedule\n - PullRequest: Triggered automatically when specified PR\ \ events occur\n\n Trigger Semantics:\n - Each trigger instance can create multiple workflow executions\n - Multiple\ \ triggers of the same workflow can fire simultaneously\n - Each trigger execution is independent and tracked separately\n\ \ - Triggers are evaluated in the context specified by WorkflowTriggerContext" oneOf: - not: anyOf: - required: - pullRequest - required: - time required: - manual - not: anyOf: - required: - manual - required: - time required: - pullRequest - not: anyOf: - required: - manual - required: - pullRequest required: - time properties: context: $ref: '#/components/schemas/gitpod.v1.WorkflowTriggerContext' title: context manual: $ref: '#/components/schemas/gitpod.v1.WorkflowTrigger.Manual' title: manual pullRequest: $ref: '#/components/schemas/gitpod.v1.WorkflowTrigger.PullRequest' title: pull_request time: $ref: '#/components/schemas/gitpod.v1.WorkflowTrigger.Time' title: time required: - context title: WorkflowTrigger type: object gitpod.v1.WorkflowTrigger.Manual: additionalProperties: false description: "Manual trigger - executed when StartWorkflow RPC is called.\n No additional configuration needed." title: Manual type: object gitpod.v1.WorkflowTrigger.PullRequest: additionalProperties: false description: "Pull request trigger - executed when specified PR events occur.\n Only triggers for PRs in repositories\ \ matching the trigger context." properties: events: items: $ref: '#/components/schemas/gitpod.v1.WorkflowTrigger.PullRequestEvent' title: events type: array webhookId: description: "webhook_id is the optional ID of a webhook that this trigger is bound to.\n When set, the trigger\ \ will be activated when the webhook receives events.\n This allows multiple workflows to share a single webhook\ \ endpoint." format: uuid nullable: true title: webhook_id type: string title: PullRequest type: object gitpod.v1.WorkflowTrigger.PullRequestEvent: description: WorkflowPREvent defines pull request events that can trigger workflows. enum: - PULL_REQUEST_EVENT_UNSPECIFIED - PULL_REQUEST_EVENT_OPENED - PULL_REQUEST_EVENT_UPDATED - PULL_REQUEST_EVENT_APPROVED - PULL_REQUEST_EVENT_MERGED - PULL_REQUEST_EVENT_CLOSED - PULL_REQUEST_EVENT_READY_FOR_REVIEW title: PullRequestEvent type: string gitpod.v1.WorkflowTrigger.Time: additionalProperties: false description: "Time-based trigger - executed automatically based on cron schedule.\n Uses standard cron expression format\ \ (minute hour day month weekday)." properties: cronExpression: description: 'Cron expression must be between 1 and 100 characters: ``` size(this) >= 1 && size(this) <= 100 ``` ' title: cron_expression type: string title: Time type: object gitpod.v1.WorkflowTriggerContext: additionalProperties: false description: "WorkflowTriggerContext defines the context in which a workflow should run.\n\n Context determines where\ \ and how the workflow executes:\n - Projects: Execute in specific project environments\n - Repositories: Execute\ \ in environments created from repository URLs\n - Agent: Execute in agent-managed environments with custom prompts\n\ \ - FromTrigger: Use context derived from the trigger event (PR-specific)\n\n Context Usage by Trigger Type:\n - Manual:\ \ Can use any context type\n - Time: Typically uses Projects or Repositories context\n - PullRequest: Can use any\ \ context, FromTrigger uses PR repository context" oneOf: - not: anyOf: - required: - fromTrigger - required: - projects - required: - repositories required: - agent - not: anyOf: - required: - agent - required: - projects - required: - repositories required: - fromTrigger - not: anyOf: - required: - agent - required: - fromTrigger - required: - repositories required: - projects - not: anyOf: - required: - agent - required: - fromTrigger - required: - projects required: - repositories properties: agent: $ref: '#/components/schemas/gitpod.v1.WorkflowTriggerContext.Agent' title: agent fromTrigger: $ref: '#/components/schemas/gitpod.v1.WorkflowTriggerContext.FromTrigger' title: from_trigger projects: $ref: '#/components/schemas/gitpod.v1.WorkflowTriggerContext.Projects' title: projects repositories: $ref: '#/components/schemas/gitpod.v1.WorkflowTriggerContext.Repositories' title: repositories title: WorkflowTriggerContext type: object gitpod.v1.WorkflowTriggerContext.Agent: additionalProperties: false description: "Execute workflow in agent-managed environments.\n Agent receives the specified prompt and manages execution\ \ context." properties: prompt: description: 'Agent prompt must be between 1 and 20,000 characters: ``` size(this) >= 1 && size(this) <= 20000 ``` ' title: prompt type: string title: Agent type: object gitpod.v1.WorkflowTriggerContext.FromTrigger: additionalProperties: false description: "Use context derived from the trigger event.\n Currently only supported for PullRequest triggers - uses\ \ PR repository context." title: FromTrigger type: object gitpod.v1.WorkflowTriggerContext.Projects: additionalProperties: false description: "Execute workflow in specific project environments.\n Creates environments for each specified project." properties: projectIds: items: format: uuid maxItems: 25 type: string maxItems: 25 title: project_ids type: array title: Projects type: object gitpod.v1.WorkflowTriggerContext.Repositories: additionalProperties: false description: "Execute workflow in environments created from repository URLs.\n Supports both explicit repository URLs\ \ and search patterns." oneOf: - not: anyOf: - required: - repositoryUrls required: - repoSelector - not: anyOf: - required: - repoSelector required: - repositoryUrls properties: environmentClassId: format: uuid title: environment_class_id type: string repoSelector: $ref: '#/components/schemas/gitpod.v1.WorkflowTriggerContext.Repositories.RepositorySelector' title: repo_selector repositoryUrls: $ref: '#/components/schemas/gitpod.v1.WorkflowTriggerContext.Repositories.RepositoryURLs' title: repository_urls title: Repositories type: object gitpod.v1.WorkflowTriggerContext.Repositories.RepositorySelector: additionalProperties: false description: "RepositorySelector defines how to select repositories for workflow execution.\n Combines a search string\ \ with an SCM host to identify repositories." properties: repoSearchString: description: "Search string to match repositories using SCM-specific search patterns.\n For GitHub: supports GitHub\ \ search syntax (e.g., \"org:gitpod-io language:go\", \"user:octocat stars:>100\")\n For GitLab: supports GitLab\ \ search syntax\n See SCM provider documentation for supported search patterns." minLength: 1 title: repo_search_string type: string scmHost: description: SCM host where the search should be performed (e.g., "github.com", "gitlab.com") minLength: 1 title: scm_host type: string title: RepositorySelector type: object gitpod.v1.WorkflowTriggerContext.Repositories.RepositoryURLs: additionalProperties: false description: "RepositoryURLs contains a list of explicit repository URLs.\n Creates one action per repository URL." properties: repoUrls: items: maxItems: 100 minItems: 1 minLength: 1 type: string maxItems: 100 minItems: 1 title: repo_urls type: array title: RepositoryURLs type: object google.protobuf.Any: additionalProperties: true description: Contains an arbitrary serialized message along with a @type that describes the type of the serialized message. properties: debug: additionalProperties: true type: object type: type: string value: format: binary type: string 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 independent of any calendar and concepts like \"day\"\n or \"month\"\ . It is related to Timestamp in that the difference between\n two Timestamp values is a Duration and it can be added\ \ or subtracted\n from a Timestamp. Range is approximately +-10,000 years.\n\n # Examples\n\n Example 1: Compute Duration\ \ from two Timestamps in pseudo code.\n\n Timestamp start = ...;\n Timestamp end = ...;\n Duration duration\ \ = ...;\n\n duration.seconds = end.seconds - start.seconds;\n duration.nanos = end.nanos - start.nanos;\n\ \n if (duration.seconds < 0 && duration.nanos > 0) {\n duration.seconds += 1;\n duration.nanos -=\ \ 1000000000;\n } else if (duration.seconds > 0 && duration.nanos < 0) {\n duration.seconds -= 1;\n \ \ duration.nanos += 1000000000;\n }\n\n Example 2: Compute Timestamp from Timestamp + Duration in pseudo code.\n\ \n Timestamp start = ...;\n Duration duration = ...;\n Timestamp end = ...;\n\n end.seconds = start.seconds\ \ + duration.seconds;\n end.nanos = start.nanos + duration.nanos;\n\n if (end.nanos < 0) {\n end.seconds\ \ -= 1;\n end.nanos += 1000000000;\n } else if (end.nanos >= 1000000000) {\n end.seconds += 1;\n \ \ end.nanos -= 1000000000;\n }\n\n Example 3: Compute Duration from datetime.timedelta in Python.\n\n \ \ td = datetime.timedelta(days=3, minutes=10)\n duration = Duration()\n duration.FromTimedelta(td)\n\n #\ \ JSON Mapping\n\n In JSON format, the Duration type is encoded as a string rather than an\n object, where the string\ \ ends in the suffix \"s\" (indicating seconds) and\n is preceded by the number of seconds, with nanoseconds expressed\ \ as\n fractional seconds. For example, 3 seconds with 0 nanoseconds should be\n encoded in JSON format as \"3s\"\ , while 3 seconds and 1 nanosecond should\n be expressed in JSON format as \"3.000000001s\", and 3 seconds and 1\n\ \ microsecond should be expressed in JSON format as \"3.000001s\"." format: regex pattern: ^[-\+]?([0-9]+\.?[0-9]*|\.[0-9]+)s$ type: string google.protobuf.Timestamp: description: "A Timestamp represents a point in time independent of any time zone or local\n calendar, encoded as a\ \ count of seconds and fractions of seconds at\n nanosecond resolution. The count is relative to an epoch at UTC midnight\ \ on\n January 1, 1970, in the proleptic Gregorian calendar which extends the\n Gregorian calendar backwards to year\ \ one.\n\n All minutes are 60 seconds long. Leap seconds are \"smeared\" so that no leap\n second table is needed\ \ for interpretation, using a [24-hour linear\n smear](https://developers.google.com/time/smear).\n\n The range is\ \ from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z. By\n restricting to that range, we ensure that we can\ \ convert to and from [RFC\n 3339](https://www.ietf.org/rfc/rfc3339.txt) date strings.\n\n # Examples\n\n Example\ \ 1: Compute Timestamp from POSIX `time()`.\n\n Timestamp timestamp;\n timestamp.set_seconds(time(NULL));\n\ \ timestamp.set_nanos(0);\n\n Example 2: Compute Timestamp from POSIX `gettimeofday()`.\n\n struct timeval\ \ tv;\n gettimeofday(&tv, NULL);\n\n Timestamp timestamp;\n timestamp.set_seconds(tv.tv_sec);\n timestamp.set_nanos(tv.tv_usec\ \ * 1000);\n\n Example 3: Compute Timestamp from Win32 `GetSystemTimeAsFileTime()`.\n\n FILETIME ft;\n GetSystemTimeAsFileTime(&ft);\n\ \ UINT64 ticks = (((UINT64)ft.dwHighDateTime) << 32) | ft.dwLowDateTime;\n\n // A Windows tick is 100 nanoseconds.\ \ Windows epoch 1601-01-01T00:00:00Z\n // is 11644473600 seconds before Unix epoch 1970-01-01T00:00:00Z.\n \ \ Timestamp timestamp;\n timestamp.set_seconds((INT64) ((ticks / 10000000) - 11644473600LL));\n timestamp.set_nanos((INT32)\ \ ((ticks % 10000000) * 100));\n\n Example 4: Compute Timestamp from Java `System.currentTimeMillis()`.\n\n long\ \ millis = System.currentTimeMillis();\n\n Timestamp timestamp = Timestamp.newBuilder().setSeconds(millis / 1000)\n\ \ .setNanos((int) ((millis % 1000) * 1000000)).build();\n\n Example 5: Compute Timestamp from Java `Instant.now()`.\n\ \n Instant now = Instant.now();\n\n Timestamp timestamp =\n Timestamp.newBuilder().setSeconds(now.getEpochSecond())\n\ \ .setNanos(now.getNano()).build();\n\n Example 6: Compute Timestamp from current time in Python.\n\n\ \ timestamp = Timestamp()\n timestamp.GetCurrentTime()\n\n # JSON Mapping\n\n In JSON format, the Timestamp\ \ type is encoded as a string in the\n [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format. That is, the\n format\ \ is \"{year}-{month}-{day}T{hour}:{min}:{sec}[.{frac_sec}]Z\"\n where {year} is always expressed using four digits\ \ while {month}, {day},\n {hour}, {min}, and {sec} are zero-padded to two digits each. The fractional\n seconds, which\ \ can go up to 9 digits (i.e. up to 1 nanosecond resolution),\n are optional. The \"Z\" suffix indicates the timezone\ \ (\"UTC\"); the timezone\n is required. A proto3 JSON serializer should always use UTC (as indicated by\n \"Z\")\ \ when printing the Timestamp type and a proto3 JSON parser should be\n able to accept both UTC and other timezones\ \ (as indicated by an offset).\n\n For example, \"2017-01-15T01:30:15.01Z\" encodes 15.01 seconds past\n 01:30 UTC\ \ on January 15, 2017.\n\n In JavaScript, one can convert a Date object to this format using the\n standard\n [toISOString()](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString)\n\ \ method. In Python, a standard `datetime.datetime` object can be converted\n to this format using\n [`strftime`](https://docs.python.org/2/library/time.html#time.strftime)\ \ with\n the time format spec '%Y-%m-%dT%H:%M:%S.%fZ'. Likewise, in Java, one can use\n the Joda Time's [`ISODateTimeFormat.dateTime()`](\n\ \ http://joda-time.sourceforge.net/apidocs/org/joda/time/format/ISODateTimeFormat.html#dateTime()\n ) to obtain a\ \ formatter capable of generating timestamps in this format." format: date-time type: string securitySchemes: bearerAuth: bearerFormat: JWT scheme: bearer type: http x-tagGroups: - name: gitpod.v1 tags: - gitpod.v1.AccountService - gitpod.v1.AgentService - gitpod.v1.AgentSecurityService - gitpod.v1.BillingService - gitpod.v1.EditorService - gitpod.v1.EnvironmentAutomationService - gitpod.v1.EnvironmentService - gitpod.v1.ErrorsService - gitpod.v1.EventService - gitpod.v1.GatewayService - gitpod.v1.GroupService - gitpod.v1.IdentityService - gitpod.v1.InsightsService - gitpod.v1.IntegrationService - gitpod.v1.NotificationService - gitpod.v1.OnaIntelligenceService - gitpod.v1.OrganizationService - gitpod.v1.PrebuildService - gitpod.v1.ProjectService - gitpod.v1.RunnerConfigurationService - gitpod.v1.RunnerInteractionService - gitpod.v1.RunnerManagerService - gitpod.v1.RunnerService - gitpod.v1.SecretService - gitpod.v1.ServiceAccountService - gitpod.v1.SessionService - gitpod.v1.TeamService - gitpod.v1.UsageService - gitpod.v1.UserService - gitpod.v1.WebhookService - gitpod.v1.WorkflowService