api.md

Shared Types

from gitpod.types import (
    ArbitraryData,
    AutomationTrigger,
    EnvironmentClass,
    ErrorCode,
    FieldValue,
    OrganizationRole,
    Principal,
    RunsOn,
    Subject,
    Task,
    TaskExecution,
    TaskExecutionMetadata,
    TaskExecutionPhase,
    TaskExecutionSpec,
    TaskExecutionStatus,
    TaskMetadata,
    TaskSpec,
    UserStatus,
)

Accounts

Types:

from gitpod.types import (
    Account,
    AccountMembership,
    JoinableOrganization,
    LoginProvider,
    AccountRetrieveResponse,
    AccountDeleteResponse,
    AccountGetSSOLoginURLResponse,
)

Methods:

• client.accounts.retrieve(**params) -> AccountRetrieveResponse
• client.accounts.delete(**params) -> object
• client.accounts.get_sso_login_url(**params) -> AccountGetSSOLoginURLResponse
• client.accounts.list_login_providers(**params) -> SyncLoginProvidersPage[LoginProvider]

Editors

Types:

from gitpod.types import Editor, EditorRetrieveResponse, EditorResolveURLResponse

Methods:

• client.editors.retrieve(**params) -> EditorRetrieveResponse
• client.editors.list(**params) -> SyncEditorsPage[Editor]
• client.editors.resolve_url(**params) -> EditorResolveURLResponse

Environments

Types:

from gitpod.types import (
    AdmissionLevel,
    Environment,
    EnvironmentActivitySignal,
    EnvironmentMetadata,
    EnvironmentPhase,
    EnvironmentSpec,
    EnvironmentStatus,
    EnvironmentCreateResponse,
    EnvironmentRetrieveResponse,
    EnvironmentUpdateResponse,
    EnvironmentDeleteResponse,
    EnvironmentCreateFromProjectResponse,
    EnvironmentCreateLogsTokenResponse,
    EnvironmentMarkActiveResponse,
    EnvironmentStartResponse,
    EnvironmentStopResponse,
)

Methods:

• client.environments.create(**params) -> EnvironmentCreateResponse
• client.environments.retrieve(**params) -> EnvironmentRetrieveResponse
• client.environments.update(**params) -> object
• client.environments.list(**params) -> SyncEnvironmentsPage[Environment]
• client.environments.delete(**params) -> object
• client.environments.create_from_project(**params) -> EnvironmentCreateFromProjectResponse
• client.environments.create_logs_token(**params) -> EnvironmentCreateLogsTokenResponse
• client.environments.mark_active(**params) -> object
• client.environments.start(**params) -> object
• client.environments.stop(**params) -> object

Automations

Types:

from gitpod.types.environments import AutomationsFile, AutomationUpsertResponse

Methods:

• client.environments.automations.upsert(**params) -> AutomationUpsertResponse

Services

Types:

from gitpod.types.environments.automations import (
    Service,
    ServiceMetadata,
    ServicePhase,
    ServiceSpec,
    ServiceStatus,
    ServiceCreateResponse,
    ServiceRetrieveResponse,
    ServiceUpdateResponse,
    ServiceDeleteResponse,
    ServiceStartResponse,
    ServiceStopResponse,
)

Methods:

• client.environments.automations.services.create(**params) -> ServiceCreateResponse
• client.environments.automations.services.retrieve(**params) -> ServiceRetrieveResponse
• client.environments.automations.services.update(**params) -> object
• client.environments.automations.services.list(**params) -> SyncServicesPage[Service]
• client.environments.automations.services.delete(**params) -> object
• client.environments.automations.services.start(**params) -> object
• client.environments.automations.services.stop(**params) -> object

Tasks

Types:

from gitpod.types.environments.automations import (
    TaskCreateResponse,
    TaskRetrieveResponse,
    TaskUpdateResponse,
    TaskDeleteResponse,
    TaskStartResponse,
)

