How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Gitpod

Gitpod.v1.EnvironmentService API

The gitpod.v1.EnvironmentService API from Gitpod — 15 operation(s) for gitpod.v1.environmentservice.

Documentation Provider Profile APIs.io OpenAPI GitHub

Gitpod.v1.EnvironmentService API is one of 34 APIs that Gitpod publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 15 operations across 15 paths, and defines 107 schemas. It is described by OpenAPI 3.2.0, at version v1.0.0.

Requests are made against a single base URL, https://api.gitpod.io.

15 operations 15 paths 107 schemas 15 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
v1.0.0
Base URL
https://api.gitpod.io
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Gitpod.v1.EnvironmentService API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (bearerAuth).

Paths & Operations 15

Across 15 paths, the API surfaces 15 operations — 15 POST. Each is listed below with its method, path, parameters, and response codes.

gitpod.v1.EnvironmentService 15
POST
/gitpod.v1.EnvironmentService/AllowPortAccessdeprecated
AllowPortAccess
gitpod.v1.EnvironmentService.AllowPortAccess body → 200default
POST
/gitpod.v1.EnvironmentService/CreateEnvironment
CreateEnvironment
gitpod.v1.EnvironmentService.CreateEnvironment body → 200default
POST
/gitpod.v1.EnvironmentService/CreateEnvironmentAccessToken
CreateEnvironmentAccessToken
gitpod.v1.EnvironmentService.CreateEnvironmentAccessToken body → 200default
POST
/gitpod.v1.EnvironmentService/CreateEnvironmentFromProject
CreateEnvironmentFromProject
gitpod.v1.EnvironmentService.CreateEnvironmentFromProject body → 200default
POST
/gitpod.v1.EnvironmentService/CreateEnvironmentLogsToken
CreateEnvironmentLogsToken
gitpod.v1.EnvironmentService.CreateEnvironmentLogsToken body → 200default
POST
/gitpod.v1.EnvironmentService/CreatePortAccessToken
CreatePortAccessToken
gitpod.v1.EnvironmentService.CreatePortAccessToken body → 200default
POST
/gitpod.v1.EnvironmentService/DeleteEnvironment
DeleteEnvironment
gitpod.v1.EnvironmentService.DeleteEnvironment body → 200default
POST
/gitpod.v1.EnvironmentService/GetEnvironment
GetEnvironment
gitpod.v1.EnvironmentService.GetEnvironment body → 200default
POST
/gitpod.v1.EnvironmentService/ListEnvironmentClasses
ListEnvironmentClasses
gitpod.v1.EnvironmentService.ListEnvironmentClasses 2 params body → 200default
POST
/gitpod.v1.EnvironmentService/ListEnvironments
ListEnvironments
gitpod.v1.EnvironmentService.ListEnvironments 2 params body → 200default
POST
/gitpod.v1.EnvironmentService/MarkEnvironmentActive
MarkEnvironmentActive
gitpod.v1.EnvironmentService.MarkEnvironmentActive body → 200default
POST
/gitpod.v1.EnvironmentService/StartEnvironment
StartEnvironment
gitpod.v1.EnvironmentService.StartEnvironment body → 200default
POST
/gitpod.v1.EnvironmentService/StopEnvironment
StopEnvironment
gitpod.v1.EnvironmentService.StopEnvironment body → 200default
POST
/gitpod.v1.EnvironmentService/UnarchiveEnvironment
UnarchiveEnvironment
gitpod.v1.EnvironmentService.UnarchiveEnvironment body → 200default
POST
/gitpod.v1.EnvironmentService/UpdateEnvironment
UpdateEnvironment
gitpod.v1.EnvironmentService.UpdateEnvironment body → 200default

Schemas 107

The contract defines 107 schemas that model the data the API accepts and returns. The most detailed are gitpod.v1.EnvironmentMetadata (14 properties), gitpod.v1.EnvironmentStatus (13 properties), gitpod.v1.EnvironmentSpec (13 properties), gitpod.v1.EnvironmentStatus.DevContainer (12 properties). Each schema is shown below with its type and property counts.

