Sign in

v18

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

UpdateRunnerEnvironmentSnapshotStatus

Updates the status of a snapshot during its lifecycle.

Use this method to:

  • Report snapshot creation progress
  • Update completion percentage
  • Set snapshot phase (pending, creating, available, failed)
  • Provide provider-specific snapshot details
  • Report failure messages when snapshot creation fails
post/gitpod.v1.RunnerInteractionService/UpdateRunnerEnvironmentSnapshotStatus

Request body

runnerIdstring uuid required

The runner's identity

snapshotIdstring uuid required

snapshot_id specifies the snapshot to update

Response

Success

GitpodV1UpdateRunnerEnvironmentSnapshotStatusResponse required