Methods:

• client.environments.automations.tasks.create(**params) -> TaskCreateResponse
• client.environments.automations.tasks.retrieve(**params) -> TaskRetrieveResponse
• client.environments.automations.tasks.update(**params) -> object
• client.environments.automations.tasks.list(**params) -> SyncTasksPage[Task]
• client.environments.automations.tasks.delete(**params) -> object
• client.environments.automations.tasks.start(**params) -> TaskStartResponse

Executions

Types:

from gitpod.types.environments.automations.tasks import (
    ExecutionRetrieveResponse,
    ExecutionStopResponse,
)

Methods:

• client.environments.automations.tasks.executions.retrieve(**params) -> ExecutionRetrieveResponse
• client.environments.automations.tasks.executions.list(**params) -> SyncTaskExecutionsPage[TaskExecution]
• client.environments.automations.tasks.executions.stop(**params) -> object

Classes

Methods:

• client.environments.classes.list(**params) -> SyncEnvironmentClassesPage[EnvironmentClass]

Events

Types:

from gitpod.types import ResourceOperation, ResourceType, EventListResponse, EventWatchResponse

Methods:

• client.events.list(**params) -> SyncEntriesPage[EventListResponse]
• client.events.watch(**params) -> JSONLDecoder[EventWatchResponse]

Groups

Types:

from gitpod.types import Group

Methods:

• client.groups.list(**params) -> SyncGroupsPage[Group]

Identity

Types:

from gitpod.types import (
    IdentityExchangeTokenResponse,
    IdentityGetAuthenticatedIdentityResponse,
    IdentityGetIDTokenResponse,
)

Methods:

• client.identity.exchange_token(**params) -> IdentityExchangeTokenResponse
• client.identity.get_authenticated_identity(**params) -> IdentityGetAuthenticatedIdentityResponse
• client.identity.get_id_token(**params) -> IdentityGetIDTokenResponse

Organizations

Types:

from gitpod.types import (
    InviteDomains,
    Organization,
    OrganizationMember,
    Scope,
    OrganizationCreateResponse,
    OrganizationRetrieveResponse,
    OrganizationUpdateResponse,
    OrganizationDeleteResponse,
    OrganizationJoinResponse,
    OrganizationLeaveResponse,
    OrganizationSetRoleResponse,
)

Methods:

• client.organizations.create(**params) -> OrganizationCreateResponse
• client.organizations.retrieve(**params) -> OrganizationRetrieveResponse
• client.organizations.update(**params) -> OrganizationUpdateResponse
• client.organizations.list(**params) -> SyncOrganizationsPage[Organization]
• client.organizations.delete(**params) -> object
• client.organizations.join(**params) -> OrganizationJoinResponse
• client.organizations.leave(**params) -> object
• client.organizations.list_members(**params) -> SyncMembersPage[OrganizationMember]
• client.organizations.set_role(**params) -> object

DomainVerifications

Types:

from gitpod.types.organizations import (
    DomainVerification,
    DomainVerificationState,
    DomainVerificationCreateResponse,
    DomainVerificationRetrieveResponse,
    DomainVerificationDeleteResponse,
    DomainVerificationVerifyResponse,
)

Methods:

• client.organizations.domain_verifications.create(**params) -> DomainVerificationCreateResponse
• client.organizations.domain_verifications.retrieve(**params) -> DomainVerificationRetrieveResponse
• client.organizations.domain_verifications.list(**params) -> SyncDomainVerificationsPage[DomainVerification]
• client.organizations.domain_verifications.delete(**params) -> object
• client.organizations.domain_verifications.verify(**params) -> DomainVerificationVerifyResponse

Invites

Types:

from gitpod.types.organizations import (
    OrganizationInvite,
    InviteCreateResponse,
    InviteRetrieveResponse,
    InviteGetSummaryResponse,
)

Methods:

• client.organizations.invites.create(**params) -> InviteCreateResponse
• client.organizations.invites.retrieve(**params) -> InviteRetrieveResponse
• client.organizations.invites.get_summary(**params) -> InviteGetSummaryResponse

SSOConfigurations

Types:

from gitpod.types.organizations import (
    ProviderType,
    SSOConfiguration,
    SSOConfigurationState,
    SSOConfigurationCreateResponse,
    SSOConfigurationRetrieveResponse,
    SSOConfigurationUpdateResponse,
    SSOConfigurationDeleteResponse,
)

Methods:

• client.organizations.sso_configurations.create(**params) -> SSOConfigurationCreateResponse
• client.organizations.sso_configurations.retrieve(**params) -> SSOConfigurationRetrieveResponse
• client.organizations.sso_configurations.update(**params) -> object
• client.organizations.sso_configurations.list(**params) -> SyncSSOConfigurationsPage[SSOConfiguration]
• client.organizations.sso_configurations.delete(**params) -> object

Projects

Types:

from gitpod.types import (
    EnvironmentInitializer,
    Project,
    ProjectEnvironmentClass,
    ProjectMetadata,
    ProjectCreateResponse,
    ProjectRetrieveResponse,
    ProjectUpdateResponse,
    ProjectDeleteResponse,
    ProjectCreateFromEnvironmentResponse,
)

Methods:

• client.projects.create(**params) -> ProjectCreateResponse
• client.projects.retrieve(**params) -> ProjectRetrieveResponse
• client.projects.update(**params) -> ProjectUpdateResponse
• client.projects.list(**params) -> SyncProjectsPage[Project]
• client.projects.delete(**params) -> object
• client.projects.create_from_environment(**params) -> ProjectCreateFromEnvironmentResponse

Policies

Types:

from gitpod.types.projects import (
    ProjectPolicy,
    ProjectRole,
    PolicyCreateResponse,
    PolicyUpdateResponse,
    PolicyDeleteResponse,
)

Methods:

• client.projects.policies.create(**params) -> PolicyCreateResponse
• client.projects.policies.update(**params) -> PolicyUpdateResponse
• client.projects.policies.list(**params) -> SyncPoliciesPage[ProjectPolicy]
• client.projects.policies.delete(**params) -> object

Runners

Types:

from gitpod.types import (
    Runner,
    RunnerCapability,
    RunnerConfiguration,
    RunnerKind,
    RunnerPhase,
    RunnerProvider,
    RunnerReleaseChannel,
    RunnerSpec,
    RunnerStatus,
    RunnerCreateResponse,
    RunnerRetrieveResponse,
    RunnerUpdateResponse,
    RunnerDeleteResponse,
    RunnerCheckAuthenticationForHostResponse,
    RunnerCreateRunnerTokenResponse,
    RunnerParseContextURLResponse,
)

Methods:

• client.runners.create(**params) -> RunnerCreateResponse
• client.runners.retrieve(**params) -> RunnerRetrieveResponse
• client.runners.update(**params) -> object
• client.runners.list(**params) -> SyncRunnersPage[Runner]
• client.runners.delete(**params) -> object
• client.runners.check_authentication_for_host(**params) -> RunnerCheckAuthenticationForHostResponse
• client.runners.create_runner_token(**params) -> RunnerCreateRunnerTokenResponse
• client.runners.parse_context_url(**params) -> RunnerParseContextURLResponse

Configurations

Types:

from gitpod.types.runners import (
    EnvironmentClassValidationResult,
    FieldValidationError,
    ScmIntegrationValidationResult,
    ConfigurationValidateResponse,
)

Methods:

• client.runners.configurations.validate(**params) -> ConfigurationValidateResponse

EnvironmentClasses

Types:

from gitpod.types.runners.configurations import (
    EnvironmentClassCreateResponse,
    EnvironmentClassRetrieveResponse,
    EnvironmentClassUpdateResponse,
)

Methods:

• client.runners.configurations.environment_classes.create(**params) -> EnvironmentClassCreateResponse
• client.runners.configurations.environment_classes.retrieve(**params) -> EnvironmentClassRetrieveResponse
• client.runners.configurations.environment_classes.update(**params) -> object
• client.runners.configurations.environment_classes.list(**params) -> SyncEnvironmentClassesPage[EnvironmentClass]

HostAuthenticationTokens

Types:

from gitpod.types.runners.configurations import (
    HostAuthenticationToken,
    HostAuthenticationTokenSource,
    HostAuthenticationTokenCreateResponse,
    HostAuthenticationTokenRetrieveResponse,
    HostAuthenticationTokenUpdateResponse,
    HostAuthenticationTokenDeleteResponse,
)

Methods:

• client.runners.configurations.host_authentication_tokens.create(**params) -> HostAuthenticationTokenCreateResponse
• client.runners.configurations.host_authentication_tokens.retrieve(**params) -> HostAuthenticationTokenRetrieveResponse
• client.runners.configurations.host_authentication_tokens.update(**params) -> object
• client.runners.configurations.host_authentication_tokens.list(**params) -> SyncTokensPage[HostAuthenticationToken]
• client.runners.configurations.host_authentication_tokens.delete(**params) -> object

Schema

Types:

from gitpod.types.runners.configurations import RunnerConfigurationSchema, SchemaRetrieveResponse

Methods:

• client.runners.configurations.schema.retrieve(**params) -> SchemaRetrieveResponse

ScmIntegrations

Types:

from gitpod.types.runners.configurations import (
    ScmIntegration,
    ScmIntegrationOAuthConfig,
    ScmIntegrationCreateResponse,
    ScmIntegrationRetrieveResponse,
    ScmIntegrationUpdateResponse,
    ScmIntegrationDeleteResponse,
)

Methods:

• client.runners.configurations.scm_integrations.create(**params) -> ScmIntegrationCreateResponse
• client.runners.configurations.scm_integrations.retrieve(**params) -> ScmIntegrationRetrieveResponse
• client.runners.configurations.scm_integrations.update(**params) -> object
• client.runners.configurations.scm_integrations.list(**params) -> SyncIntegrationsPage[ScmIntegration]
• client.runners.configurations.scm_integrations.delete(**params) -> object

Policies

Types:

from gitpod.types.runners import (
    RunnerPolicy,
    RunnerRole,
    PolicyCreateResponse,
    PolicyUpdateResponse,
    PolicyDeleteResponse,
)

Methods:

• client.runners.policies.create(**params) -> PolicyCreateResponse
• client.runners.policies.update(**params) -> PolicyUpdateResponse
• client.runners.policies.list(**params) -> SyncPoliciesPage[RunnerPolicy]
• client.runners.policies.delete(**params) -> object

Secrets

Types:

from gitpod.types import (
    Secret,
    SecretCreateResponse,
    SecretDeleteResponse,
    SecretGetValueResponse,
    SecretUpdateValueResponse,
)

Methods:

• client.secrets.create(**params) -> SecretCreateResponse
• client.secrets.list(**params) -> SyncSecretsPage[Secret]
• client.secrets.delete(**params) -> object
• client.secrets.get_value(**params) -> SecretGetValueResponse
• client.secrets.update_value(**params) -> object

Users

Types:

from gitpod.types import User, UserGetAuthenticatedUserResponse, UserSetSuspendedResponse

Methods:

• client.users.get_authenticated_user(**params) -> UserGetAuthenticatedUserResponse
• client.users.set_suspended(**params) -> object

Pats

Types:

from gitpod.types.users import PersonalAccessToken, PatDeleteResponse, PatGetResponse

Methods:

• client.users.pats.list(**params) -> SyncPersonalAccessTokensPage[PersonalAccessToken]
• client.users.pats.delete(**params) -> object
• client.users.pats.get(**params) -> PatGetResponse