gitpod.v1.EnvironmentSpec.DevContainer.Dotfiles
object
1 property 1 required
gitpod.v1.PaginationRequest
object
2 properties
gitpod.v1.EnvironmentSpec.AutomationsFile
object
3 properties
gitpod.v1.CreateEnvironmentRequest
object
Required fields: - metadata.organizationid - metadata.configurationid
4 properties
gitpod.v1.UpdateEnvironmentRequest.Content
object
4 properties
gitpod.v1.BPFDebugLevel
string
BPFDebugLevel controls the verbosity of BPF tracepipe output (bpfprintk). Applies to all BPF-based agents (veto exec, future agents).
gitpod.v1.ListEnvironmentClassesRequest
object
2 properties
gitpod.v1.EnvironmentStatus.Secret
object
6 properties
gitpod.v1.CreateEnvironmentAccessTokenResponse
object
1 property 1 required
gitpod.v1.GitInitializer
object
5 properties
gitpod.v1.ContextURLInitializer
object
1 property
gitpod.v1.Subject
object
2 properties
gitpod.v1.ListEnvironmentClassesResponse
object
2 properties
gitpod.v1.EnvironmentClass
object
6 properties 2 required
google.protobuf.Timestamp
string
A Timestamp represents a point in time independent of any time zone or local calendar, encoded as a count of seconds and fractions of seconds at nanosecond res…
gitpod.v1.CreatePortAccessTokenRequest
object
2 properties
gitpod.v1.ListEnvironmentsRequest.ArchivalStatus
string
gitpod.v1.UpdateEnvironmentRequest.Spec
object
7 properties
gitpod.v1.AdmissionLevel
string
Admission level describes who can access an environment instance and its ports.
gitpod.v1.ListEnvironmentsResponse
object
3 properties
gitpod.v1.CreateEnvironmentLogsTokenResponse
object
1 property 1 required
gitpod.v1.FileChange
object
2 properties
gitpod.v1.CountResponse
object
CountResponse represents a bounded count of matching records. When the actual count exceeds the counting limit, value is capped and relation is set to GREATERT…
2 properties
gitpod.v1.EnvironmentMetadata
object
EnvironmentMetadata is data associated with an environment that's required for other parts of the system to function
14 properties
gitpod.v1.EnvironmentStatus.DevContainer
object
12 properties
gitpod.v1.EnvironmentGitStatus
object
7 properties
gitpod.v1.EnvironmentRole
string
EnvironmentRole represents the role of an environment
gitpod.v1.AutomationTrigger
object
An AutomationTrigger represents a trigger for an automation action. The manual field shows a start button in the UI for manually triggering the automation. The…
6 properties
gitpod.v1.DeleteEnvironmentResponse
object
gitpod.v1.MarkEnvironmentActiveRequest
object
2 properties
gitpod.v1.EnvironmentStatus
object
EnvironmentStatus describes an environment status
13 properties
gitpod.v1.EnvironmentStatus.Machine.Versions
object
3 properties
gitpod.v1.EnvironmentStatus.EnvironmentSSHURL
object
1 property
gitpod.v1.EnvironmentStatus.EnvironmentURLs
object
6 properties
gitpod.v1.UnarchiveEnvironmentRequest
object
1 property
gitpod.v1.EnvironmentStatus.AutomationsFile
object
6 properties
gitpod.v1.KernelControlsAction
string
KernelControlsAction defines how a kernel-level policy violation is handled.
gitpod.v1.FieldValue
object
2 properties
gitpod.v1.EnvironmentSpec.Secret
object
12 properties
gitpod.v1.Veto
object
Veto controls kernel-level blocking mechanisms
1 property
gitpod.v1.UpdateEnvironmentRequest.Metadata
object
2 properties
gitpod.v1.EnvironmentSpec.Secret.Scope
string
Scope indicates the origin of the secret for filtering purposes.
gitpod.v1.Environment
object
+resource get environment
4 properties 1 required
gitpod.v1.Veto.Exec
object
Exec controls executable blocking
7 properties
gitpod.v1.EnvironmentStatus.SSHPublicKey
object
2 properties
gitpod.v1.ListEnvironmentClassesRequest.Filter
object
5 properties
gitpod.v1.EnvironmentStatus.DevContainer.Phase
string
gitpod.v1.UpdateEnvironmentRequest.AutomationsFile
object
2 properties
connect.error
object
Error type returned by Connect: https://connectrpc.com/docs/go/errors/http-representation
2 properties
gitpod.v1.EnvironmentSpec.Secret.CredentialProxy.Format
string
gitpod.v1.CreateEnvironmentFromProjectRequest
object
5 properties
gitpod.v1.EnvironmentInitializer
object
EnvironmentInitializer specifies how an environment is to be initialized
1 property
gitpod.v1.UpdateEnvironmentRequest.DevContainer
object
2 properties
gitpod.v1.EnvironmentSpec
object
EnvironmentSpec specifies the configuration of an environment for an environment start
13 properties
gitpod.v1.EnvironmentSpec.EnvironmentPort.Protocol
string
Protocol describes the communication protocol between Gateway and user environment services.
gitpod.v1.EnvironmentSpec.Timeout
object
Timeout configures the environment timeout
1 property
gitpod.v1.EnvironmentStatus.DevContainer.Presence
string
gitpod.v1.ListEnvironmentsRequest.Filter
object
11 properties
gitpod.v1.StartEnvironmentRequest
object
1 property
gitpod.v1.EnvironmentStatus.RunnerACK
object
RunnerACK is the acknowledgement from the runner that is has received the environment spec.
3 properties
gitpod.v1.UpdateEnvironmentRequest.SSHPublicKey
object
2 properties
gitpod.v1.AllowPortAccessResponse
object
1 property
gitpod.v1.EnvironmentStatus.EnvironmentPortURL
object
2 properties
gitpod.v1.EnvironmentSpec.EnvironmentPort
object
5 properties
gitpod.v1.CountRequest
object
CountRequest controls whether the response should include a bounded count of matching records.
1 property
gitpod.v1.CreateEnvironmentAccessTokenRequest
object
1 property 1 required
gitpod.v1.KernelControlsConfig
object
KernelControlsConfig configures kernel-level controls for the environment
2 properties
gitpod.v1.EnvironmentStatus.ContentPhase
string
gitpod.v1.CreatePortAccessTokenResponse
object
1 property 1 required
gitpod.v1.EnvironmentSpec.DevContainer.LifecycleStage
string
LifecycleStage controls which devcontainer lifecycle commands are executed. See https://containers.dev/implementors/jsonreference/lifecycle-scripts
gitpod.v1.UpdateEnvironmentRequest
object
3 properties
gitpod.v1.RunnerKind
string
RunnerKind represents the kind of a runner
gitpod.v1.StopEnvironmentResponse
object
gitpod.v1.EnvironmentStatus.Content
object
6 properties
gitpod.v1.EnvironmentSpec.DevContainer
object
5 properties
gitpod.v1.EnvironmentStatus.Machine.Phase
string
gitpod.v1.CreateEnvironmentFromProjectResponse
object
1 property 1 required
gitpod.v1.PaginationResponse
object
1 property
gitpod.v1.EnvironmentSpec.SSHPublicKey
object
2 properties
gitpod.v1.EnvironmentActivitySignal
object
EnvironmentActivitySignal used to signal activity for an environment.
2 properties
gitpod.v1.EnvironmentSpec.Machine
object
3 properties
gitpod.v1.GitInitializer.CloneTargetMode
string
CloneTargetMode is the target state in which we want to leave a GitEnvironment
gitpod.v1.UpdateEnvironmentRequest.Timeout
object
1 property
gitpod.v1.EnvironmentStatus.RunnerACK.StatusCode
string
gitpod.v1.CreateEnvironmentLogsTokenRequest
object
1 property
gitpod.v1.UpdateEnvironmentResponse
object
gitpod.v1.AllowPortAccessRequest
object
2 properties
gitpod.v1.EnvironmentStatus.Machine
object
7 properties
google.protobuf.Duration
string
A Duration represents a signed, fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independen…
gitpod.v1.FileChange.ChangeType
string
ChangeType is the type of change that happened to the file
gitpod.v1.DeleteEnvironmentRequest
object
2 properties
gitpod.v1.GetEnvironmentRequest
object
1 property 1 required
gitpod.v1.EnvironmentInitializer.Spec
object
2 properties
gitpod.v1.ListEnvironmentsRequest
object
3 properties
gitpod.v1.GetEnvironmentResponse
object
1 property 1 required
gitpod.v1.StopEnvironmentRequest
object
1 property
gitpod.v1.UnarchiveEnvironmentResponse
object
gitpod.v1.EnvironmentSpec.Secret.CredentialProxy
object
CredentialProxy describes how the credential proxy should inject this secret into outgoing HTTPS requests.
3 properties
gitpod.v1.StartEnvironmentResponse
object
gitpod.v1.Principal
string
gitpod.v1.MarkEnvironmentActiveResponse
object
gitpod.v1.CountResponseRelation
string
gitpod.v1.RunnerProvider
string
RunnerProvider identifies the specific implementation type of a runner. Each provider maps to a specific kind of runner (local or remote), as specified below f…
gitpod.v1.CreateEnvironmentResponse
object
1 property 1 required
gitpod.v1.EnvironmentStatus.AutomationsFile.Presence
string
gitpod.v1.EnvironmentSpec.Content
object
4 properties
gitpod.v1.EnvironmentPhase
string

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

