LogoGitpod API Reference

Shared

$shared

Domain types

AutomationTrigger = { beforeSnapshot, manual, postDevcontainerStart, 3 more... }

An AutomationTrigger represents a trigger for an automation action. The manual field shows a start button in the UI for manually triggering the automation. The post_machine_start field indicates that the automation should be triggered after the machine has started, before the devcontainer is ready. This is used for machine-level services like security agents that need to start early. The post_environment_start field indicates that the automation should be triggered after the environment has started (devcontainer ready). The post_devcontainer_start field indicates that the automation should be triggered after the dev container has started. The prebuild field starts the automation during a prebuild of an environment. This phase does not have user secrets available. The before_snapshot field triggers the automation after all prebuild tasks complete but before the snapshot is taken. This is used for tasks that need to run last during prebuilds, such as IDE warmup. Note: The prebuild and before_snapshot triggers can only be used with tasks, not services.

EnvironmentClass = { id, runnerId, configuration, 3 more... }
EnvironmentVariableItem = { name, value, valueFrom }

EnvironmentVariableItem represents an environment variable that can be set either from a literal value or from a secret reference.

EnvironmentVariableSource = { secretRef }

EnvironmentVariableSource specifies a source for an environment variable value.

ErrorCode = "canceled" | "unknown" | "invalid_argument" | 13 more...

The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].

FieldValue = { key, value }
Gateway = { name, url, region }

Gateway represents a system gateway that provides access to services

OrganizationRole = "ORGANIZATION_ROLE_UNSPECIFIED" | "ORGANIZATION_ROLE_ADMIN" | "ORGANIZATION_ROLE_MEMBER"
OrganizationTier = "ORGANIZATION_TIER_UNSPECIFIED" | "ORGANIZATION_TIER_FREE" | "ORGANIZATION_TIER_ENTERPRISE" | 2 more...
Principal = "PRINCIPAL_UNSPECIFIED" | "PRINCIPAL_ACCOUNT" | "PRINCIPAL_USER" | 5 more...
ProjectEnvironmentClass = { environmentClassId, localRunner, order }
ResourceRole = "RESOURCE_ROLE_UNSPECIFIED" | "RESOURCE_ROLE_ORG_ADMIN" | "RESOURCE_ROLE_ORG_MEMBER" | 49 more...

ResourceRole represents roles that can be assigned to groups on resources These map directly to the roles defined in backend/db/rule/rbac/role/role.go

ResourceType = "RESOURCE_TYPE_UNSPECIFIED" | "RESOURCE_TYPE_ENVIRONMENT" | "RESOURCE_TYPE_RUNNER" | 43 more...
RunsOn = { docker, machine }
SecretRef = { id }

SecretRef references a secret by its ID.

State = "STATE_UNSPECIFIED" | "STATE_OPEN" | "STATE_CLOSED" | 1 more...

Current state of the pull request

Subject = { id, principal }
Task = { id, dependsOn, environmentId, 2 more... }
TaskExecution = { id, metadata, spec, 1 more... }
TaskExecutionMetadata = { completedAt, createdAt, creator, 4 more... }
TaskExecutionPhase = "TASK_EXECUTION_PHASE_UNSPECIFIED" | "TASK_EXECUTION_PHASE_PENDING" | "TASK_EXECUTION_PHASE_RUNNING" | 3 more...
TaskExecutionSpec = { desiredPhase, plan }
TaskExecutionStatus = { failureMessage, logUrl, phase, 2 more... }
TaskMetadata = { createdAt, creator, description, 3 more... }
TaskSpec = { command, env, runsOn }
UserStatus = "USER_STATUS_UNSPECIFIED" | "USER_STATUS_ACTIVE" | "USER_STATUS_SUSPENDED" | 1 more...