v18

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

UpdateRunnerEnvironmentStatus

Provides comprehensive status updates about a managed environment. This method allows runners to report detailed state information about environments they're managing.

Use this method to:

  • Report current environment phase and health status
  • Update machine and container states
  • Signal content and devcontainer readiness
  • Provide access URLs and endpoints
  • Report warnings or failure conditions

Examples

  • Update status:

    Provides a detailed status update for an environment.

    runnerId: "d2c94c27-3b76-4a42-b88c-95a85e392c68"
    environmentId: "07e03a28-65a5-4d98-b532-8ea67b188048"
    status:
      phase: ENVIRONMENT_PHASE_RUNNING
      statusVersion: "1"
      failureMessage: []
      warningMessage: []
      machine:
        phase: PHASE_RUNNING
      content:
        phase: CONTENT_PHASE_READY
      devcontainer:
        phase: PHASE_RUNNING
      environmentUrls:
        logs: "https://logs.gitpod.io/environment"
        ports: []
        ssh:
          url: "ssh://ssh.gitpod.io:22"
    
post/gitpod.v1.RunnerInteractionService/UpdateRunnerEnvironmentStatus

Request body

environmentIdstring uuid

The environment's ID

runnerIdstring uuid

The runner's identity

Response

Success

GitpodV1UpdateRunnerEnvironmentStatusResponse required