v18

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

GetEnvironment

Gets details about a specific environment including its status, configuration, and context URL.

Use this method to:

  • Check if an environment is ready to use
  • Get connection details for IDE and exposed ports
  • Monitor environment health and resource usage
  • Debug environment setup issues

Examples

  • Get environment details:

    Retrieves detailed information about a specific environment using its unique identifier.

    environmentId: "07e03a28-65a5-4d98-b532-8ea67b188048"
    
post/gitpod.v1.EnvironmentService/GetEnvironment

Request body

environmentIdstring uuid required

environment_id specifies the environment to get

Response

Success