Sign in

v18

latestOpenAPI 3.0.0raw.githubusercontent.com2026-08-014211,6201.8 MB
gitpod.v1.RunnerInteractionService

ListRunnerEnvironments

Lists all environments managed by a runner.

Use this method to:

  • View assigned environments
  • Monitor environment status
  • Check environment assignments

Examples

  • List environments:

    Shows all environments for a runner.

    runnerId: "d2c94c27-3b76-4a42-b88c-95a85e392c68"
pagination:
  pageSize: 20

  • List specific environments:

    Shows details for specific environment IDs.

    runnerId: "d2c94c27-3b76-4a42-b88c-95a85e392c68"
environmentIds: ["07e03a28-65a5-4d98-b532-8ea67b188048"]
pagination:
  pageSize: 20
post/gitpod.v1.RunnerInteractionService/ListRunnerEnvironments

Query parameters

pageSizeinteger
tokenstring

Request body

environmentIdsstring[]

An optional list of environment IDs to fetch. If this list is empty/not provided all environments that ought to run on the runner are returned.

runnerIdstring uuid

The runner's identifier

shardIdsinteger[]

Optional shard filter. When set, only return environments whose ShardOf(id) is in this set. Used by horizontally-scaled runner replicas to fetch only the resources they own. Values must be in [0, 64).

Response

Success