client

Mar 3, 2026

Changes in this version

type Client

+ SSHKeys *sshkey.Client

Jan 26, 2026

Changes in this version

type Client

+ Configs *configversion.Client

+ Organizations *organization.Client

+ Runners *runner.Client

+ Runs *run.Client

+ States *state.Client

+ Teams *team.Client

+ Users *user.Client

+ Variables *variable.Client

+ Workspaces *workspace.Client

+ func (c *Client) UseToken(token string) *Client

Jun 25, 2023

Changes in this version

+ func New(config http.Config) (*remoteClient, error)

+ type Client interface

+ AddTeamMembership func(ctx context.Context, opts auth.TeamMembershipOptions) error

+ CreateAgentToken func(ctx context.Context, opts tokens.CreateAgentTokenOptions) ([]byte, error)

+ CreateOrganization func(ctx context.Context, opts orgcreator.OrganizationCreateOptions) (*organization.Organization, error)

+ CreateStateVersion func(ctx context.Context, opts state.CreateStateVersionOptions) (*state.Version, error)

+ CreateTeam func(ctx context.Context, opts auth.CreateTeamOptions) (*auth.Team, error)

+ CreateUser func(ctx context.Context, username string, opts ...auth.NewUserOption) (*auth.User, error)

+ DeleteOrganization func(ctx context.Context, organization string) error

+ DeleteStateVersion func(ctx context.Context, svID string) error

+ DeleteTeam func(ctx context.Context, teamID string) error

+ DeleteUser func(ctx context.Context, username string) error

+ DownloadConfig func(ctx context.Context, id string) ([]byte, error)

+ DownloadCurrentState func(ctx context.Context, workspaceID string) ([]byte, error)

+ DownloadState func(ctx context.Context, svID string) ([]byte, error)

+ FinishPhase func(ctx context.Context, id string, phase internal.PhaseType, ...) (*run.Run, error)

+ GetAgentToken func(ctx context.Context, token string) (*tokens.AgentToken, error)

+ GetCurrentStateVersion func(ctx context.Context, workspaceID string) (*state.Version, error)

+ GetLockFile func(ctx context.Context, id string) ([]byte, error)

+ GetPlanFile func(ctx context.Context, id string, format run.PlanFormat) ([]byte, error)

+ GetRun func(ctx context.Context, id string) (*run.Run, error)

+ GetTeam func(ctx context.Context, organization, team string) (*auth.Team, error)

+ GetWorkspace func(ctx context.Context, workspaceID string) (*workspace.Workspace, error)

+ GetWorkspaceByName func(ctx context.Context, organization, workspace string) (*workspace.Workspace, error)

+ Hostname func() string

+ ListRuns func(ctx context.Context, opts run.RunListOptions) (*run.RunList, error)

+ ListStateVersions func(ctx context.Context, options state.StateVersionListOptions) (*state.VersionList, error)

+ ListVariables func(ctx context.Context, workspaceID string) ([]*variable.Variable, error)

+ ListWorkspaces func(ctx context.Context, opts workspace.ListOptions) (*workspace.WorkspaceList, error)

+ RemoveTeamMembership func(ctx context.Context, opts auth.TeamMembershipOptions) error

+ RollbackStateVersion func(ctx context.Context, svID string) (*state.Version, error)

+ StartPhase func(ctx context.Context, id string, phase internal.PhaseType, ...) (*run.Run, error)

+ UpdateWorkspace func(ctx context.Context, workspaceID string, opts workspace.UpdateOptions) (*workspace.Workspace, error)

+ UploadLockFile func(ctx context.Context, id string, lockFile []byte) error

+ UploadPlanFile func(ctx context.Context, id string, plan []byte, format run.PlanFormat) error

+ Watch func(context.Context, run.WatchOptions) (<-chan pubsub.Event, error)

+ type LocalClient struct