Skip to main content
Unary · Environments Lists all environments matching the specified criteria. Use this method to find and monitor environments across your organization. Results are ordered by creation time with newest environments first.

Examples

  • List running environments for a project: Retrieves all running environments for a specific project with pagination.
  • List all environments for a specific runner: Filters environments by runner ID and creator ID.
  • List stopped and deleted environments: Retrieves all environments in stopped or deleted state.

Endpoint

Send a Bearer token as described in Authentication. If your organization uses a custom management-plane domain, replace https://app.ona.com with that domain.

Request example

Request

gitpod.v1.ListEnvironmentsRequest

Response

gitpod.v1.ListEnvironmentsResponse
CountRequest controls whether the response should include a bounded count of matching records.gitpod.v1.CountRequest
CountResponse represents a bounded count of matching records. When the actual count exceeds the counting limit, value is capped and relation is set to GREATER_THAN_OR_EQUAL.gitpod.v1.CountResponse
gitpod.v1.Environment
EnvironmentMetadata is data associated with an environment that’s required for other parts of the system to functiongitpod.v1.EnvironmentMetadata
EnvironmentSpec specifies the configuration of an environment for an environment startgitpod.v1.EnvironmentSpec
EnvironmentStatus describes an environment statusgitpod.v1.EnvironmentStatus
gitpod.v1.ListEnvironmentsRequest.Filter
gitpod.v1.ListEnvironmentsRequest.Sort
gitpod.v1.PaginationRequest
gitpod.v1.PaginationResponse
Admission level describes who can access an environment instance and its ports.
EnvironmentRole represents the role of an environment
RunnerKind represents the kind of a runner