gitpod-gitpod-v1-environmentservice-api-openapi.yml Raw ↑

Other APIs Gitpod publishes across the network.

Gitpod Organizations API
AE Profile APIs.io
Gitpod Projects API
AE Profile APIs.io
Gitpod Accounts and Billing API
AE Profile APIs.io
Gitpod.v1.AccountService API
AE Profile APIs.io
Gitpod.v1.AgentSecurityService API
AE Profile APIs.io
Gitpod.v1.AgentService API
AE Profile APIs.io
Gitpod.v1.BillingService API
AE Profile APIs.io
Gitpod.v1.EditorService API
AE Profile APIs.io
Gitpod.v1.EnvironmentAutomationService API
AE Profile APIs.io
Gitpod.v1.ErrorsService API
AE Profile APIs.io
Gitpod.v1.EventService API
AE Profile APIs.io
Gitpod.v1.GatewayService API
AE Profile APIs.io
← Back to G APIs
API Details
ID
gitpod:gitpod-gitpod-v1-environmentservice-api
Base URL
https://api.gitpod.io
Docs
https://www.gitpod.io/docs/references/gitpod-public-api
Provider
Gitpod
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=gitpod-gitpod-v1-environmentservice-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/gitpod-gitpod-v1-environmentservice-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of Gitpod.v1.EnvironmentService API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.