v0.27.3 Latest Latest

This package is not in the latest version of its module.

Go to latest
Published: Aug 1, 2023 License: AGPL-3.0 Imports: 46 Imported by: 2




View Source
const (
	// SessionTokenCookie represents the name of the cookie or query parameter the API key is stored in.
	SessionTokenCookie = "coder_session_token"
	// SessionTokenHeader is the custom header to use for authentication.
	SessionTokenHeader = "Coder-Session-Token"
	// OAuth2StateCookie is the name of the cookie that stores the oauth2 state.
	OAuth2StateCookie = "oauth_state"
	// OAuth2RedirectCookie is the name of the cookie that stores the oauth2 redirect.
	OAuth2RedirectCookie = "oauth_redirect"

	// DevURLSessionTokenCookie is the name of the cookie that stores a devurl
	// token on app domains.
	DevURLSessionTokenCookie = "coder_devurl_session_token"
	// DevURLSignedAppTokenCookie is the name of the cookie that stores a
	// temporary JWT that can be used to authenticate instead of the session
	// token.
	DevURLSignedAppTokenCookie = "coder_devurl_signed_app_token"
	// SignedAppTokenQueryParameter is the name of the query parameter that
	// stores a temporary JWT that can be used to authenticate instead of the
	// session token. This is only acceptable on reconnecting-pty requests, not
	// apps.
	// It has a random suffix to avoid conflict with user query parameters on
	// apps.
	SignedAppTokenQueryParameter = "coder_signed_app_token_23db1dde"

	// BypassRatelimitHeader is the custom header to use to bypass ratelimits.
	// Only owners can bypass rate limits. This is typically used for scale testing.
	// nolint: gosec
	BypassRatelimitHeader = "X-Coder-Bypass-Ratelimit"

	// CLITelemetryHeader contains a base64-encoded representation of the CLI
	// command that was invoked to produce the request. It is for internal use
	// only.
	CLITelemetryHeader = "Coder-CLI-Telemetry"

These cookies are Coder-specific. If a new one is added or changed, the name shouldn't be likely to conflict with any user-application set cookies. Be sure to strip additional cookies in httpapi.StripCoderCookies!

View Source
const (
	LogSourceProvisionerDaemon LogSource = "provisioner_daemon"
	LogSourceProvisioner       LogSource = "provisioner"

	LogLevelTrace LogLevel = "trace"
	LogLevelDebug LogLevel = "debug"
	LogLevelInfo  LogLevel = "info"
	LogLevelWarn  LogLevel = "warn"
	LogLevelError LogLevel = "error"
View Source
const (
	WorkspaceAgentSSHPort             = tailnet.WorkspaceAgentSSHPort
	WorkspaceAgentReconnectingPTYPort = tailnet.WorkspaceAgentReconnectingPTYPort
	WorkspaceAgentSpeedtestPort       = tailnet.WorkspaceAgentSpeedtestPort
	// WorkspaceAgentHTTPAPIServerPort serves a HTTP server with endpoints for e.g.
	// gathering agent statistics.
	WorkspaceAgentHTTPAPIServerPort = 4

	// WorkspaceAgentMinimumListeningPort is the minimum port that the listening-ports
	// endpoint will return to the client, and the minimum port that is accepted
	// by the proxy applications endpoint. Coder consumes ports 1-4 at the
	// moment, and we reserve some extra ports for future use. Port 9 and up are
	// available for the user.
	// This is not enforced in the CLI intentionally as we don't really care
	// *that* much. The user could bypass this in the CLI by using SSH instead
	// anyways.
	WorkspaceAgentMinimumListeningPort = 9
View Source
const (
	ContentTypeTar = "application/x-tar"
View Source
const (
	LicenseExpiryClaim = "license_expires"


View Source
var ErrSkipClose = xerrors.New("skip tailnet close")
View Source
var ExperimentsAll = Experiments{}

ExperimentsAll should include all experiments that are safe for users to opt-in to via --experimental='*'. Experiments that are not ready for consumption by all users should not be included here and will be essentially hidden.

FeatureNames must be kept in-sync with the Feature enum above.

View Source
var Me = "me"

Me is used as a replacement for your own ID.

View Source
var WorkspaceAgentIP = netip.MustParseAddr("fd7a:115c:a1e0:49d6:b259:b7ac:b1b2:48f4")

WorkspaceAgentIP is a static IPv6 address with the Tailscale prefix that is used to route connections from clients to this node. A dynamic address is not required because a Tailnet client only dials a single agent at a time.

Deprecated: use tailnet.IP() instead. This is kept for backwards compatibility with wsconncache. See:

View Source
var WorkspaceAgentIgnoredListeningPorts = map[uint16]struct{}{
	0: {},

	1: {},
	2: {},
	3: {},
	4: {},
	5: {},
	6: {},
	7: {},
	8: {},

	20: {},
	21: {},

	22: {},

	23: {},

	25: {},

	53: {},

	110: {},

	143: {},

	179: {},

	389: {},
	636: {},

	465: {},

	587: {},

	989: {},
	990: {},

	993: {},

	995: {},

	3306: {},

	3389: {},

	5432: {},

	27017: {},
	27018: {},
	27019: {},
	28017: {},

WorkspaceAgentIgnoredListeningPorts contains a list of ports to ignore when looking for running applications inside a workspace. We want to ignore non-HTTP servers, so we pre-populate this list with common ports that are not HTTP servers.

This is implemented as a map for fast lookup.

WorkspaceAgentLifecycleOrder is the order in which workspace agent lifecycle states are expected to be reported during the lifetime of the agent process. For instance, the agent can go from starting to ready without reporting timeout or error, but it should not go from ready to starting. This is merely a hint for the agent process, and is not enforced by the server.


func BitmapToWeekdays added in v0.26.2

func BitmapToWeekdays(bitmap uint8) []string

BitmapToWeekdays converts a bitmap to a list of weekdays in accordance with the schedule package's rules (see above).

func DefaultCacheDir added in v0.19.0

func DefaultCacheDir() string

func IsConnectionError added in v0.16.0

func IsConnectionError(err error) bool

IsConnectionError is a convenience function for checking if the source of an error is due to a 'connection refused', 'no such host', etc.

func IsSecretDeploymentOption added in v0.19.0

func IsSecretDeploymentOption(opt clibase.Option) bool

func IsWorkspaceProxies added in v0.23.0

func IsWorkspaceProxies(opt clibase.Option) bool

IsWorkspaceProxies returns true if the cli option is used by workspace proxies.

func ParseSSHConfigOption added in v0.20.0

func ParseSSHConfigOption(opt string) (key string, value string, err error)

ParseSSHConfigOption parses a single ssh config option into it's key/value pair.

func ReadBodyAsError added in v0.16.0

func ReadBodyAsError(res *http.Response) error

ReadBodyAsError reads the response as a codersdk.Response, and wraps it in a codersdk.Error type for easy marshaling.

func ServerSentEventReader added in v0.9.0

func ServerSentEventReader(ctx context.Context, rc io.ReadCloser) func() (*ServerSentEvent, error)

func TimezoneOffsetHour added in v0.24.0

func TimezoneOffsetHour(loc *time.Location) int

func ValidateNewWorkspaceParameters added in v0.17.0

func ValidateNewWorkspaceParameters(richParameters []TemplateVersionParameter, buildParameters []WorkspaceBuildParameter) error

func ValidateWorkspaceBuildParameter added in v0.15.3

func ValidateWorkspaceBuildParameter(richParameter TemplateVersionParameter, buildParameter *WorkspaceBuildParameter, lastBuildParameter *WorkspaceBuildParameter) error

func ValidateWorkspaceBuildParameters added in v0.15.3

func ValidateWorkspaceBuildParameters(richParameters []TemplateVersionParameter, buildParameters, lastBuildParameters []WorkspaceBuildParameter) error

func WeekdaysToBitmap added in v0.26.2

func WeekdaysToBitmap(days []string) (uint8, error)

WeekdaysToBitmap converts a list of weekdays to a bitmap in accordance with the schedule package's rules. The 0th bit is Monday, ..., the 6th bit is Sunday. The 7th bit is unused.

func WorkspaceDisplayStatus added in v0.7.7

func WorkspaceDisplayStatus(jobStatus ProvisionerJobStatus, transition WorkspaceTransition) string

WorkspaceDisplayStatus computes a status to display on CLI/UI based on the workspace transition and the status of the provisioner job. This code is in sync with how we compute the status on frontend. Ref: site/src/util/workspace.ts (getWorkspaceStatus)

func WorkspaceNotifyChannel added in v0.12.6

func WorkspaceNotifyChannel(id uuid.UUID) string

WorkspaceNotifyChannel is the PostgreSQL NOTIFY channel to listen for updates on. The payload is empty, because the size of a workspace payload can be very large.


type APIKey added in v0.7.6

type APIKey struct {
	ID              string      `json:"id" validate:"required"`
	UserID          uuid.UUID   `json:"user_id" validate:"required" format:"uuid"`
	LastUsed        time.Time   `json:"last_used" validate:"required" format:"date-time"`
	ExpiresAt       time.Time   `json:"expires_at" validate:"required" format:"date-time"`
	CreatedAt       time.Time   `json:"created_at" validate:"required" format:"date-time"`
	UpdatedAt       time.Time   `json:"updated_at" validate:"required" format:"date-time"`
	LoginType       LoginType   `json:"login_type" validate:"required" enums:"password,github,oidc,token"`
	Scope           APIKeyScope `json:"scope" validate:"required" enums:"all,application_connect"`
	TokenName       string      `json:"token_name" validate:"required"`
	LifetimeSeconds int64       `json:"lifetime_seconds" validate:"required"`

APIKey: do not ever return the HashedSecret

type APIKeyScope added in v0.10.0

type APIKeyScope string
const (
	// APIKeyScopeAll is a scope that allows the user to do everything.
	APIKeyScopeAll APIKeyScope = "all"
	// APIKeyScopeApplicationConnect is a scope that allows the user
	// to connect to applications in a workspace.
	APIKeyScopeApplicationConnect APIKeyScope = "application_connect"

type APIKeyWithOwner added in v0.18.0

type APIKeyWithOwner struct {
	Username string `json:"username"`

type AddLicenseRequest added in v0.8.7

type AddLicenseRequest struct {
	License string `json:"license" validate:"required"`

type AgentStatsReportRequest added in v0.8.12

type AgentStatsReportRequest struct{}

AgentStatsReportRequest is a WebSocket request by coderd to the agent for stats. @typescript-ignore AgentStatsReportRequest

type AgentStatsReportResponse added in v0.8.12

type AgentStatsReportResponse struct {
	NumConns int64 `json:"num_comms"`
	// RxBytes is the number of received bytes.
	RxBytes int64 `json:"rx_bytes"`
	// TxBytes is the number of transmitted bytes.
	TxBytes int64 `json:"tx_bytes"`

AgentStatsReportResponse is returned for each report request by the agent.

type AgentSubsystem added in v0.23.5

type AgentSubsystem string
const (
	AgentSubsystemEnvbox AgentSubsystem = "envbox"

type AppHostResponse added in v0.16.0

type AppHostResponse struct {
	// Host is the externally accessible URL for the Coder instance.
	Host string `json:"host"`

type AppearanceConfig added in v0.14.0

type AppearanceConfig struct {
	LogoURL       string              `json:"logo_url"`
	ServiceBanner ServiceBannerConfig `json:"service_banner"`
	SupportLinks  []LinkConfig        `json:"support_links,omitempty"`

type AssignableRoles added in v0.8.6

type AssignableRoles struct {
	Assignable bool `json:"assignable"`

type AuditAction added in v0.8.11

type AuditAction string
const (
	AuditActionCreate   AuditAction = "create"
	AuditActionWrite    AuditAction = "write"
	AuditActionDelete   AuditAction = "delete"
	AuditActionStart    AuditAction = "start"
	AuditActionStop     AuditAction = "stop"
	AuditActionLogin    AuditAction = "login"
	AuditActionLogout   AuditAction = "logout"
	AuditActionRegister AuditAction = "register"

func (AuditAction) Friendly added in v0.16.0

func (a AuditAction) Friendly() string

type AuditDiff added in v0.8.11

type AuditDiff map[string]AuditDiffField

type AuditDiffField added in v0.8.11

type AuditDiffField struct {
	Old    any  `json:"old,omitempty"`
	New    any  `json:"new,omitempty"`
	Secret bool `json:"secret"`

type AuditLog added in v0.8.11

type AuditLog struct {
	ID             uuid.UUID    `json:"id" format:"uuid"`
	RequestID      uuid.UUID    `json:"request_id" format:"uuid"`
	Time           time.Time    `json:"time" format:"date-time"`
	OrganizationID uuid.UUID    `json:"organization_id" format:"uuid"`
	IP             netip.Addr   `json:"ip"`
	UserAgent      string       `json:"user_agent"`
	ResourceType   ResourceType `json:"resource_type"`
	ResourceID     uuid.UUID    `json:"resource_id" format:"uuid"`
	// ResourceTarget is the name of the resource.
	ResourceTarget   string          `json:"resource_target"`
	ResourceIcon     string          `json:"resource_icon"`
	Action           AuditAction     `json:"action"`
	Diff             AuditDiff       `json:"diff"`
	StatusCode       int32           `json:"status_code"`
	AdditionalFields json.RawMessage `json:"additional_fields"`
	Description      string          `json:"description"`
	ResourceLink     string          `json:"resource_link"`
	IsDeleted        bool            `json:"is_deleted"`

	User *User `json:"user"`

type AuditLogResponse added in v0.8.14

type AuditLogResponse struct {
	AuditLogs []AuditLog `json:"audit_logs"`
	Count     int64      `json:"count"`

type AuditLogsRequest added in v0.9.0

type AuditLogsRequest struct {
	SearchQuery string `json:"q,omitempty"`

type AuthMethod added in v0.16.0

type AuthMethod struct {
	Enabled bool `json:"enabled"`

type AuthMethods added in v0.4.4

type AuthMethods struct {
	ConvertToOIDCEnabled bool           `json:"convert_to_oidc_enabled"`
	Password             AuthMethod     `json:"password"`
	Github               AuthMethod     `json:"github"`
	OIDC                 OIDCAuthMethod `json:"oidc"`

AuthMethods contains authentication method information like whether they are enabled or not or custom text, etc.

type AuthorizationCheck added in v0.9.0

type AuthorizationCheck struct {
	// Object can represent a "set" of objects, such as: all workspaces in an organization, all workspaces owned by me, and all workspaces across the entire product.
	// When defining an object, use the most specific language when possible to
	// produce the smallest set. Meaning to set as many fields on 'Object' as
	// you can. Example, if you want to check if you can update all workspaces
	// owned by 'me', try to also add an 'OrganizationID' to the settings.
	// Omitting the 'OrganizationID' could produce the incorrect value, as
	// workspaces have both `user` and `organization` owners.
	Object AuthorizationObject `json:"object"`
	Action string              `json:"action" enums:"create,read,update,delete"`

AuthorizationCheck is used to check if the currently authenticated user (or the specified user) can do a given action to a given set of objects.

@Description AuthorizationCheck is used to check if the currently authenticated user (or the specified user) can do a given action to a given set of objects.

type AuthorizationObject added in v0.9.0

type AuthorizationObject struct {
	// ResourceType is the name of the resource.
	// `./coderd/rbac/object.go` has the list of valid resource types.
	ResourceType RBACResource `json:"resource_type"`
	// OwnerID (optional) adds the set constraint to all resources owned by a given user.
	OwnerID string `json:"owner_id,omitempty"`
	// OrganizationID (optional) adds the set constraint to all resources owned by a given organization.
	OrganizationID string `json:"organization_id,omitempty"`
	// ResourceID (optional) reduces the set to a singular resource. This assigns
	// a resource ID to the resource type, eg: a single workspace.
	// The rbac library will not fetch the resource from the database, so if you
	// are using this option, you should also set the owner ID and organization ID
	// if possible. Be as specific as possible using all the fields relevant.
	ResourceID string `json:"resource_id,omitempty"`

AuthorizationObject can represent a "set" of objects, such as: all workspaces in an organization, all workspaces owned by me, all workspaces across the entire product.

@Description AuthorizationObject can represent a "set" of objects, such as: all workspaces in an organization, all workspaces owned by me, @Description all workspaces across the entire product.

type AuthorizationRequest added in v0.9.0

type AuthorizationRequest struct {
	// Checks is a map keyed with an arbitrary string to a permission check.
	// The key can be any string that is helpful to the caller, and allows
	// multiple permission checks to be run in a single request.
	// The key ensures that each permission check has the same key in the
	// response.
	Checks map[string]AuthorizationCheck `json:"checks"`

AuthorizationRequest is a structure instead of a map because go-playground/validate can only validate structs. If you attempt to pass a map into `httpapi.Read`, you will get an invalid type error.

type AuthorizationResponse added in v0.9.0

type AuthorizationResponse map[string]bool

type BuildInfoResponse added in v0.4.1

type BuildInfoResponse struct {
	// ExternalURL references the current Coder version.
	// For production builds, this will link directly to a release. For development builds, this will link to a commit.
	ExternalURL string `json:"external_url"`
	// Version returns the semantic version of the build.
	Version string `json:"version"`

	// DashboardURL is the URL to hit the deployment's dashboard.
	// For external workspace proxies, this is the coderd they are connected
	// to.
	DashboardURL string `json:"dashboard_url"`

	WorkspaceProxy bool `json:"workspace_proxy"`

BuildInfoResponse contains build information for this instance of Coder.

func (BuildInfoResponse) CanonicalVersion added in v0.7.7

func (b BuildInfoResponse) CanonicalVersion() string

CanonicalVersion trims build information from the version. E.g. 'v0.7.4-devel+11573034' -> 'v0.7.4'.

type BuildReason added in v0.7.2

type BuildReason string
const (
	// "initiator" is used when a workspace build is triggered by a user.
	// Combined with the initiator id/username, it indicates which user initiated the build.
	BuildReasonInitiator BuildReason = "initiator"
	// "autostart" is used when a build to start a workspace is triggered by Autostart.
	// The initiator id/username in this case is the workspace owner and can be ignored.
	BuildReasonAutostart BuildReason = "autostart"
	// "autostop" is used when a build to stop a workspace is triggered by Autostop.
	// The initiator id/username in this case is the workspace owner and can be ignored.
	BuildReasonAutostop BuildReason = "autostop"

type Client

type Client struct {
	HTTPClient *http.Client
	URL        *url.URL

	// SessionTokenHeader is an optional custom header to use for setting tokens. By
	// default 'Coder-Session-Token' is used.
	SessionTokenHeader string

	// PlainLogger may be set to log HTTP traffic in a human-readable form.
	// It uses the LogBodies option.
	PlainLogger io.Writer

	// Trace can be enabled to propagate tracing spans to the Coder API.
	// This is useful for tracking a request end-to-end.
	Trace bool

	// DisableDirectConnections forces any connections to workspaces to go
	// through DERP, regardless of the BlockEndpoints setting on each
	// connection.
	DisableDirectConnections bool
	// contains filtered or unexported fields

Client is an HTTP caller for methods to the Coder API. @typescript-ignore Client

func New

func New(serverURL *url.URL) *Client

New creates a Coder client for the provided URL.

func (*Client) APIKeyByID added in v0.19.0

func (c *Client) APIKeyByID(ctx context.Context, userID string, id string) (*APIKey, error)

APIKeyByID returns the api key by id.

func (*Client) APIKeyByName added in v0.19.0

func (c *Client) APIKeyByName(ctx context.Context, userID string, name string) (*APIKey, error)

APIKeyByName returns the api key by name.

func (*Client) AddLicense added in v0.8.7

func (c *Client) AddLicense(ctx context.Context, r AddLicenseRequest) (License, error)

func (*Client) AppHost added in v0.16.0

func (c *Client) AppHost(ctx context.Context) (AppHostResponse, error)

AppHost returns the site-wide application wildcard hostname without the leading "*.", e.g. "". Apps are accessible at: "<app-name>--<agent-name>--<workspace-name>--<username>.<app-host>", e.g. "".

If the app host is not set, the response will contain an empty string.

func (*Client) Appearance added in v0.14.0

func (c *Client) Appearance(ctx context.Context) (AppearanceConfig, error)

Appearance returns the configuration that modifies the visual display of the dashboard.

func (*Client) AuditLogs added in v0.8.14

func (c *Client) AuditLogs(ctx context.Context, req AuditLogsRequest) (AuditLogResponse, error)

AuditLogs retrieves audit logs from the given page.

func (*Client) AuthCheck added in v0.16.0

AuthCheck allows the authenticated user to check if they have the given permissions to a set of resources.

func (*Client) AuthMethods added in v0.4.4

func (c *Client) AuthMethods(ctx context.Context) (AuthMethods, error)

AuthMethods returns types of authentication available to the user.

func (*Client) BuildInfo added in v0.4.1

func (c *Client) BuildInfo(ctx context.Context) (BuildInfoResponse, error)

BuildInfo returns build information for this instance of Coder.

func (*Client) CancelTemplateVersion added in v0.4.0

func (c *Client) CancelTemplateVersion(ctx context.Context, version uuid.UUID) error

CancelTemplateVersion marks a template version job as canceled.

func (*Client) CancelTemplateVersionDryRun added in v0.6.1

func (c *Client) CancelTemplateVersionDryRun(ctx context.Context, version, job uuid.UUID) error

CancelTemplateVersionDryRun marks a template version dry-run job as canceled.

func (*Client) CancelWorkspaceBuild

func (c *Client) CancelWorkspaceBuild(ctx context.Context, id uuid.UUID) error

CancelWorkspaceBuild marks a workspace build job as canceled.

func (*Client) ConvertLoginType added in v0.25.0

func (c *Client) ConvertLoginType(ctx context.Context, req ConvertLoginRequest) (OAuthConversionResponse, error)

ConvertLoginType will send a request to convert the user from password based authentication to oauth based. The response has the oauth state code to use in the oauth flow.

func (*Client) CreateAPIKey

func (c *Client) CreateAPIKey(ctx context.Context, user string) (GenerateAPIKeyResponse, error)

CreateAPIKey generates an API key for the user ID provided. CreateToken should be used over CreateAPIKey. CreateToken allows better tracking of the token's usage and allows for custom expiration. Only use CreateAPIKey if you want to emulate the session created for a browser like login.

func (*Client) CreateFirstUser

CreateFirstUser attempts to create the first user on a Coder deployment. This initial user has superadmin privileges. If >0 users exist, this request will fail.

func (*Client) CreateGroup added in v0.9.9

func (c *Client) CreateGroup(ctx context.Context, orgID uuid.UUID, req CreateGroupRequest) (Group, error)

func (*Client) CreateOrganization

func (c *Client) CreateOrganization(ctx context.Context, req CreateOrganizationRequest) (Organization, error)

CreateOrganization creates an organization and adds the provided user as an admin.

func (*Client) CreateTemplate added in v0.4.0

func (c *Client) CreateTemplate(ctx context.Context, organizationID uuid.UUID, request CreateTemplateRequest) (Template, error)

CreateTemplate creates a new template inside an organization.

func (*Client) CreateTemplateVersion added in v0.4.0

func (c *Client) CreateTemplateVersion(ctx context.Context, organizationID uuid.UUID, req CreateTemplateVersionRequest) (TemplateVersion, error)

CreateTemplateVersion processes source-code and optionally associates the version with a template. Executing without a template is useful for validating source-code.

func (*Client) CreateTemplateVersionDryRun added in v0.6.1

func (c *Client) CreateTemplateVersionDryRun(ctx context.Context, version uuid.UUID, req CreateTemplateVersionDryRunRequest) (ProvisionerJob, error)

CreateTemplateVersionDryRun begins a dry-run provisioner job against the given template version with the given parameter values.

func (*Client) CreateTestAuditLog added in v0.8.14

func (c *Client) CreateTestAuditLog(ctx context.Context, req CreateTestAuditLogRequest) error

CreateTestAuditLog creates a fake audit log. Only owners of the organization can perform this action. It's used for testing purposes.

func (*Client) CreateToken added in v0.9.7

func (c *Client) CreateToken(ctx context.Context, userID string, req CreateTokenRequest) (GenerateAPIKeyResponse, error)

CreateToken generates an API key for the user ID provided with custom expiration. These tokens can be used for long-lived access, like for use with CI.

func (*Client) CreateUser

func (c *Client) CreateUser(ctx context.Context, req CreateUserRequest) (User, error)

CreateUser creates a new user.

func (*Client) CreateWorkspace

func (c *Client) CreateWorkspace(ctx context.Context, organizationID uuid.UUID, user string, request CreateWorkspaceRequest) (Workspace, error)

CreateWorkspace creates a new workspace for the template specified.

func (*Client) CreateWorkspaceBuild

func (c *Client) CreateWorkspaceBuild(ctx context.Context, workspace uuid.UUID, request CreateWorkspaceBuildRequest) (WorkspaceBuild, error)

CreateWorkspaceBuild queues a new build to occur for a workspace.

func (*Client) CreateWorkspaceProxy added in v0.22.0

func (*Client) DeleteAPIKey added in v0.9.7

func (c *Client) DeleteAPIKey(ctx context.Context, userID string, id string) error

DeleteAPIKey deletes API key by id.

func (*Client) DeleteGroup added in v0.9.9

func (c *Client) DeleteGroup(ctx context.Context, group uuid.UUID) error

func (*Client) DeleteLicense added in v0.8.7

func (c *Client) DeleteLicense(ctx context.Context, id int32) error

func (*Client) DeleteTemplate added in v0.4.0

func (c *Client) DeleteTemplate(ctx context.Context, template uuid.UUID) error

func (*Client) DeleteUser added in v0.8.15

func (c *Client) DeleteUser(ctx context.Context, id uuid.UUID) error

DeleteUser deletes a user.

func (*Client) DeleteWorkspaceProxyByID added in v0.23.0

func (c *Client) DeleteWorkspaceProxyByID(ctx context.Context, id uuid.UUID) error

func (*Client) DeleteWorkspaceProxyByName added in v0.23.0

func (c *Client) DeleteWorkspaceProxyByName(ctx context.Context, name string) error

func (*Client) DeletedWorkspace added in v0.6.0

func (c *Client) DeletedWorkspace(ctx context.Context, id uuid.UUID) (Workspace, error)

DeletedWorkspace returns a single workspace that was deleted.

func (*Client) DeploymentConfig added in v0.11.0

func (c *Client) DeploymentConfig(ctx context.Context) (*DeploymentConfig, error)

DeploymentConfig returns the deployment config for the coder server.

func (*Client) DeploymentDAUs added in v0.15.3

func (c *Client) DeploymentDAUs(ctx context.Context, tzOffset int) (*DAUsResponse, error)

DeploymentDAUs requires a tzOffset in hours. Use 0 for UTC, and TimezoneOffsetHour(time.Local) for the local timezone.

func (*Client) DeploymentDAUsLocalTZ added in v0.24.0

func (c *Client) DeploymentDAUsLocalTZ(ctx context.Context) (*DAUsResponse, error)

func (*Client) DeploymentStats added in v0.19.0

func (c *Client) DeploymentStats(ctx context.Context) (DeploymentStats, error)

func (*Client) DialWorkspaceAgent

func (c *Client) DialWorkspaceAgent(ctx context.Context, agentID uuid.UUID, options *DialWorkspaceAgentOptions) (agentConn *WorkspaceAgentConn, err error)

func (*Client) Download

func (c *Client) Download(ctx context.Context, id uuid.UUID) ([]byte, string, error)

Download fetches a file by uploaded hash.

func (*Client) Entitlements added in v0.8.6

func (c *Client) Entitlements(ctx context.Context) (Entitlements, error)

func (*Client) Experiments added in v0.15.0

func (c *Client) Experiments(ctx context.Context) (Experiments, error)

func (*Client) GetTokenConfig added in v0.20.0

func (c *Client) GetTokenConfig(ctx context.Context, userID string) (TokenConfig, error)

GetTokenConfig returns deployment options related to token management

func (*Client) GitAuthByID added in v0.25.0

func (c *Client) GitAuthByID(ctx context.Context, provider string) (GitAuth, error)

GitAuthByID returns the git auth for the given provider by ID.

func (*Client) GitAuthDeviceByID added in v0.25.0

func (c *Client) GitAuthDeviceByID(ctx context.Context, provider string) (GitAuthDevice, error)

func (*Client) GitAuthDeviceExchange added in v0.25.0

func (c *Client) GitAuthDeviceExchange(ctx context.Context, provider string, req GitAuthDeviceExchange) error

ExchangeGitAuth exchanges a device code for a git auth token.

func (*Client) GitSSHKey added in v0.4.0

func (c *Client) GitSSHKey(ctx context.Context, user string) (GitSSHKey, error)

GitSSHKey returns the user's git SSH public key.

func (*Client) Group added in v0.9.9

func (c *Client) Group(ctx context.Context, group uuid.UUID) (Group, error)

func (*Client) GroupByOrgAndName added in v0.12.0

func (c *Client) GroupByOrgAndName(ctx context.Context, orgID uuid.UUID, name string) (Group, error)

func (*Client) GroupsByOrganization added in v0.9.9

func (c *Client) GroupsByOrganization(ctx context.Context, orgID uuid.UUID) ([]Group, error)

func (*Client) HasFirstUser

func (c *Client) HasFirstUser(ctx context.Context) (bool, error)

HasFirstUser returns whether the first user has been created.

func (*Client) IssueReconnectingPTYSignedToken added in v0.23.0

func (*Client) Licenses added in v0.8.7

func (c *Client) Licenses(ctx context.Context) ([]License, error)

func (*Client) ListOrganizationRoles added in v0.5.4

func (c *Client) ListOrganizationRoles(ctx context.Context, org uuid.UUID) ([]AssignableRoles, error)

ListOrganizationRoles lists all assignable roles for a given organization.

func (*Client) ListSiteRoles added in v0.5.4

func (c *Client) ListSiteRoles(ctx context.Context) ([]AssignableRoles, error)

ListSiteRoles lists all assignable site wide roles.

func (*Client) LogBodies added in v0.12.6

func (c *Client) LogBodies() bool

LogBodies returns whether requests and response bodies are logged.

func (*Client) Logger added in v0.12.6

func (c *Client) Logger() slog.Logger

Logger returns the logger for the client.

func (*Client) LoginWithPassword

LoginWithPassword creates a session token authenticating with an email and password. Call `SetSessionToken()` to apply the newly acquired token to the client.

func (*Client) Logout

func (c *Client) Logout(ctx context.Context) error

Logout calls the /logout API Call `ClearSessionToken()` to clear the session token of the client.

func (*Client) Organization

func (c *Client) Organization(ctx context.Context, id uuid.UUID) (Organization, error)

func (*Client) OrganizationByName

func (c *Client) OrganizationByName(ctx context.Context, user string, name string) (Organization, error)

func (*Client) OrganizationsByUser

func (c *Client) OrganizationsByUser(ctx context.Context, user string) ([]Organization, error)

OrganizationsByUser returns all organizations the user is a member of.

func (*Client) PatchGroup added in v0.9.9

func (c *Client) PatchGroup(ctx context.Context, group uuid.UUID, req PatchGroupRequest) (Group, error)

func (*Client) PatchWorkspaceProxy added in v0.23.3

func (c *Client) PatchWorkspaceProxy(ctx context.Context, req PatchWorkspaceProxy) (UpdateWorkspaceProxyResponse, error)

func (*Client) PreviousTemplateVersion added in v0.13.2

func (c *Client) PreviousTemplateVersion(ctx context.Context, organization uuid.UUID, templateName, versionName string) (TemplateVersion, error)

func (*Client) ProvisionerDaemons added in v0.6.1

func (c *Client) ProvisionerDaemons(ctx context.Context) ([]ProvisionerDaemon, error)

ProvisionerDaemonsByOrganization returns provisioner daemons available for an organization.

func (*Client) PutExtendWorkspace added in v0.6.1

func (c *Client) PutExtendWorkspace(ctx context.Context, id uuid.UUID, req PutExtendWorkspaceRequest) error

PutExtendWorkspace updates the deadline for resources of the latest workspace build.

func (*Client) RegenerateGitSSHKey added in v0.4.0

func (c *Client) RegenerateGitSSHKey(ctx context.Context, user string) (GitSSHKey, error)

RegenerateGitSSHKey will create a new SSH key pair for the user and return it.

func (*Client) Regions added in v0.23.1

func (c *Client) Regions(ctx context.Context) ([]Region, error)

func (*Client) Replicas added in v0.10.0

func (c *Client) Replicas(ctx context.Context) ([]Replica, error)

Replicas fetches the list of replicas.

func (*Client) Request added in v0.5.10

func (c *Client) Request(ctx context.Context, method, path string, body interface{}, opts ...RequestOption) (*http.Response, error)

Request performs a HTTP request with the body provided. The caller is responsible for closing the response body.

func (*Client) SSHConfiguration added in v0.20.0

func (c *Client) SSHConfiguration(ctx context.Context) (SSHConfigResponse, error)

SSHConfiguration returns information about the SSH configuration for the Coder instance.

func (*Client) ServeProvisionerDaemon added in v0.12.8

func (c *Client) ServeProvisionerDaemon(ctx context.Context, organization uuid.UUID, provisioners []ProvisionerType, tags map[string]string) (proto.DRPCProvisionerDaemonClient, error)

ListenProvisionerDaemon returns the gRPC service for a provisioner daemon implementation. The context is during dial, not during the lifetime of the client. Client should be closed after use.

func (*Client) SessionToken

func (c *Client) SessionToken() string

SessionToken returns the currently set token for the client.

func (*Client) SetLogBodies added in v0.26.0

func (c *Client) SetLogBodies(logBodies bool)

SetLogBodies sets whether to log request and response bodies.

func (*Client) SetLogger added in v0.26.0

func (c *Client) SetLogger(logger slog.Logger)

SetLogger sets the logger for the client.

func (*Client) SetSessionToken added in v0.12.6

func (c *Client) SetSessionToken(token string)

SetSessionToken returns the currently set token for the client.

func (*Client) Template added in v0.4.0

func (c *Client) Template(ctx context.Context, template uuid.UUID) (Template, error)

Template returns a single template.

func (*Client) TemplateACL added in v0.9.9

func (c *Client) TemplateACL(ctx context.Context, templateID uuid.UUID) (TemplateACL, error)

func (*Client) TemplateByName added in v0.4.0

func (c *Client) TemplateByName(ctx context.Context, organizationID uuid.UUID, name string) (Template, error)

TemplateByName finds a template inside the organization provided with a case-insensitive name.

func (*Client) TemplateDAUs added in v0.8.12

func (c *Client) TemplateDAUs(ctx context.Context, templateID uuid.UUID, tzOffset int) (*DAUsResponse, error)

TemplateDAUs requires a tzOffset in hours. Use 0 for UTC, and TimezoneOffsetHour(time.Local) for the local timezone.

func (*Client) TemplateDAUsLocalTZ added in v0.24.0

func (c *Client) TemplateDAUsLocalTZ(ctx context.Context, templateID uuid.UUID) (*DAUsResponse, error)

func (*Client) TemplateExamples added in v0.13.2

func (c *Client) TemplateExamples(ctx context.Context, organizationID uuid.UUID) ([]TemplateExample, error)

TemplateExamples lists example templates embedded in coder.

func (*Client) TemplateInsights added in v0.27.1

func (*Client) TemplateVersion added in v0.4.0

func (c *Client) TemplateVersion(ctx context.Context, id uuid.UUID) (TemplateVersion, error)

TemplateVersion returns a template version by ID.

func (*Client) TemplateVersionByName added in v0.4.0

func (c *Client) TemplateVersionByName(ctx context.Context, template uuid.UUID, name string) (TemplateVersion, error)

TemplateVersionByName returns a template version by it's friendly name. This is used for path-based routing. Like: /templates/example/versions/helloworld

func (*Client) TemplateVersionByOrganizationAndName added in v0.12.8

func (c *Client) TemplateVersionByOrganizationAndName(ctx context.Context, organizationID uuid.UUID, templateName, versionName string) (TemplateVersion, error)

func (*Client) TemplateVersionDryRun added in v0.6.1

func (c *Client) TemplateVersionDryRun(ctx context.Context, version, job uuid.UUID) (ProvisionerJob, error)

TemplateVersionDryRun returns the current state of a template version dry-run job.

func (*Client) TemplateVersionDryRunLogsAfter added in v0.6.1

func (c *Client) TemplateVersionDryRunLogsAfter(ctx context.Context, version, job uuid.UUID, after int64) (<-chan ProvisionerJobLog, io.Closer, error)

TemplateVersionDryRunLogsAfter streams logs for a template version dry-run that occurred after a specific log ID.

func (*Client) TemplateVersionDryRunResources added in v0.6.1

func (c *Client) TemplateVersionDryRunResources(ctx context.Context, version, job uuid.UUID) ([]WorkspaceResource, error)

TemplateVersionDryRunResources returns the resources of a finished template version dry-run job.

func (*Client) TemplateVersionGitAuth added in v0.18.0

func (c *Client) TemplateVersionGitAuth(ctx context.Context, version uuid.UUID) ([]TemplateVersionGitAuth, error)

TemplateVersionGitAuth returns git authentication for the requested template version.

func (*Client) TemplateVersionLogsAfter added in v0.4.0

func (c *Client) TemplateVersionLogsAfter(ctx context.Context, version uuid.UUID, after int64) (<-chan ProvisionerJobLog, io.Closer, error)

TemplateVersionLogsAfter streams logs for a template version that occurred after a specific log ID.

func (*Client) TemplateVersionResources added in v0.4.0

func (c *Client) TemplateVersionResources(ctx context.Context, version uuid.UUID) ([]WorkspaceResource, error)

TemplateVersionResources returns resources a template version declares.

func (*Client) TemplateVersionRichParameters added in v0.15.0

func (c *Client) TemplateVersionRichParameters(ctx context.Context, version uuid.UUID) ([]TemplateVersionParameter, error)

TemplateVersionParameters returns parameters a template version exposes.

func (*Client) TemplateVersionVariables added in v0.17.4

func (c *Client) TemplateVersionVariables(ctx context.Context, version uuid.UUID) ([]TemplateVersionVariable, error)

TemplateVersionVariables returns resources a template version variables.

func (*Client) TemplateVersionsByTemplate added in v0.4.0

func (c *Client) TemplateVersionsByTemplate(ctx context.Context, req TemplateVersionsByTemplateRequest) ([]TemplateVersion, error)

TemplateVersionsByTemplate lists versions associated with a template.

func (*Client) TemplatesByOrganization added in v0.4.0

func (c *Client) TemplatesByOrganization(ctx context.Context, organizationID uuid.UUID) ([]Template, error)

TemplatesByOrganization lists all templates inside of an organization.

func (*Client) Tokens added in v0.16.0

func (c *Client) Tokens(ctx context.Context, userID string, filter TokensFilter) ([]APIKeyWithOwner, error)

Tokens list machine API keys.

func (*Client) UpdateActiveTemplateVersion added in v0.4.0

func (c *Client) UpdateActiveTemplateVersion(ctx context.Context, template uuid.UUID, req UpdateActiveTemplateVersion) error

UpdateActiveTemplateVersion updates the active template version to the ID provided. The template version must be attached to the template.

func (*Client) UpdateAppearance added in v0.14.0

func (c *Client) UpdateAppearance(ctx context.Context, appearance UpdateAppearanceConfig) error

func (*Client) UpdateCheck added in v0.13.0

func (c *Client) UpdateCheck(ctx context.Context) (UpdateCheckResponse, error)

UpdateCheck returns information about the latest release version of Coder and whether or not the server is running the latest release.

func (*Client) UpdateOrganizationMemberRoles added in v0.5.2

func (c *Client) UpdateOrganizationMemberRoles(ctx context.Context, organizationID uuid.UUID, user string, req UpdateRoles) (OrganizationMember, error)

UpdateOrganizationMemberRoles grants the userID the specified roles in an org. Include ALL roles the user has.

func (*Client) UpdateTemplateACL added in v0.9.9

func (c *Client) UpdateTemplateACL(ctx context.Context, templateID uuid.UUID, req UpdateTemplateACL) error

func (*Client) UpdateTemplateMeta added in v0.6.3

func (c *Client) UpdateTemplateMeta(ctx context.Context, templateID uuid.UUID, req UpdateTemplateMeta) (Template, error)

func (*Client) UpdateTemplateVersion added in v0.21.0

func (c *Client) UpdateTemplateVersion(ctx context.Context, versionID uuid.UUID, req PatchTemplateVersionRequest) (TemplateVersion, error)

func (*Client) UpdateUserPassword added in v0.5.5

func (c *Client) UpdateUserPassword(ctx context.Context, user string, req UpdateUserPasswordRequest) error

UpdateUserPassword updates a user password. It calls PUT /users/{user}/password

func (*Client) UpdateUserProfile added in v0.4.2

func (c *Client) UpdateUserProfile(ctx context.Context, user string, req UpdateUserProfileRequest) (User, error)

UpdateUserProfile enables callers to update profile information

func (*Client) UpdateUserQuietHoursSchedule added in v0.26.2

func (c *Client) UpdateUserQuietHoursSchedule(ctx context.Context, userIdent string, req UpdateUserQuietHoursScheduleRequest) (UserQuietHoursScheduleResponse, error)

UpdateUserQuietHoursSchedule updates the quiet hours settings for the user. This endpoint only exists in enterprise editions.

func (*Client) UpdateUserRoles added in v0.5.2

func (c *Client) UpdateUserRoles(ctx context.Context, user string, req UpdateRoles) (User, error)

UpdateUserRoles grants the userID the specified roles. Include ALL roles the user has.

func (*Client) UpdateUserStatus added in v0.5.8

func (c *Client) UpdateUserStatus(ctx context.Context, user string, status UserStatus) (User, error)

UpdateUserStatus sets the user status to the given status

func (*Client) UpdateWorkspace added in v0.8.7

func (c *Client) UpdateWorkspace(ctx context.Context, id uuid.UUID, req UpdateWorkspaceRequest) error

func (*Client) UpdateWorkspaceAutostart added in v0.4.1

func (c *Client) UpdateWorkspaceAutostart(ctx context.Context, id uuid.UUID, req UpdateWorkspaceAutostartRequest) error

UpdateWorkspaceAutostart sets the autostart schedule for workspace by id. If the provided schedule is empty, autostart is disabled for the workspace.

func (*Client) UpdateWorkspaceLock added in v0.25.0

func (c *Client) UpdateWorkspaceLock(ctx context.Context, id uuid.UUID, req UpdateWorkspaceLock) error

UpdateWorkspaceLock locks or unlocks a workspace.

func (*Client) UpdateWorkspaceTTL added in v0.6.0

func (c *Client) UpdateWorkspaceTTL(ctx context.Context, id uuid.UUID, req UpdateWorkspaceTTLRequest) error

UpdateWorkspaceTTL sets the ttl for workspace by id. If the provided duration is nil, autostop is disabled for the workspace.

func (*Client) Upload

func (c *Client) Upload(ctx context.Context, contentType string, rd io.Reader) (UploadResponse, error)

Upload uploads an arbitrary file with the content type provided. This is used to upload a source-code archive.

func (*Client) User

func (c *Client) User(ctx context.Context, userIdent string) (User, error)

User returns a user for the ID/username provided.

func (*Client) UserLatencyInsights added in v0.27.1

func (*Client) UserQuietHoursSchedule added in v0.26.2

func (c *Client) UserQuietHoursSchedule(ctx context.Context, userIdent string) (UserQuietHoursScheduleResponse, error)

UserQuietHoursSchedule returns the quiet hours settings for the user. This endpoint only exists in enterprise editions.

func (*Client) UserRoles added in v0.16.0

func (c *Client) UserRoles(ctx context.Context, user string) (UserRoles, error)

UserRoles returns all roles the user has

func (*Client) Users added in v0.4.4

func (c *Client) Users(ctx context.Context, req UsersRequest) (GetUsersResponse, error)

Users returns all users according to the request parameters. If no parameters are set, the default behavior is to return all users in a single page.

func (*Client) WatchWorkspace added in v0.6.0

func (c *Client) WatchWorkspace(ctx context.Context, id uuid.UUID) (<-chan Workspace, error)

func (*Client) WatchWorkspaceAgentMetadata added in v0.21.3

func (c *Client) WatchWorkspaceAgentMetadata(ctx context.Context, id uuid.UUID) (<-chan []WorkspaceAgentMetadata, <-chan error)

WatchWorkspaceAgentMetadata watches the metadata of a workspace agent. The returned channel will be closed when the context is canceled. Exactly one error will be sent on the error channel. The metadata channel is never closed.

func (*Client) Workspace

func (c *Client) Workspace(ctx context.Context, id uuid.UUID) (Workspace, error)

Workspace returns a single workspace.

func (*Client) WorkspaceAgent added in v0.4.1

func (c *Client) WorkspaceAgent(ctx context.Context, id uuid.UUID) (WorkspaceAgent, error)

WorkspaceAgent returns an agent by ID.

func (*Client) WorkspaceAgentConnectionInfo added in v0.25.0

func (c *Client) WorkspaceAgentConnectionInfo(ctx context.Context) (*WorkspaceAgentConnectionInfo, error)

func (*Client) WorkspaceAgentListeningPorts added in v0.9.5

func (c *Client) WorkspaceAgentListeningPorts(ctx context.Context, agentID uuid.UUID) (WorkspaceAgentListeningPortsResponse, error)

WorkspaceAgentListeningPorts returns a list of ports that are currently being listened on inside the workspace agent's network namespace.

func (*Client) WorkspaceAgentReconnectingPTY added in v0.5.2

func (c *Client) WorkspaceAgentReconnectingPTY(ctx context.Context, opts WorkspaceAgentReconnectingPTYOpts) (net.Conn, error)

WorkspaceAgentReconnectingPTY spawns a PTY that reconnects using the token provided. It communicates using `agent.ReconnectingPTYRequest` marshaled as JSON. Responses are PTY output that can be rendered.

func (*Client) WorkspaceAgentStartupLogsAfter added in v0.21.0

func (c *Client) WorkspaceAgentStartupLogsAfter(ctx context.Context, agentID uuid.UUID, after int64, follow bool) (<-chan []WorkspaceAgentStartupLog, io.Closer, error)

func (*Client) WorkspaceBuild

func (c *Client) WorkspaceBuild(ctx context.Context, id uuid.UUID) (WorkspaceBuild, error)

WorkspaceBuild returns a single workspace build for a workspace. If history is "", the latest version is returned.

func (*Client) WorkspaceBuildByUsernameAndWorkspaceNameAndBuildNumber added in v0.6.6

func (c *Client) WorkspaceBuildByUsernameAndWorkspaceNameAndBuildNumber(ctx context.Context, username string, workspaceName string, buildNumber string) (WorkspaceBuild, error)

func (*Client) WorkspaceBuildLogsAfter

func (c *Client) WorkspaceBuildLogsAfter(ctx context.Context, build uuid.UUID, after int64) (<-chan ProvisionerJobLog, io.Closer, error)

WorkspaceBuildLogsAfter streams logs for a workspace build that occurred after a specific log ID.

func (*Client) WorkspaceBuildParameters added in v0.15.0

func (c *Client) WorkspaceBuildParameters(ctx context.Context, build uuid.UUID) ([]WorkspaceBuildParameter, error)

func (*Client) WorkspaceBuildState added in v0.5.3

func (c *Client) WorkspaceBuildState(ctx context.Context, build uuid.UUID) ([]byte, error)

WorkspaceBuildState returns the provisioner state of the build.

func (*Client) WorkspaceBuilds

func (c *Client) WorkspaceBuilds(ctx context.Context, req WorkspaceBuildsRequest) ([]WorkspaceBuild, error)

func (*Client) WorkspaceByOwnerAndName added in v0.5.0

func (c *Client) WorkspaceByOwnerAndName(ctx context.Context, owner string, name string, params WorkspaceOptions) (Workspace, error)

WorkspaceByOwnerAndName returns a workspace by the owner's UUID and the workspace's name.

func (*Client) WorkspaceProxies added in v0.23.0

func (c *Client) WorkspaceProxies(ctx context.Context) (RegionsResponse[WorkspaceProxy], error)

func (*Client) WorkspaceProxyByID added in v0.23.3

func (c *Client) WorkspaceProxyByID(ctx context.Context, id uuid.UUID) (WorkspaceProxy, error)

func (*Client) WorkspaceProxyByName added in v0.23.3

func (c *Client) WorkspaceProxyByName(ctx context.Context, name string) (WorkspaceProxy, error)

func (*Client) WorkspaceQuota added in v0.9.2

func (c *Client) WorkspaceQuota(ctx context.Context, userID string) (WorkspaceQuota, error)

func (*Client) Workspaces added in v0.6.0

func (c *Client) Workspaces(ctx context.Context, filter WorkspaceFilter) (WorkspacesResponse, error)

Workspaces returns all workspaces the authenticated user has access to.

type ConnectionLatency added in v0.27.1

type ConnectionLatency struct {
	P50 float64 `json:"p50" example:"31.312"`
	P95 float64 `json:"p95" example:"119.832"`

ConnectionLatency shows the latency for a connection.

type ConvertLoginRequest added in v0.25.0

type ConvertLoginRequest struct {
	// ToType is the login type to convert to.
	ToType   LoginType `json:"to_type" validate:"required"`
	Password string    `json:"password" validate:"required"`

type CreateFirstUserRequest

type CreateFirstUserRequest struct {
	Email    string `json:"email" validate:"required,email"`
	Username string `json:"username" validate:"required,username"`
	Password string `json:"password" validate:"required"`
	Trial    bool   `json:"trial"`

type CreateFirstUserResponse

type CreateFirstUserResponse struct {
	UserID         uuid.UUID `json:"user_id" format:"uuid"`
	OrganizationID uuid.UUID `json:"organization_id" format:"uuid"`

CreateFirstUserResponse contains IDs for newly created user info.

type CreateGroupRequest added in v0.9.9

type CreateGroupRequest struct {
	Name           string `json:"name"`
	AvatarURL      string `json:"avatar_url"`
	QuotaAllowance int    `json:"quota_allowance"`

type CreateOrganizationRequest

type CreateOrganizationRequest struct {
	Name string `json:"name" validate:"required,username"`

type CreateTemplateRequest added in v0.4.0

type CreateTemplateRequest struct {
	// Name is the name of the template.
	Name string `json:"name" validate:"template_name,required"`
	// DisplayName is the displayed name of the template.
	DisplayName string `json:"display_name,omitempty" validate:"template_display_name"`
	// Description is a description of what the template contains. It must be
	// less than 128 bytes.
	Description string `json:"description,omitempty" validate:"lt=128"`
	// Icon is a relative path or external URL that specifies
	// an icon to be displayed in the dashboard.
	Icon string `json:"icon,omitempty"`

	// VersionID is an in-progress or completed job to use as an initial version
	// of the template.
	// This is required on creation to enable a user-flow of validating a
	// template works. There is no reason the data-model cannot support empty
	// templates, but it doesn't make sense for users.
	VersionID uuid.UUID `json:"template_version_id" validate:"required" format:"uuid"`

	// DefaultTTLMillis allows optionally specifying the default TTL
	// for all workspaces created from this template.
	DefaultTTLMillis *int64 `json:"default_ttl_ms,omitempty"`
	// TODO(@dean): remove max_ttl once restart_requirement is matured
	MaxTTLMillis *int64 `json:"max_ttl_ms,omitempty"`
	// RestartRequirement allows optionally specifying the restart requirement
	// for workspaces created from this template. This is an enterprise feature.
	RestartRequirement *TemplateRestartRequirement `json:"restart_requirement,omitempty"`

	// Allow users to cancel in-progress workspace jobs.
	// *bool as the default value is "true".
	AllowUserCancelWorkspaceJobs *bool `json:"allow_user_cancel_workspace_jobs"`

	// AllowUserAutostart allows users to set a schedule for autostarting their
	// workspace. By default this is true. This can only be disabled when using
	// an enterprise license.
	AllowUserAutostart *bool `json:"allow_user_autostart"`

	// AllowUserAutostop allows users to set a custom workspace TTL to use in
	// place of the template's DefaultTTL field. By default this is true. If
	// false, the DefaultTTL will always be used. This can only be disabled when
	// using an enterprise license.
	AllowUserAutostop *bool `json:"allow_user_autostop"`

	// FailureTTLMillis allows optionally specifying the max lifetime before Coder
	// stops all resources for failed workspaces created from this template.
	FailureTTLMillis *int64 `json:"failure_ttl_ms,omitempty"`
	// InactivityTTLMillis allows optionally specifying the max lifetime before Coder
	// locks inactive workspaces created from this template.
	InactivityTTLMillis *int64 `json:"inactivity_ttl_ms,omitempty"`
	// LockedTTLMillis allows optionally specifying the max lifetime before Coder
	// permanently deletes locked workspaces created from this template.
	LockedTTLMillis *int64 `json:"locked_ttl_ms,omitempty"`

	// DisableEveryoneGroupAccess allows optionally disabling the default
	// behavior of granting the 'everyone' group access to use the template.
	// If this is set to true, the template will not be available to all users,
	// and must be explicitly granted to users or groups in the permissions settings
	// of the template.
	DisableEveryoneGroupAccess bool `json:"disable_everyone_group_access"`

CreateTemplateRequest provides options when creating a template.

type CreateTemplateVersionDryRunRequest added in v0.6.1

type CreateTemplateVersionDryRunRequest struct {
	WorkspaceName       string                    `json:"workspace_name"`
	RichParameterValues []WorkspaceBuildParameter `json:"rich_parameter_values"`
	UserVariableValues  []VariableValue           `json:"user_variable_values,omitempty"`

CreateTemplateVersionDryRunRequest defines the request parameters for CreateTemplateVersionDryRun.

type CreateTemplateVersionRequest added in v0.4.0

type CreateTemplateVersionRequest struct {
	Name    string `json:"name,omitempty" validate:"omitempty,template_version_name"`
	Message string `json:"message,omitempty" validate:"lt=1048577"`
	// TemplateID optionally associates a version with a template.
	TemplateID      uuid.UUID                `json:"template_id,omitempty" format:"uuid"`
	StorageMethod   ProvisionerStorageMethod `json:"storage_method" validate:"oneof=file,required" enums:"file"`
	FileID          uuid.UUID                `json:"file_id,omitempty" validate:"required_without=ExampleID" format:"uuid"`
	ExampleID       string                   `json:"example_id,omitempty" validate:"required_without=FileID"`
	Provisioner     ProvisionerType          `json:"provisioner" validate:"oneof=terraform echo,required"`
	ProvisionerTags map[string]string        `json:"tags"`

	UserVariableValues []VariableValue `json:"user_variable_values,omitempty"`

CreateTemplateVersionRequest enables callers to create a new Template Version.

type CreateTestAuditLogRequest added in v0.9.0

type CreateTestAuditLogRequest struct {
	Action           AuditAction     `json:"action,omitempty" enums:"create,write,delete,start,stop"`
	ResourceType     ResourceType    `json:"resource_type,omitempty" enums:"template,template_version,user,workspace,workspace_build,git_ssh_key,auditable_group"`
	ResourceID       uuid.UUID       `json:"resource_id,omitempty" format:"uuid"`
	AdditionalFields json.RawMessage `json:"additional_fields,omitempty"`
	Time             time.Time       `json:"time,omitempty" format:"date-time"`
	BuildReason      BuildReason     `json:"build_reason,omitempty" enums:"autostart,autostop,initiator"`

type CreateTokenRequest added in v0.10.0

type CreateTokenRequest struct {
	Lifetime  time.Duration `json:"lifetime"`
	Scope     APIKeyScope   `json:"scope" enums:"all,application_connect"`
	TokenName string        `json:"token_name"`

type CreateUserRequest

type CreateUserRequest struct {
	Email    string `json:"email" validate:"required,email" format:"email"`
	Username string `json:"username" validate:"required,username"`
	Password string `json:"password" validate:"required_if=DisableLogin false"`
	// DisableLogin sets the user's login type to 'none'. This prevents the user
	// from being able to use a password or any other authentication method to login.
	DisableLogin   bool      `json:"disable_login"`
	OrganizationID uuid.UUID `json:"organization_id" validate:"" format:"uuid"`

type CreateWorkspaceBuildRequest

type CreateWorkspaceBuildRequest struct {
	TemplateVersionID uuid.UUID           `json:"template_version_id,omitempty" format:"uuid"`
	Transition        WorkspaceTransition `json:"transition" validate:"oneof=create start stop delete,required"`
	DryRun            bool                `json:"dry_run,omitempty"`
	ProvisionerState  []byte              `json:"state,omitempty"`
	// Orphan may be set for the Destroy transition.
	Orphan bool `json:"orphan,omitempty"`
	// ParameterValues are optional. It will write params to the 'workspace' scope.
	// This will overwrite any existing parameters with the same name.
	// This will not delete old params not included in this list.
	RichParameterValues []WorkspaceBuildParameter `json:"rich_parameter_values,omitempty"`

	// Log level changes the default logging verbosity of a provider ("info" if empty).
	LogLevel ProvisionerLogLevel `json:"log_level,omitempty" validate:"omitempty,oneof=debug"`

CreateWorkspaceBuildRequest provides options to update the latest workspace build.

type CreateWorkspaceProxyRequest added in v0.22.0

type CreateWorkspaceProxyRequest struct {
	Name        string `json:"name" validate:"required"`
	DisplayName string `json:"display_name"`
	Icon        string `json:"icon"`

type CreateWorkspaceRequest

type CreateWorkspaceRequest struct {
	TemplateID        uuid.UUID `json:"template_id" validate:"required" format:"uuid"`
	Name              string    `json:"name" validate:"workspace_name,required"`
	AutostartSchedule *string   `json:"autostart_schedule"`
	TTLMillis         *int64    `json:"ttl_ms,omitempty"`
	// ParameterValues allows for additional parameters to be provided
	// during the initial provision.
	RichParameterValues []WorkspaceBuildParameter `json:"rich_parameter_values,omitempty"`

CreateWorkspaceRequest provides options for creating a new workspace.

type DAUEntry added in v0.8.12

type DAUEntry struct {
	Date   time.Time `json:"date" format:"date-time"`
	Amount int       `json:"amount"`

type DAURequest added in v0.24.0

type DAURequest struct {
	TZHourOffset int

type DAUsResponse added in v0.24.0

type DAUsResponse struct {
	Entries      []DAUEntry `json:"entries"`
	TZHourOffset int        `json:"tz_hour_offset"`

type DERP added in v0.11.0

type DERP struct {
	Server DERPServerConfig `json:"server" typescript:",notnull"`
	Config DERPConfig       `json:"config" typescript:",notnull"`

type DERPConfig added in v0.11.0

type DERPConfig struct {
	BlockDirect clibase.Bool   `json:"block_direct" typescript:",notnull"`
	URL         clibase.String `json:"url" typescript:",notnull"`
	Path        clibase.String `json:"path" typescript:",notnull"`

type DERPRegion added in v0.8.11

type DERPRegion struct {
	Preferred           bool    `json:"preferred"`
	LatencyMilliseconds float64 `json:"latency_ms"`

type DERPServerConfig added in v0.11.0

type DERPServerConfig struct {
	Enable        clibase.Bool        `json:"enable" typescript:",notnull"`
	RegionID      clibase.Int64       `json:"region_id" typescript:",notnull"`
	RegionCode    clibase.String      `json:"region_code" typescript:",notnull"`
	RegionName    clibase.String      `json:"region_name" typescript:",notnull"`
	STUNAddresses clibase.StringArray `json:"stun_addresses" typescript:",notnull"`
	RelayURL      clibase.URL         `json:"relay_url" typescript:",notnull"`

type DangerousConfig added in v0.15.0

type DangerousConfig struct {
	AllowPathAppSharing         clibase.Bool `json:"allow_path_app_sharing" typescript:",notnull"`
	AllowPathAppSiteOwnerAccess clibase.Bool `json:"allow_path_app_site_owner_access" typescript:",notnull"`
	AllowAllCors                clibase.Bool `json:"allow_all_cors" typescript:",notnull"`

type DeploymentConfig added in v0.11.0

type DeploymentConfig struct {
	Values  *DeploymentValues `json:"config,omitempty"`
	Options clibase.OptionSet `json:"options,omitempty"`

DeploymentConfig contains both the deployment values and how they're set.

@typescript-ignore DeploymentConfig apitypings doesn't know how to generate the OptionSet... yet.

type DeploymentStats added in v0.19.0

type DeploymentStats struct {
	// AggregatedFrom is the time in which stats are aggregated from.
	// This might be back in time a specific duration or interval.
	AggregatedFrom time.Time `json:"aggregated_from" format:"date-time"`
	// CollectedAt is the time in which stats are collected at.
	CollectedAt time.Time `json:"collected_at" format:"date-time"`
	// NextUpdateAt is the time when the next batch of stats will
	// be updated.
	NextUpdateAt time.Time `json:"next_update_at" format:"date-time"`

	Workspaces   WorkspaceDeploymentStats    `json:"workspaces"`
	SessionCount SessionCountDeploymentStats `json:"session_count"`

type DeploymentValues added in v0.19.0

type DeploymentValues struct {
	Verbose             clibase.Bool `json:"verbose,omitempty"`
	AccessURL           clibase.URL  `json:"access_url,omitempty"`
	WildcardAccessURL   clibase.URL  `json:"wildcard_access_url,omitempty"`
	DocsURL             clibase.URL  `json:"docs_url,omitempty"`
	RedirectToAccessURL clibase.Bool `json:"redirect_to_access_url,omitempty"`
	// HTTPAddress is a string because it may be set to zero to disable.
	HTTPAddress                     clibase.String                  `json:"http_address,omitempty" typescript:",notnull"`
	AutobuildPollInterval           clibase.Duration                `json:"autobuild_poll_interval,omitempty"`
	JobHangDetectorInterval         clibase.Duration                `json:"job_hang_detector_interval,omitempty"`
	DERP                            DERP                            `json:"derp,omitempty" typescript:",notnull"`
	Prometheus                      PrometheusConfig                `json:"prometheus,omitempty" typescript:",notnull"`
	Pprof                           PprofConfig                     `json:"pprof,omitempty" typescript:",notnull"`
	ProxyTrustedHeaders             clibase.StringArray             `json:"proxy_trusted_headers,omitempty" typescript:",notnull"`
	ProxyTrustedOrigins             clibase.StringArray             `json:"proxy_trusted_origins,omitempty" typescript:",notnull"`
	CacheDir                        clibase.String                  `json:"cache_directory,omitempty" typescript:",notnull"`
	InMemoryDatabase                clibase.Bool                    `json:"in_memory_database,omitempty" typescript:",notnull"`
	PostgresURL                     clibase.String                  `json:"pg_connection_url,omitempty" typescript:",notnull"`
	OAuth2                          OAuth2Config                    `json:"oauth2,omitempty" typescript:",notnull"`
	OIDC                            OIDCConfig                      `json:"oidc,omitempty" typescript:",notnull"`
	Telemetry                       TelemetryConfig                 `json:"telemetry,omitempty" typescript:",notnull"`
	TLS                             TLSConfig                       `json:"tls,omitempty" typescript:",notnull"`
	Trace                           TraceConfig                     `json:"trace,omitempty" typescript:",notnull"`
	SecureAuthCookie                clibase.Bool                    `json:"secure_auth_cookie,omitempty" typescript:",notnull"`
	StrictTransportSecurity         clibase.Int64                   `json:"strict_transport_security,omitempty" typescript:",notnull"`
	StrictTransportSecurityOptions  clibase.StringArray             `json:"strict_transport_security_options,omitempty" typescript:",notnull"`
	SSHKeygenAlgorithm              clibase.String                  `json:"ssh_keygen_algorithm,omitempty" typescript:",notnull"`
	MetricsCacheRefreshInterval     clibase.Duration                `json:"metrics_cache_refresh_interval,omitempty" typescript:",notnull"`
	AgentStatRefreshInterval        clibase.Duration                `json:"agent_stat_refresh_interval,omitempty" typescript:",notnull"`
	AgentFallbackTroubleshootingURL clibase.URL                     `json:"agent_fallback_troubleshooting_url,omitempty" typescript:",notnull"`
	BrowserOnly                     clibase.Bool                    `json:"browser_only,omitempty" typescript:",notnull"`
	SCIMAPIKey                      clibase.String                  `json:"scim_api_key,omitempty" typescript:",notnull"`
	Provisioner                     ProvisionerConfig               `json:"provisioner,omitempty" typescript:",notnull"`
	RateLimit                       RateLimitConfig                 `json:"rate_limit,omitempty" typescript:",notnull"`
	Experiments                     clibase.StringArray             `json:"experiments,omitempty" typescript:",notnull"`
	UpdateCheck                     clibase.Bool                    `json:"update_check,omitempty" typescript:",notnull"`
	MaxTokenLifetime                clibase.Duration                `json:"max_token_lifetime,omitempty" typescript:",notnull"`
	Swagger                         SwaggerConfig                   `json:"swagger,omitempty" typescript:",notnull"`
	Logging                         LoggingConfig                   `json:"logging,omitempty" typescript:",notnull"`
	Dangerous                       DangerousConfig                 `json:"dangerous,omitempty" typescript:",notnull"`
	DisablePathApps                 clibase.Bool                    `json:"disable_path_apps,omitempty" typescript:",notnull"`
	SessionDuration                 clibase.Duration                `json:"max_session_expiry,omitempty" typescript:",notnull"`
	DisableSessionExpiryRefresh     clibase.Bool                    `json:"disable_session_expiry_refresh,omitempty" typescript:",notnull"`
	DisablePasswordAuth             clibase.Bool                    `json:"disable_password_auth,omitempty" typescript:",notnull"`
	Support                         SupportConfig                   `json:"support,omitempty" typescript:",notnull"`
	GitAuthProviders                clibase.Struct[[]GitAuthConfig] `json:"git_auth,omitempty" typescript:",notnull"`
	SSHConfig                       SSHConfig                       `json:"config_ssh,omitempty" typescript:",notnull"`
	WgtunnelHost                    clibase.String                  `json:"wgtunnel_host,omitempty" typescript:",notnull"`
	DisableOwnerWorkspaceExec       clibase.Bool                    `json:"disable_owner_workspace_exec,omitempty" typescript:",notnull"`
	ProxyHealthStatusInterval       clibase.Duration                `json:"proxy_health_status_interval,omitempty" typescript:",notnull"`
	EnableTerraformDebugMode        clibase.Bool                    `json:"enable_terraform_debug_mode,omitempty" typescript:",notnull"`
	UserQuietHoursSchedule          UserQuietHoursScheduleConfig    `json:"user_quiet_hours_schedule,omitempty" typescript:",notnull"`

	Config      clibase.YAMLConfigPath `json:"config,omitempty" typescript:",notnull"`
	WriteConfig clibase.Bool           `json:"write_config,omitempty" typescript:",notnull"`

	// DEPRECATED: Use HTTPAddress or TLS.Address instead.
	Address clibase.HostPort `json:"address,omitempty" typescript:",notnull"`

DeploymentValues is the central configuration values the coder server.

func (*DeploymentValues) Options added in v0.19.0

func (c *DeploymentValues) Options() clibase.OptionSet

func (*DeploymentValues) WithoutSecrets added in v0.19.0

func (c *DeploymentValues) WithoutSecrets() (*DeploymentValues, error)

WithoutSecrets returns a copy of the config without secret values.

type DialWorkspaceAgentOptions added in v0.10.0

type DialWorkspaceAgentOptions struct {
	Logger slog.Logger
	// BlockEndpoints forced a direct connection through DERP. The Client may
	// have DisableDirect set which will override this value.
	BlockEndpoints bool

@typescript-ignore DialWorkspaceAgentOptions

type Entitlement added in v0.8.6

type Entitlement string

Entitlement represents whether a feature is licensed.

const (
	EntitlementEntitled    Entitlement = "entitled"
	EntitlementGracePeriod Entitlement = "grace_period"
	EntitlementNotEntitled Entitlement = "not_entitled"

type Entitlements added in v0.8.6

type Entitlements struct {
	Features         map[FeatureName]Feature `json:"features"`
	Warnings         []string                `json:"warnings"`
	Errors           []string                `json:"errors"`
	HasLicense       bool                    `json:"has_license"`
	Trial            bool                    `json:"trial"`
	RequireTelemetry bool                    `json:"require_telemetry"`

type Error

type Error struct {

	Helper string
	// contains filtered or unexported fields

Error represents an unaccepted or invalid request to the API. @typescript-ignore Error

func AsError added in v0.9.9

func AsError(err error) (*Error, bool)

func (*Error) Error

func (e *Error) Error() string

func (*Error) Friendly added in v0.8.0

func (e *Error) Friendly() string

func (*Error) StatusCode

func (e *Error) StatusCode() int

type Experiment added in v0.15.0

type Experiment string
const (
	// ExperimentMoons enabled the workspace proxy endpoints and CRUD. This
	// feature is not yet complete in functionality.
	ExperimentMoons Experiment = "moons"

	ExperimentWorkspaceActions Experiment = "workspace_actions"

	// ExperimentTailnetHACoordinator downgrades to the haCoordinator instead
	// of PGCoord.  Should only be used if we see issues in prod with PGCoord
	// which is now the default.
	ExperimentTailnetHACoordinator Experiment = "tailnet_ha_coordinator"

	// ExperimentConvertToOIDC enables users to convert from password to
	// oidc.
	ExperimentConvertToOIDC Experiment = "convert-to-oidc"

	// ExperimentSingleTailnet replaces workspace connections inside coderd to
	// all use a single tailnet, instead of the previous behavior of creating a
	// single tailnet for each agent.
	// WARNING: This cannot be enabled when using HA.
	ExperimentSingleTailnet Experiment = "single_tailnet"

	// ExperimentTemplateRestartRequirement allows template admins to have more
	// control over when workspaces created on a template are required to
	// restart, and allows users to ensure these restarts never happen during
	// their business hours.
	// Enables:
	// - User quiet hours schedule settings
	// - Template restart requirement settings
	// - Changes the max_deadline algorithm to use restart requirement and user
	//   quiet hours instead of max_ttl.
	ExperimentTemplateRestartRequirement Experiment = "template_restart_requirement"

type Experiments added in v0.15.0

type Experiments []Experiment

Experiments is a list of experiments that are enabled for the deployment. Multiple experiments may be enabled at the same time. Experiments are not safe for production use, and are not guaranteed to be backwards compatible. They may be removed or renamed at any time.

func (Experiments) Enabled added in v0.15.0

func (e Experiments) Enabled(ex Experiment) bool

type Feature added in v0.8.6

type Feature struct {
	Entitlement Entitlement `json:"entitlement"`
	Enabled     bool        `json:"enabled"`
	Limit       *int64      `json:"limit,omitempty"`
	Actual      *int64      `json:"actual,omitempty"`

type FeatureName added in v0.15.0

type FeatureName string

FeatureName represents the internal name of a feature. To add a new feature, add it to this set of enums as well as the FeatureNames array below.

const (
	FeatureUserLimit                  FeatureName = "user_limit"
	FeatureAuditLog                   FeatureName = "audit_log"
	FeatureBrowserOnly                FeatureName = "browser_only"
	FeatureSCIM                       FeatureName = "scim"
	FeatureTemplateRBAC               FeatureName = "template_rbac"
	FeatureHighAvailability           FeatureName = "high_availability"
	FeatureMultipleGitAuth            FeatureName = "multiple_git_auth"
	FeatureExternalProvisionerDaemons FeatureName = "external_provisioner_daemons"
	FeatureAppearance                 FeatureName = "appearance"
	FeatureAdvancedTemplateScheduling FeatureName = "advanced_template_scheduling"
	FeatureTemplateRestartRequirement FeatureName = "template_restart_requirement"
	FeatureWorkspaceProxy             FeatureName = "workspace_proxy"

func (FeatureName) AlwaysEnable added in v0.15.0

func (n FeatureName) AlwaysEnable() bool

AlwaysEnable returns if the feature is always enabled if entitled. Warning: We don't know if we need this functionality. This method may disappear at any time.

func (FeatureName) Humanize added in v0.15.0

func (n FeatureName) Humanize() string

Humanize returns the feature name in a human-readable format.

type GenerateAPIKeyResponse

type GenerateAPIKeyResponse struct {
	Key string `json:"key"`

GenerateAPIKeyResponse contains an API key for a user.

type GetUsersResponse added in v0.12.8

type GetUsersResponse struct {
	Users []User `json:"users"`
	Count int    `json:"count"`

type GitAuth added in v0.25.0

type GitAuth struct {
	Authenticated bool   `json:"authenticated"`
	Device        bool   `json:"device"`
	Type          string `json:"type"`

	// User is the user that authenticated with the provider.
	User *GitAuthUser `json:"user"`
	// AppInstallable is true if the request for app installs was successful.
	AppInstallable bool `json:"app_installable"`
	// AppInstallations are the installations that the user has access to.
	AppInstallations []GitAuthAppInstallation `json:"installations"`
	// AppInstallURL is the URL to install the app.
	AppInstallURL string `json:"app_install_url"`

type GitAuthAppInstallation added in v0.25.0

type GitAuthAppInstallation struct {
	ID           int         `json:"id"`
	Account      GitAuthUser `json:"account"`
	ConfigureURL string      `json:"configure_url"`

type GitAuthConfig added in v0.11.0

type GitAuthConfig struct {
	ID                  string   `json:"id"`
	Type                string   `json:"type"`
	ClientID            string   `json:"client_id"`
	ClientSecret        string   `json:"-" yaml:"client_secret"`
	AuthURL             string   `json:"auth_url"`
	TokenURL            string   `json:"token_url"`
	ValidateURL         string   `json:"validate_url"`
	AppInstallURL       string   `json:"app_install_url"`
	AppInstallationsURL string   `json:"app_installations_url"`
	Regex               string   `json:"regex"`
	NoRefresh           bool     `json:"no_refresh"`
	Scopes              []string `json:"scopes"`
	DeviceFlow          bool     `json:"device_flow"`
	DeviceCodeURL       string   `json:"device_code_url"`

type GitAuthDevice added in v0.25.0

type GitAuthDevice struct {
	DeviceCode      string `json:"device_code"`
	UserCode        string `json:"user_code"`
	VerificationURI string `json:"verification_uri"`
	ExpiresIn       int    `json:"expires_in"`
	Interval        int    `json:"interval"`

GitAuthDevice is the response from the device authorization endpoint. See:

type GitAuthDeviceExchange added in v0.25.0

type GitAuthDeviceExchange struct {
	DeviceCode string `json:"device_code"`

type GitAuthUser added in v0.25.0

type GitAuthUser struct {
	Login      string `json:"login"`
	AvatarURL  string `json:"avatar_url"`
	ProfileURL string `json:"profile_url"`
	Name       string `json:"name"`

type GitProvider added in v0.11.0

type GitProvider string

GitProvider is a constant that represents the type of providers that are supported within Coder.

const (
	GitProviderAzureDevops GitProvider = "azure-devops"
	GitProviderGitHub      GitProvider = "github"
	GitProviderGitLab      GitProvider = "gitlab"
	GitProviderBitBucket   GitProvider = "bitbucket"

func (GitProvider) Pretty added in v0.18.0

func (g GitProvider) Pretty() string

type GitSSHKey added in v0.4.0

type GitSSHKey struct {
	UserID    uuid.UUID `json:"user_id" format:"uuid"`
	CreatedAt time.Time `json:"created_at" format:"date-time"`
	UpdatedAt time.Time `json:"updated_at" format:"date-time"`
	PublicKey string    `json:"public_key"`

type Group added in v0.9.9

type Group struct {
	ID             uuid.UUID `json:"id" format:"uuid"`
	Name           string    `json:"name"`
	OrganizationID uuid.UUID `json:"organization_id" format:"uuid"`
	Members        []User    `json:"members"`
	AvatarURL      string    `json:"avatar_url"`
	QuotaAllowance int       `json:"quota_allowance"`

type Healthcheck added in v0.9.0

type Healthcheck struct {
	// URL specifies the endpoint to check for the app health.
	URL string `json:"url"`
	// Interval specifies the seconds between each health check.
	Interval int32 `json:"interval"`
	// Threshold specifies the number of consecutive failed health checks before returning "unhealthy".
	Threshold int32 `json:"threshold"`

type InsightsReportInterval added in v0.27.1

type InsightsReportInterval string

InsightsReportInterval is the interval of time over which to generate a smaller insights report within a time range.

const (
	InsightsReportIntervalDay InsightsReportInterval = "day"

InsightsReportInterval enums.

type IssueReconnectingPTYSignedTokenRequest added in v0.23.0

type IssueReconnectingPTYSignedTokenRequest struct {
	// URL is the URL of the reconnecting-pty endpoint you are connecting to.
	URL     string    `json:"url" validate:"required"`
	AgentID uuid.UUID `json:"agentID" format:"uuid" validate:"required"`

type IssueReconnectingPTYSignedTokenResponse added in v0.23.0

type IssueReconnectingPTYSignedTokenResponse struct {
	SignedToken string `json:"signed_token"`

type JobErrorCode added in v0.19.0

type JobErrorCode string

JobErrorCode defines the error code returned by job runner.

const (
	MissingTemplateParameter  JobErrorCode = "MISSING_TEMPLATE_PARAMETER"
	RequiredTemplateVariables JobErrorCode = "REQUIRED_TEMPLATE_VARIABLES"

type License added in v0.8.7

type License struct {
	ID         int32     `json:"id"`
	UUID       uuid.UUID `json:"uuid" format:"uuid"`
	UploadedAt time.Time `json:"uploaded_at" format:"date-time"`
	// Claims are the JWT claims asserted by the license.  Here we use
	// a generic string map to ensure that all data from the server is
	// parsed verbatim, not just the fields this version of Coder
	// understands.
	Claims map[string]interface{} `json:"claims" table:"claims"`

func (*License) AllFeaturesClaim added in v0.26.1

func (l *License) AllFeaturesClaim() bool

func (*License) ExpiresAt added in v0.26.1

func (l *License) ExpiresAt() (time.Time, error)

ExpiresAt returns the expiration time of the license. If the claim is missing or has an unexpected type, an error is returned.

func (*License) FeaturesClaims added in v0.26.1

func (l *License) FeaturesClaims() (map[FeatureName]int64, error)

FeaturesClaims provides the feature claims in license. This only returns the explicit claims. If checking for actual usage, also check `AllFeaturesClaim`.

func (*License) Trial added in v0.26.1

func (l *License) Trial() bool

type LinkConfig added in v0.18.0

type LinkConfig struct {
	Name   string `json:"name" yaml:"name"`
	Target string `json:"target" yaml:"target"`
	Icon   string `json:"icon" yaml:"icon"`

type LogLevel added in v0.6.0

type LogLevel string

type LogSource added in v0.6.0

type LogSource string

type LoggingConfig added in v0.15.0

type LoggingConfig struct {
	Human       clibase.String `json:"human" typescript:",notnull"`
	JSON        clibase.String `json:"json" typescript:",notnull"`
	Stackdriver clibase.String `json:"stackdriver" typescript:",notnull"`

type LoginType added in v0.7.6

type LoginType string

LoginType is the type of login used to create the API key.

const (
	LoginTypePassword LoginType = "password"
	LoginTypeGithub   LoginType = "github"
	LoginTypeOIDC     LoginType = "oidc"
	LoginTypeToken    LoginType = "token"
	// LoginTypeNone is used if no login method is available for this user.
	// If this is set, the user has no method of logging in.
	// API keys can still be created by an owner and used by the user.
	// These keys would use the `LoginTypeToken` type.
	LoginTypeNone LoginType = "none"

type LoginWithPasswordRequest

type LoginWithPasswordRequest struct {
	Email    string `json:"email" validate:"required,email" format:"email"`
	Password string `json:"password" validate:"required"`

LoginWithPasswordRequest enables callers to authenticate with email and password.

type LoginWithPasswordResponse

type LoginWithPasswordResponse struct {
	SessionToken string `json:"session_token" validate:"required"`

LoginWithPasswordResponse contains a session token for the newly authenticated user.

type NullTime added in v0.8.7

type NullTime struct {

NullTime represents a nullable time.Time. @typescript-ignore NullTime

func NewNullTime added in v0.8.7

func NewNullTime(t time.Time, valid bool) NullTime

NewNullTime returns a new NullTime with the given time.Time.

func (NullTime) IsZero added in v0.8.7

func (t NullTime) IsZero() bool

IsZero return true if the time is null or zero.

func (NullTime) MarshalJSON added in v0.8.7

func (t NullTime) MarshalJSON() ([]byte, error)

MarshalJSON implements json.Marshaler.

func (*NullTime) UnmarshalJSON added in v0.8.7

func (t *NullTime) UnmarshalJSON(data []byte) error

UnmarshalJSON implements json.Unmarshaler.

type OAuth2Config added in v0.11.0

type OAuth2Config struct {
	Github OAuth2GithubConfig `json:"github" typescript:",notnull"`

type OAuth2GithubConfig added in v0.11.0

type OAuth2GithubConfig struct {
	ClientID          clibase.String      `json:"client_id" typescript:",notnull"`
	ClientSecret      clibase.String      `json:"client_secret" typescript:",notnull"`
	AllowedOrgs       clibase.StringArray `json:"allowed_orgs" typescript:",notnull"`
	AllowedTeams      clibase.StringArray `json:"allowed_teams" typescript:",notnull"`
	AllowSignups      clibase.Bool        `json:"allow_signups" typescript:",notnull"`
	AllowEveryone     clibase.Bool        `json:"allow_everyone" typescript:",notnull"`
	EnterpriseBaseURL clibase.String      `json:"enterprise_base_url" typescript:",notnull"`

type OAuthConversionResponse added in v0.25.0

type OAuthConversionResponse struct {
	StateString string    `json:"state_string"`
	ExpiresAt   time.Time `json:"expires_at" format:"date-time"`
	ToType      LoginType `json:"to_type"`
	UserID      uuid.UUID `json:"user_id" format:"uuid"`

type OIDCAuthMethod added in v0.16.0

type OIDCAuthMethod struct {
	SignInText string `json:"signInText"`
	IconURL    string `json:"iconUrl"`

type OIDCConfig added in v0.11.0

type OIDCConfig struct {
	AllowSignups        clibase.Bool                      `json:"allow_signups" typescript:",notnull"`
	ClientID            clibase.String                    `json:"client_id" typescript:",notnull"`
	ClientSecret        clibase.String                    `json:"client_secret" typescript:",notnull"`
	EmailDomain         clibase.StringArray               `json:"email_domain" typescript:",notnull"`
	IssuerURL           clibase.String                    `json:"issuer_url" typescript:",notnull"`
	Scopes              clibase.StringArray               `json:"scopes" typescript:",notnull"`
	IgnoreEmailVerified clibase.Bool                      `json:"ignore_email_verified" typescript:",notnull"`
	UsernameField       clibase.String                    `json:"username_field" typescript:",notnull"`
	EmailField          clibase.String                    `json:"email_field" typescript:",notnull"`
	AuthURLParams       clibase.Struct[map[string]string] `json:"auth_url_params" typescript:",notnull"`
	IgnoreUserInfo      clibase.Bool                      `json:"ignore_user_info" typescript:",notnull"`
	GroupField          clibase.String                    `json:"groups_field" typescript:",notnull"`
	GroupMapping        clibase.Struct[map[string]string] `json:"group_mapping" typescript:",notnull"`
	SignInText          clibase.String                    `json:"sign_in_text" typescript:",notnull"`
	IconURL             clibase.URL                       `json:"icon_url" typescript:",notnull"`

type Organization

type Organization struct {
	ID        uuid.UUID `json:"id" validate:"required" format:"uuid"`
	Name      string    `json:"name" validate:"required"`
	CreatedAt time.Time `json:"created_at" validate:"required" format:"date-time"`
	UpdatedAt time.Time `json:"updated_at" validate:"required" format:"date-time"`

Organization is the JSON representation of a Coder organization.

type OrganizationMember added in v0.5.2

type OrganizationMember struct {
	UserID         uuid.UUID `db:"user_id" json:"user_id" format:"uuid"`
	OrganizationID uuid.UUID `db:"organization_id" json:"organization_id" format:"uuid"`
	CreatedAt      time.Time `db:"created_at" json:"created_at" format:"date-time"`
	UpdatedAt      time.Time `db:"updated_at" json:"updated_at" format:"date-time"`
	Roles          []Role    `db:"roles" json:"roles"`

type Pagination added in v0.5.6

type Pagination struct {
	// AfterID returns all or up to Limit results after the given
	// UUID. This option can be used with or as an alternative to
	// Offset for better performance. To use it as an alternative,
	// set AfterID to the last UUID returned by the previous
	// request.
	AfterID uuid.UUID `json:"after_id,omitempty" format:"uuid"`
	// Limit sets the maximum number of users to be returned
	// in a single page. If the limit is <= 0, there is no limit
	// and all users are returned.
	Limit int `json:"limit,omitempty"`
	// Offset is used to indicate which page to return. An offset of 0
	// returns the first 'limit' number of users.
	// To get the next page, use offset=<limit>*<page_number>.
	// Offset is 0 indexed, so the first record sits at offset 0.
	Offset int `json:"offset,omitempty"`

Pagination sets pagination options for the endpoints that support it.

type ParameterResolver added in v0.23.6

type ParameterResolver struct {
	Rich []WorkspaceBuildParameter

ParameterResolver should be populated with legacy workload and rich parameter values from the previous build. It then supports queries against a current TemplateVersionParameter to determine whether a new value is required, or a value correctly validates. @typescript-ignore ParameterResolver

func (*ParameterResolver) ValidateResolve added in v0.23.6

func (r *ParameterResolver) ValidateResolve(p TemplateVersionParameter, v *WorkspaceBuildParameter) (value string, err error)

ValidateResolve checks the provided value, v, against the parameter, p, and the previous build. If v is nil, it also resolves the correct value. It returns the value of the parameter, if valid, and an error if invalid.

type PatchGroupRequest added in v0.9.9

type PatchGroupRequest struct {
	AddUsers       []string `json:"add_users"`
	RemoveUsers    []string `json:"remove_users"`
	Name           string   `json:"name"`
	AvatarURL      *string  `json:"avatar_url"`
	QuotaAllowance *int     `json:"quota_allowance"`

type PatchTemplateVersionRequest added in v0.21.0

type PatchTemplateVersionRequest struct {
	Name    string  `json:"name" validate:"omitempty,template_version_name"`
	Message *string `json:"message,omitempty" validate:"omitempty,lt=1048577"`

type PatchWorkspaceProxy added in v0.23.3

type PatchWorkspaceProxy struct {
	ID              uuid.UUID `json:"id" format:"uuid" validate:"required"`
	Name            string    `json:"name" validate:"required"`
	DisplayName     string    `json:"display_name" validate:"required"`
	Icon            string    `json:"icon" validate:"required"`
	RegenerateToken bool      `json:"regenerate_token"`

type PprofConfig added in v0.11.0

type PprofConfig struct {
	Enable  clibase.Bool     `json:"enable" typescript:",notnull"`
	Address clibase.HostPort `json:"address" typescript:",notnull"`

type PrometheusConfig added in v0.11.0

type PrometheusConfig struct {
	Enable            clibase.Bool     `json:"enable" typescript:",notnull"`
	Address           clibase.HostPort `json:"address" typescript:",notnull"`
	CollectAgentStats clibase.Bool     `json:"collect_agent_stats" typescript:",notnull"`
	CollectDBMetrics  clibase.Bool     `json:"collect_db_metrics" typescript:",notnull"`

type ProvisionerConfig added in v0.12.6

type ProvisionerConfig struct {
	Daemons             clibase.Int64    `json:"daemons" typescript:",notnull"`
	DaemonsEcho         clibase.Bool     `json:"daemons_echo" typescript:",notnull"`
	DaemonPollInterval  clibase.Duration `json:"daemon_poll_interval" typescript:",notnull"`
	DaemonPollJitter    clibase.Duration `json:"daemon_poll_jitter" typescript:",notnull"`
	ForceCancelInterval clibase.Duration `json:"force_cancel_interval" typescript:",notnull"`

type ProvisionerDaemon

type ProvisionerDaemon struct {
	ID           uuid.UUID         `json:"id" format:"uuid"`
	CreatedAt    time.Time         `json:"created_at" format:"date-time"`
	UpdatedAt    sql.NullTime      `json:"updated_at" format:"date-time"`
	Name         string            `json:"name"`
	Provisioners []ProvisionerType `json:"provisioners"`
	Tags         map[string]string `json:"tags"`

type ProvisionerJob

type ProvisionerJob struct {
	ID            uuid.UUID            `json:"id" format:"uuid"`
	CreatedAt     time.Time            `json:"created_at" format:"date-time"`
	StartedAt     *time.Time           `json:"started_at,omitempty" format:"date-time"`
	CompletedAt   *time.Time           `json:"completed_at,omitempty" format:"date-time"`
	CanceledAt    *time.Time           `json:"canceled_at,omitempty" format:"date-time"`
	Error         string               `json:"error,omitempty"`
	ErrorCode     JobErrorCode         `json:"error_code,omitempty" enums:"MISSING_TEMPLATE_PARAMETER,REQUIRED_TEMPLATE_VARIABLES"`
	Status        ProvisionerJobStatus `json:"status" enums:"pending,running,succeeded,canceling,canceled,failed"`
	WorkerID      *uuid.UUID           `json:"worker_id,omitempty" format:"uuid"`
	FileID        uuid.UUID            `json:"file_id" format:"uuid"`
	Tags          map[string]string    `json:"tags"`
	QueuePosition int                  `json:"queue_position"`
	QueueSize     int                  `json:"queue_size"`

ProvisionerJob describes the job executed by the provisioning daemon.

type ProvisionerJobLog

type ProvisionerJobLog struct {
	ID        int64     `json:"id"`
	CreatedAt time.Time `json:"created_at" format:"date-time"`
	Source    LogSource `json:"log_source"`
	Level     LogLevel  `json:"log_level" enums:"trace,debug,info,warn,error"`
	Stage     string    `json:"stage"`
	Output    string    `json:"output"`

ProvisionerJobLog represents the provisioner log entry annotated with source and level.

type ProvisionerJobStatus

type ProvisionerJobStatus string

ProvisionerJobStatus represents the at-time state of a job.

const (
	ProvisionerJobPending   ProvisionerJobStatus = "pending"
	ProvisionerJobRunning   ProvisionerJobStatus = "running"
	ProvisionerJobSucceeded ProvisionerJobStatus = "succeeded"
	ProvisionerJobCanceling ProvisionerJobStatus = "canceling"
	ProvisionerJobCanceled  ProvisionerJobStatus = "canceled"
	ProvisionerJobFailed    ProvisionerJobStatus = "failed"

func (ProvisionerJobStatus) Active added in v0.4.4

func (p ProvisionerJobStatus) Active() bool

Active returns whether the job is still active or not. It returns true if canceling as well, since the job isn't in an entirely inactive state yet.

type ProvisionerLogLevel added in v0.21.3

type ProvisionerLogLevel string
const (
	ProvisionerLogLevelDebug ProvisionerLogLevel = "debug"

type ProvisionerStorageMethod added in v0.6.0

type ProvisionerStorageMethod string
const (
	ProvisionerStorageMethodFile ProvisionerStorageMethod = "file"

type ProvisionerType added in v0.6.0

type ProvisionerType string
const (
	ProvisionerTypeEcho      ProvisionerType = "echo"
	ProvisionerTypeTerraform ProvisionerType = "terraform"

type ProxyHealthReport added in v0.23.0

type ProxyHealthReport struct {
	// Errors are problems that prevent the workspace proxy from being healthy
	Errors []string `json:"errors"`
	// Warnings do not prevent the workspace proxy from being healthy, but
	// should be addressed.
	Warnings []string `json:"warnings"`

ProxyHealthReport is a report of the health of the workspace proxy. A healthy report will have no errors. Warnings are not fatal.

type ProxyHealthStatus added in v0.23.0

type ProxyHealthStatus string
const (
	// ProxyHealthy means the proxy access url is reachable and returns a healthy
	// status code.
	ProxyHealthy ProxyHealthStatus = "ok"
	// ProxyUnreachable means the proxy access url is not responding.
	ProxyUnreachable ProxyHealthStatus = "unreachable"
	// ProxyUnhealthy means the proxy access url is responding, but there is some
	// problem with the proxy. This problem may or may not be preventing functionality.
	ProxyUnhealthy ProxyHealthStatus = "unhealthy"
	// ProxyUnregistered means the proxy has not registered a url yet. This means
	// the proxy was created with the cli, but has not yet been started.
	ProxyUnregistered ProxyHealthStatus = "unregistered"

type PutExtendWorkspaceRequest added in v0.6.1

type PutExtendWorkspaceRequest struct {
	Deadline time.Time `json:"deadline" validate:"required" format:"date-time"`

PutExtendWorkspaceRequest is a request to extend the deadline of the active workspace build.

type RBACResource added in v0.22.1

type RBACResource string
const (
	ResourceWorkspace                   RBACResource = "workspace"
	ResourceWorkspaceProxy              RBACResource = "workspace_proxy"
	ResourceWorkspaceExecution          RBACResource = "workspace_execution"
	ResourceWorkspaceApplicationConnect RBACResource = "application_connect"
	ResourceAuditLog                    RBACResource = "audit_log"
	ResourceTemplate                    RBACResource = "template"
	ResourceGroup                       RBACResource = "group"
	ResourceFile                        RBACResource = "file"
	ResourceProvisionerDaemon           RBACResource = "provisioner_daemon"
	ResourceOrganization                RBACResource = "organization"
	ResourceRoleAssignment              RBACResource = "assign_role"
	ResourceOrgRoleAssignment           RBACResource = "assign_org_role"
	ResourceAPIKey                      RBACResource = "api_key"
	ResourceUser                        RBACResource = "user"
	ResourceUserData                    RBACResource = "user_data"
	ResourceOrganizationMember          RBACResource = "organization_member"
	ResourceLicense                     RBACResource = "license"
	ResourceDeploymentValues            RBACResource = "deployment_config"
	ResourceDeploymentStats             RBACResource = "deployment_stats"
	ResourceReplicas                    RBACResource = "replicas"
	ResourceDebugInfo                   RBACResource = "debug_info"
	ResourceSystem                      RBACResource = "system"

func (RBACResource) String added in v0.22.1

func (r RBACResource) String() string

type RateLimitConfig added in v0.14.0

type RateLimitConfig struct {
	DisableAll clibase.Bool  `json:"disable_all" typescript:",notnull"`
	API        clibase.Int64 `json:"api" typescript:",notnull"`

type ReconnectingPTYRequest added in v0.9.0

type ReconnectingPTYRequest struct {
	Data   string `json:"data,omitempty"`
	Height uint16 `json:"height,omitempty"`
	Width  uint16 `json:"width,omitempty"`

ReconnectingPTYRequest is sent from the client to the server to pipe data to a PTY. @typescript-ignore ReconnectingPTYRequest

type Region added in v0.23.1

type Region struct {
	ID          uuid.UUID `json:"id" format:"uuid" table:"id"`
	Name        string    `json:"name" table:"name,default_sort"`
	DisplayName string    `json:"display_name" table:"display_name"`
	IconURL     string    `json:"icon_url" table:"icon_url"`
	Healthy     bool      `json:"healthy" table:"healthy"`

	// PathAppURL is the URL to the base path for path apps. Optional
	// unless wildcard_hostname is set.
	// E.g.
	PathAppURL string `json:"path_app_url" table:"url"`

	// WildcardHostname is the wildcard hostname for subdomain apps.
	// E.g. *
	// E.g. *
	// Optional. Does not need to be on the same domain as PathAppURL.
	WildcardHostname string `json:"wildcard_hostname" table:"wildcard_hostname"`

type RegionTypes added in v0.25.0

type RegionTypes interface {
	Region | WorkspaceProxy

type RegionsResponse added in v0.23.1

type RegionsResponse[R RegionTypes] struct {
	Regions []R `json:"regions"`

type Replica added in v0.10.0

type Replica struct {
	// ID is the unique identifier for the replica.
	ID uuid.UUID `json:"id" format:"uuid"`
	// Hostname is the hostname of the replica.
	Hostname string `json:"hostname"`
	// CreatedAt is the timestamp when the replica was first seen.
	CreatedAt time.Time `json:"created_at" format:"date-time"`
	// RelayAddress is the accessible address to relay DERP connections.
	RelayAddress string `json:"relay_address"`
	// RegionID is the region of the replica.
	RegionID int32 `json:"region_id"`
	// Error is the replica error.
	Error string `json:"error"`
	// DatabaseLatency is the latency in microseconds to the database.
	DatabaseLatency int32 `json:"database_latency"`

type RequestOption added in v0.9.0

type RequestOption func(*http.Request)

RequestOption is a function that can be used to modify an http.Request.

func WithQueryParam added in v0.9.8

func WithQueryParam(key, value string) RequestOption

WithQueryParam adds a query parameter to the request.

type ResourceType added in v0.8.11

type ResourceType string
const (
	ResourceTypeTemplate        ResourceType = "template"
	ResourceTypeTemplateVersion ResourceType = "template_version"
	ResourceTypeUser            ResourceType = "user"
	ResourceTypeWorkspace       ResourceType = "workspace"
	ResourceTypeWorkspaceBuild  ResourceType = "workspace_build"
	ResourceTypeGitSSHKey       ResourceType = "git_ssh_key"
	ResourceTypeAPIKey          ResourceType = "api_key"
	ResourceTypeGroup           ResourceType = "group"
	ResourceTypeLicense         ResourceType = "license"
	ResourceTypeConvertLogin    ResourceType = "convert_login"

func (ResourceType) FriendlyString added in v0.8.15

func (r ResourceType) FriendlyString() string

type Response added in v0.7.12

type Response struct {
	// Message is an actionable message that depicts actions the request took.
	// These messages should be fully formed sentences with proper punctuation.
	// Examples:
	// - "A user has been created."
	// - "Failed to create a user."
	Message string `json:"message"`
	// Detail is a debug message that provides further insight into why the
	// action failed. This information can be technical and a regular golang
	// err.Error() text.
	// - "database: too many open connections"
	// - "stat: too many open files"
	Detail string `json:"detail,omitempty"`
	// Validations are form field-specific friendly error messages. They will be
	// shown on a form field in the UI. These can also be used to add additional
	// context if there is a set of errors in the primary 'Message'.
	Validations []ValidationError `json:"validations,omitempty"`

Response represents a generic HTTP response.

type Role added in v0.5.5

type Role struct {
	Name        string `json:"name"`
	DisplayName string `json:"display_name"`

type SSHConfig added in v0.20.0

type SSHConfig struct {
	// DeploymentName is the config-ssh Hostname prefix
	DeploymentName clibase.String
	// SSHConfigOptions are additional options to add to the ssh config file.
	// This will override defaults.
	SSHConfigOptions clibase.StringArray

SSHConfig is configuration the cli & vscode extension use for configuring ssh connections.

func (SSHConfig) ParseOptions added in v0.20.0

func (c SSHConfig) ParseOptions() (map[string]string, error)

type SSHConfigResponse added in v0.20.0

type SSHConfigResponse struct {
	HostnamePrefix   string            `json:"hostname_prefix"`
	SSHConfigOptions map[string]string `json:"ssh_config_options"`

type ServerSentEvent added in v0.9.0

type ServerSentEvent struct {
	Type ServerSentEventType `json:"type"`
	Data interface{}         `json:"data"`

type ServerSentEventType added in v0.9.0

type ServerSentEventType string
const (
	ServerSentEventTypePing  ServerSentEventType = "ping"
	ServerSentEventTypeData  ServerSentEventType = "data"
	ServerSentEventTypeError ServerSentEventType = "error"

type ServiceBannerConfig added in v0.14.0

type ServiceBannerConfig struct {
	Enabled         bool   `json:"enabled"`
	Message         string `json:"message,omitempty"`
	BackgroundColor string `json:"background_color,omitempty"`

type SessionCountDeploymentStats added in v0.19.0

type SessionCountDeploymentStats struct {
	VSCode          int64 `json:"vscode"`
	SSH             int64 `json:"ssh"`
	JetBrains       int64 `json:"jetbrains"`
	ReconnectingPTY int64 `json:"reconnecting_pty"`

type SupportConfig added in v0.18.0

type SupportConfig struct {
	Links clibase.Struct[[]LinkConfig] `json:"links" typescript:",notnull"`

type SwaggerConfig added in v0.13.5

type SwaggerConfig struct {
	Enable clibase.Bool `json:"enable" typescript:",notnull"`

type TLSConfig added in v0.11.0

type TLSConfig struct {
	Enable         clibase.Bool        `json:"enable" typescript:",notnull"`
	Address        clibase.HostPort    `json:"address" typescript:",notnull"`
	RedirectHTTP   clibase.Bool        `json:"redirect_http" typescript:",notnull"`
	CertFiles      clibase.StringArray `json:"cert_file" typescript:",notnull"`
	ClientAuth     clibase.String      `json:"client_auth" typescript:",notnull"`
	ClientCAFile   clibase.String      `json:"client_ca_file" typescript:",notnull"`
	KeyFiles       clibase.StringArray `json:"key_file" typescript:",notnull"`
	MinVersion     clibase.String      `json:"min_version" typescript:",notnull"`
	ClientCertFile clibase.String      `json:"client_cert_file" typescript:",notnull"`
	ClientKeyFile  clibase.String      `json:"client_key_file" typescript:",notnull"`

type TelemetryConfig added in v0.11.0

type TelemetryConfig struct {
	Enable clibase.Bool `json:"enable" typescript:",notnull"`
	Trace  clibase.Bool `json:"trace" typescript:",notnull"`
	URL    clibase.URL  `json:"url" typescript:",notnull"`

type Template added in v0.4.0

type Template struct {
	ID              uuid.UUID       `json:"id" format:"uuid"`
	CreatedAt       time.Time       `json:"created_at" format:"date-time"`
	UpdatedAt       time.Time       `json:"updated_at" format:"date-time"`
	OrganizationID  uuid.UUID       `json:"organization_id" format:"uuid"`
	Name            string          `json:"name"`
	DisplayName     string          `json:"display_name"`
	Provisioner     ProvisionerType `json:"provisioner" enums:"terraform"`
	ActiveVersionID uuid.UUID       `json:"active_version_id" format:"uuid"`
	// ActiveUserCount is set to -1 when loading.
	ActiveUserCount  int                    `json:"active_user_count"`
	BuildTimeStats   TemplateBuildTimeStats `json:"build_time_stats"`
	Description      string                 `json:"description"`
	Icon             string                 `json:"icon"`
	DefaultTTLMillis int64                  `json:"default_ttl_ms"`
	// TODO(@dean): remove max_ttl once restart_requirement is matured
	MaxTTLMillis int64 `json:"max_ttl_ms"`
	// RestartRequirement is an enterprise feature. Its value is only used if
	// your license is entitled to use the advanced template scheduling feature.
	RestartRequirement TemplateRestartRequirement `json:"restart_requirement"`
	CreatedByID        uuid.UUID                  `json:"created_by_id" format:"uuid"`
	CreatedByName      string                     `json:"created_by_name"`

	// AllowUserAutostart and AllowUserAutostop are enterprise-only. Their
	// values are only used if your license is entitled to use the advanced
	// template scheduling feature.
	AllowUserAutostart           bool `json:"allow_user_autostart"`
	AllowUserAutostop            bool `json:"allow_user_autostop"`
	AllowUserCancelWorkspaceJobs bool `json:"allow_user_cancel_workspace_jobs"`

	// FailureTTLMillis, InactivityTTLMillis, and LockedTTLMillis are enterprise-only. Their
	// values are used if your license is entitled to use the advanced
	// template scheduling feature.
	FailureTTLMillis    int64 `json:"failure_ttl_ms"`
	InactivityTTLMillis int64 `json:"inactivity_ttl_ms"`
	LockedTTLMillis     int64 `json:"locked_ttl_ms"`

Template is the JSON representation of a Coder template. This type matches the database object for now, but is abstracted for ease of change later on.

type TemplateACL added in v0.9.9

type TemplateACL struct {
	Users  []TemplateUser  `json:"users"`
	Groups []TemplateGroup `json:"group"`

type TemplateAppUsage added in v0.27.1

type TemplateAppUsage struct {
	TemplateIDs []uuid.UUID      `json:"template_ids" format:"uuid"`
	Type        TemplateAppsType `json:"type" example:"builtin"`
	DisplayName string           `json:"display_name" example:"Visual Studio Code"`
	Slug        string           `json:"slug" example:"vscode"`
	Icon        string           `json:"icon"`
	Seconds     int64            `json:"seconds" example:"80500"`

TemplateAppUsage shows the usage of an app for one or more templates.

type TemplateAppsType added in v0.27.1

type TemplateAppsType string

TemplateAppsType defines the type of app reported.

const (
	TemplateAppsTypeBuiltin TemplateAppsType = "builtin"

TemplateAppsType enums.

type TemplateBuildTimeStats added in v0.10.0

type TemplateBuildTimeStats map[WorkspaceTransition]TransitionStats

type TemplateExample added in v0.13.2

type TemplateExample struct {
	ID          string   `json:"id" format:"uuid"`
	URL         string   `json:"url"`
	Name        string   `json:"name"`
	Description string   `json:"description"`
	Icon        string   `json:"icon"`
	Tags        []string `json:"tags"`
	Markdown    string   `json:"markdown"`

type TemplateGroup added in v0.9.9

type TemplateGroup struct {
	Role TemplateRole `json:"role" enums:"admin,use"`

type TemplateInsightsIntervalReport added in v0.27.1

type TemplateInsightsIntervalReport struct {
	StartTime   time.Time              `json:"start_time" format:"date-time"`
	EndTime     time.Time              `json:"end_time" format:"date-time"`
	TemplateIDs []uuid.UUID            `json:"template_ids" format:"uuid"`
	Interval    InsightsReportInterval `json:"interval"`
	ActiveUsers int64                  `json:"active_users" example:"14"`

TemplateInsightsIntervalReport is the report from the template insights endpoint for a specific interval.

type TemplateInsightsReport added in v0.27.1

type TemplateInsightsReport struct {
	StartTime   time.Time          `json:"start_time" format:"date-time"`
	EndTime     time.Time          `json:"end_time" format:"date-time"`
	TemplateIDs []uuid.UUID        `json:"template_ids" format:"uuid"`
	ActiveUsers int64              `json:"active_users" example:"22"`
	AppsUsage   []TemplateAppUsage `json:"apps_usage"`

TemplateInsightsReport is the report from the template insights endpoint.

type TemplateInsightsRequest added in v0.27.1

type TemplateInsightsRequest struct {
	StartTime   time.Time              `json:"start_time" format:"date-time"`
	EndTime     time.Time              `json:"end_time" format:"date-time"`
	TemplateIDs []uuid.UUID            `json:"template_ids" format:"uuid"`
	Interval    InsightsReportInterval `json:"interval"`

type TemplateInsightsResponse added in v0.27.1

type TemplateInsightsResponse struct {
	Report          TemplateInsightsReport           `json:"report"`
	IntervalReports []TemplateInsightsIntervalReport `json:"interval_reports"`

TemplateInsightsResponse is the response from the template insights endpoint.

type TemplateRestartRequirement added in v0.26.2

type TemplateRestartRequirement struct {
	// DaysOfWeek is a list of days of the week on which restarts are required.
	// Restarts happen within the user's quiet hours (in their configured
	// timezone). If no days are specified, restarts are not required. Weekdays
	// cannot be specified twice.
	// Restarts will only happen on weekdays in this list on weeks which line up
	// with Weeks.
	DaysOfWeek []string `json:"days_of_week" enums:"monday,tuesday,wednesday,thursday,friday,saturday,sunday"`
	// Weeks is the number of weeks between required restarts. Weeks are synced
	// across all workspaces (and Coder deployments) using modulo math on a
	// hardcoded epoch week of January 2nd, 2023 (the first Monday of 2023).
	// Values of 0 or 1 indicate weekly restarts. Values of 2 indicate
	// fortnightly restarts, etc.
	Weeks int64 `json:"weeks"`

type TemplateRole added in v0.9.9

type TemplateRole string
const (
	TemplateRoleAdmin   TemplateRole = "admin"
	TemplateRoleUse     TemplateRole = "use"
	TemplateRoleDeleted TemplateRole = ""

type TemplateUser added in v0.9.9

type TemplateUser struct {
	Role TemplateRole `json:"role" enums:"admin,use"`

type TemplateVersion added in v0.4.0

type TemplateVersion struct {
	ID             uuid.UUID      `json:"id" format:"uuid"`
	TemplateID     *uuid.UUID     `json:"template_id,omitempty" format:"uuid"`
	OrganizationID uuid.UUID      `json:"organization_id,omitempty" format:"uuid"`
	CreatedAt      time.Time      `json:"created_at" format:"date-time"`
	UpdatedAt      time.Time      `json:"updated_at" format:"date-time"`
	Name           string         `json:"name"`
	Message        string         `json:"message"`
	Job            ProvisionerJob `json:"job"`
	Readme         string         `json:"readme"`
	CreatedBy      User           `json:"created_by"`

	Warnings []TemplateVersionWarning `json:"warnings,omitempty" enums:"DEPRECATED_PARAMETERS"`

TemplateVersion represents a single version of a template.

type TemplateVersionGitAuth added in v0.18.0

type TemplateVersionGitAuth struct {
	ID              string      `json:"id"`
	Type            GitProvider `json:"type"`
	AuthenticateURL string      `json:"authenticate_url"`
	Authenticated   bool        `json:"authenticated"`

type TemplateVersionParameter added in v0.4.0

type TemplateVersionParameter struct {
	Name                 string                           `json:"name"`
	DisplayName          string                           `json:"display_name,omitempty"`
	Description          string                           `json:"description"`
	DescriptionPlaintext string                           `json:"description_plaintext"`
	Type                 string                           `json:"type" enums:"string,number,bool,list(string)"`
	Mutable              bool                             `json:"mutable"`
	DefaultValue         string                           `json:"default_value"`
	Icon                 string                           `json:"icon"`
	Options              []TemplateVersionParameterOption `json:"options"`
	ValidationError      string                           `json:"validation_error,omitempty"`
	ValidationRegex      string                           `json:"validation_regex,omitempty"`
	ValidationMin        *int32                           `json:"validation_min,omitempty"`
	ValidationMax        *int32                           `json:"validation_max,omitempty"`
	ValidationMonotonic  ValidationMonotonicOrder         `json:"validation_monotonic,omitempty" enums:"increasing,decreasing"`
	Required             bool                             `json:"required"`
	Ephemeral            bool                             `json:"ephemeral"`

TemplateVersionParameter represents a parameter for a template version.

type TemplateVersionParameterOption added in v0.15.0

type TemplateVersionParameterOption struct {
	Name        string `json:"name"`
	Description string `json:"description"`
	Value       string `json:"value"`
	Icon        string `json:"icon"`

TemplateVersionParameterOption represents a selectable option for a template parameter.

type TemplateVersionVariable added in v0.17.4

type TemplateVersionVariable struct {
	Name         string `json:"name"`
	Description  string `json:"description"`
	Type         string `json:"type" enums:"string,number,bool"`
	Value        string `json:"value"`
	DefaultValue string `json:"default_value"`
	Required     bool   `json:"required"`
	Sensitive    bool   `json:"sensitive"`

TemplateVersionVariable represents a managed template variable.

type TemplateVersionWarning added in v0.23.3

type TemplateVersionWarning string
const (
	TemplateVersionWarningUnsupportedWorkspaces TemplateVersionWarning = "UNSUPPORTED_WORKSPACES"

type TemplateVersionsByTemplateRequest added in v0.5.6

type TemplateVersionsByTemplateRequest struct {
	TemplateID uuid.UUID `json:"template_id" validate:"required" format:"uuid"`

TemplateVersionsByTemplateRequest defines the request parameters for TemplateVersionsByTemplate.

type TokenConfig added in v0.20.0

type TokenConfig struct {
	MaxTokenLifetime time.Duration `json:"max_token_lifetime"`

type TokensFilter added in v0.18.0

type TokensFilter struct {
	IncludeAll bool `json:"include_all"`

type TraceConfig added in v0.12.0

type TraceConfig struct {
	Enable          clibase.Bool   `json:"enable" typescript:",notnull"`
	HoneycombAPIKey clibase.String `json:"honeycomb_api_key" typescript:",notnull"`
	CaptureLogs     clibase.Bool   `json:"capture_logs" typescript:",notnull"`

type TransitionStats added in v0.12.9

type TransitionStats struct {
	P50 *int64 `example:"123"`
	P95 *int64 `example:"146"`

type UpdateActiveTemplateVersion added in v0.4.0

type UpdateActiveTemplateVersion struct {
	ID uuid.UUID `json:"id" validate:"required" format:"uuid"`

type UpdateAppearanceConfig added in v0.18.0

type UpdateAppearanceConfig struct {
	LogoURL       string              `json:"logo_url"`
	ServiceBanner ServiceBannerConfig `json:"service_banner"`

type UpdateCheckResponse added in v0.13.0

type UpdateCheckResponse struct {
	// Current indicates whether the server version is the same as the latest.
	Current bool `json:"current"`
	// Version is the semantic version for the latest release of Coder.
	Version string `json:"version"`
	// URL to download the latest release of Coder.
	URL string `json:"url"`

UpdateCheckResponse contains information on the latest release of Coder.

type UpdateRoles added in v0.5.2

type UpdateRoles struct {
	Roles []string `json:"roles" validate:""`

type UpdateTemplateACL added in v0.9.9

type UpdateTemplateACL struct {
	// UserPerms should be a mapping of user id to role. The user id must be the
	// uuid of the user, not a username or email address.
	UserPerms map[string]TemplateRole `json:"user_perms,omitempty" example:"<group_id>:admin,4df59e74-c027-470b-ab4d-cbba8963a5e9:use"`
	// GroupPerms should be a mapping of group id to role.
	GroupPerms map[string]TemplateRole `json:"group_perms,omitempty" example:"<user_id>>:admin,8bd26b20-f3e8-48be-a903-46bb920cf671:use"`

type UpdateTemplateMeta added in v0.6.3

type UpdateTemplateMeta struct {
	Name             string `json:"name,omitempty" validate:"omitempty,template_name"`
	DisplayName      string `json:"display_name,omitempty" validate:"omitempty,template_display_name"`
	Description      string `json:"description,omitempty"`
	Icon             string `json:"icon,omitempty"`
	DefaultTTLMillis int64  `json:"default_ttl_ms,omitempty"`
	// TODO(@dean): remove max_ttl once restart_requirement is matured
	MaxTTLMillis int64 `json:"max_ttl_ms,omitempty"`
	// RestartRequirement can only be set if your license includes the advanced
	// template scheduling feature. If you attempt to set this value while
	// unlicensed, it will be ignored.
	RestartRequirement           *TemplateRestartRequirement `json:"restart_requirement,omitempty"`
	AllowUserAutostart           bool                        `json:"allow_user_autostart,omitempty"`
	AllowUserAutostop            bool                        `json:"allow_user_autostop,omitempty"`
	AllowUserCancelWorkspaceJobs bool                        `json:"allow_user_cancel_workspace_jobs,omitempty"`
	FailureTTLMillis             int64                       `json:"failure_ttl_ms,omitempty"`
	InactivityTTLMillis          int64                       `json:"inactivity_ttl_ms,omitempty"`
	LockedTTLMillis              int64                       `json:"locked_ttl_ms,omitempty"`

type UpdateUserPasswordRequest added in v0.5.5

type UpdateUserPasswordRequest struct {
	OldPassword string `json:"old_password" validate:""`
	Password    string `json:"password" validate:"required"`

type UpdateUserProfileRequest added in v0.4.2

type UpdateUserProfileRequest struct {
	Username string `json:"username" validate:"required,username"`

type UpdateUserQuietHoursScheduleRequest added in v0.26.2

type UpdateUserQuietHoursScheduleRequest struct {
	// Schedule is a cron expression that defines when the user's quiet hours
	// window is. Schedule must not be empty. For new users, the schedule is set
	// to 2am in their browser or computer's timezone. The schedule denotes the
	// beginning of a 4 hour window where the workspace is allowed to
	// automatically stop or restart due to maintenance or template max TTL.
	// The schedule must be daily with a single time, and should have a timezone
	// specified via a CRON_TZ prefix (otherwise UTC will be used).
	// If the schedule is empty, the user will be updated to use the default
	// schedule.
	Schedule string `json:"schedule" validate:"required"`

type UpdateWorkspaceAutostartRequest added in v0.4.1

type UpdateWorkspaceAutostartRequest struct {
	Schedule *string `json:"schedule"`

UpdateWorkspaceAutostartRequest is a request to update a workspace's autostart schedule.

type UpdateWorkspaceLock added in v0.25.0

type UpdateWorkspaceLock struct {
	Lock bool `json:"lock"`

UpdateWorkspaceLock is a request to lock or unlock a workspace.

type UpdateWorkspaceProxyResponse added in v0.23.3

type UpdateWorkspaceProxyResponse struct {
	Proxy WorkspaceProxy `json:"proxy" table:"proxy,recursive"`
	// The recursive table sort is not working very well.
	ProxyToken string `json:"proxy_token" table:"proxy token,default_sort"`

type UpdateWorkspaceRequest added in v0.8.7

type UpdateWorkspaceRequest struct {
	Name string `json:"name,omitempty" validate:"username"`

type UpdateWorkspaceTTLRequest added in v0.6.0

type UpdateWorkspaceTTLRequest struct {
	TTLMillis *int64 `json:"ttl_ms"`

UpdateWorkspaceTTLRequest is a request to update a workspace's TTL.

type UploadResponse

type UploadResponse struct {
	ID uuid.UUID `json:"hash" format:"uuid"`

UploadResponse contains the hash to reference the uploaded file.

type User

type User struct {
	ID         uuid.UUID `json:"id" validate:"required" table:"id" format:"uuid"`
	Username   string    `json:"username" validate:"required" table:"username,default_sort"`
	Email      string    `json:"email" validate:"required" table:"email" format:"email"`
	CreatedAt  time.Time `json:"created_at" validate:"required" table:"created at" format:"date-time"`
	LastSeenAt time.Time `json:"last_seen_at" format:"date-time"`

	Status          UserStatus  `json:"status" table:"status" enums:"active,suspended"`
	OrganizationIDs []uuid.UUID `json:"organization_ids" format:"uuid"`
	Roles           []Role      `json:"roles"`
	AvatarURL       string      `json:"avatar_url" format:"uri"`

User represents a user in Coder.

type UserLatency added in v0.27.1

type UserLatency struct {
	TemplateIDs []uuid.UUID       `json:"template_ids" format:"uuid"`
	UserID      uuid.UUID         `json:"user_id" format:"uuid"`
	Username    string            `json:"username"`
	LatencyMS   ConnectionLatency `json:"latency_ms"`

UserLatency shows the connection latency for a user.

type UserLatencyInsightsReport added in v0.27.1

type UserLatencyInsightsReport struct {
	StartTime   time.Time     `json:"start_time" format:"date-time"`
	EndTime     time.Time     `json:"end_time" format:"date-time"`
	TemplateIDs []uuid.UUID   `json:"template_ids" format:"uuid"`
	Users       []UserLatency `json:"users"`

UserLatencyInsightsReport is the report from the user latency insights endpoint.

type UserLatencyInsightsRequest added in v0.27.1

type UserLatencyInsightsRequest struct {
	StartTime   time.Time   `json:"start_time" format:"date-time"`
	EndTime     time.Time   `json:"end_time" format:"date-time"`
	TemplateIDs []uuid.UUID `json:"template_ids" format:"uuid"`

type UserLatencyInsightsResponse added in v0.27.1

type UserLatencyInsightsResponse struct {
	Report UserLatencyInsightsReport `json:"report"`

UserLatencyInsightsResponse is the response from the user latency insights endpoint.

type UserLoginType added in v0.25.0

type UserLoginType struct {
	LoginType LoginType `json:"login_type"`

type UserQuietHoursScheduleConfig added in v0.26.2

type UserQuietHoursScheduleConfig struct {
	DefaultSchedule clibase.String `json:"default_schedule" typescript:",notnull"`

type UserQuietHoursScheduleResponse added in v0.26.2

type UserQuietHoursScheduleResponse struct {
	RawSchedule string `json:"raw_schedule"`
	// UserSet is true if the user has set their own quiet hours schedule. If
	// false, the user is using the default schedule.
	UserSet bool `json:"user_set"`
	// Time is the time of day that the quiet hours window starts in the given
	// Timezone each day.
	Time     string `json:"time"`     // HH:mm (24-hour)
	Timezone string `json:"timezone"` // raw format from the cron expression, UTC if unspecified
	// Next is the next time that the quiet hours window will start.
	Next time.Time `json:"next" format:"date-time"`

type UserRoles added in v0.5.2

type UserRoles struct {
	Roles             []string               `json:"roles"`
	OrganizationRoles map[uuid.UUID][]string `json:"organization_roles"`

type UserStatus added in v0.5.1

type UserStatus string
const (
	UserStatusActive    UserStatus = "active"
	UserStatusSuspended UserStatus = "suspended"

type UsersRequest added in v0.4.4

type UsersRequest struct {
	Search string `json:"search,omitempty" typescript:"-"`
	// Filter users by status.
	Status UserStatus `json:"status,omitempty" typescript:"-"`
	// Filter users that have the given role.
	Role string `json:"role,omitempty" typescript:"-"`

	SearchQuery string `json:"q,omitempty"`

type ValidationError added in v0.7.12

type ValidationError struct {
	Field  string `json:"field" validate:"required"`
	Detail string `json:"detail" validate:"required"`

ValidationError represents a scoped error to a user input.

func (ValidationError) Error added in v0.8.2

func (e ValidationError) Error() string

type ValidationMonotonicOrder added in v0.17.0

type ValidationMonotonicOrder string
const (
	MonotonicOrderIncreasing ValidationMonotonicOrder = "increasing"
	MonotonicOrderDecreasing ValidationMonotonicOrder = "decreasing"

type VariableValue added in v0.17.4

type VariableValue struct {
	Name  string `json:"name"`
	Value string `json:"value"`

type Workspace

type Workspace struct {
	ID                                   uuid.UUID      `json:"id" format:"uuid"`
	CreatedAt                            time.Time      `json:"created_at" format:"date-time"`
	UpdatedAt                            time.Time      `json:"updated_at" format:"date-time"`
	OwnerID                              uuid.UUID      `json:"owner_id" format:"uuid"`
	OwnerName                            string         `json:"owner_name"`
	OrganizationID                       uuid.UUID      `json:"organization_id" format:"uuid"`
	TemplateID                           uuid.UUID      `json:"template_id" format:"uuid"`
	TemplateName                         string         `json:"template_name"`
	TemplateDisplayName                  string         `json:"template_display_name"`
	TemplateIcon                         string         `json:"template_icon"`
	TemplateAllowUserCancelWorkspaceJobs bool           `json:"template_allow_user_cancel_workspace_jobs"`
	LatestBuild                          WorkspaceBuild `json:"latest_build"`
	Outdated                             bool           `json:"outdated"`
	Name                                 string         `json:"name"`
	AutostartSchedule                    *string        `json:"autostart_schedule,omitempty"`
	TTLMillis                            *int64         `json:"ttl_ms,omitempty"`
	LastUsedAt                           time.Time      `json:"last_used_at" format:"date-time"`

	// DeletingAt indicates the time of the upcoming workspace deletion, if applicable; otherwise it is nil.
	// Workspaces may have impending deletions if Template.InactivityTTL feature is turned on and the workspace is inactive.
	DeletingAt *time.Time `json:"deleting_at" format:"date-time"`
	// LockedAt being non-nil indicates a workspace that has been locked.
	// A locked workspace is no longer accessible by a user and must be
	// unlocked by an admin. It is subject to deletion if it breaches
	// the duration of the locked_ttl field on its template.
	LockedAt *time.Time `json:"locked_at" format:"date-time"`
	// Health shows the health of the workspace and information about
	// what is causing an unhealthy status.
	Health WorkspaceHealth `json:"health"`

Workspace is a deployment of a template. It references a specific version and can be updated.

type WorkspaceAgent

type WorkspaceAgent struct {
	ID                          uuid.UUID                           `json:"id" format:"uuid"`
	CreatedAt                   time.Time                           `json:"created_at" format:"date-time"`
	UpdatedAt                   time.Time                           `json:"updated_at" format:"date-time"`
	FirstConnectedAt            *time.Time                          `json:"first_connected_at,omitempty" format:"date-time"`
	LastConnectedAt             *time.Time                          `json:"last_connected_at,omitempty" format:"date-time"`
	DisconnectedAt              *time.Time                          `json:"disconnected_at,omitempty" format:"date-time"`
	StartedAt                   *time.Time                          `json:"started_at,omitempty" format:"date-time"`
	ReadyAt                     *time.Time                          `json:"ready_at,omitempty" format:"date-time"`
	Status                      WorkspaceAgentStatus                `json:"status"`
	LifecycleState              WorkspaceAgentLifecycle             `json:"lifecycle_state"`
	Name                        string                              `json:"name"`
	ResourceID                  uuid.UUID                           `json:"resource_id" format:"uuid"`
	InstanceID                  string                              `json:"instance_id,omitempty"`
	Architecture                string                              `json:"architecture"`
	EnvironmentVariables        map[string]string                   `json:"environment_variables"`
	OperatingSystem             string                              `json:"operating_system"`
	StartupScript               string                              `json:"startup_script,omitempty"`
	StartupScriptBehavior       WorkspaceAgentStartupScriptBehavior `json:"startup_script_behavior"`
	StartupScriptTimeoutSeconds int32                               `json:"startup_script_timeout_seconds"` // StartupScriptTimeoutSeconds is the number of seconds to wait for the startup script to complete. If the script does not complete within this time, the agent lifecycle will be marked as start_timeout.
	StartupLogsLength           int32                               `json:"startup_logs_length"`
	StartupLogsOverflowed       bool                                `json:"startup_logs_overflowed"`
	Directory                   string                              `json:"directory,omitempty"`
	ExpandedDirectory           string                              `json:"expanded_directory,omitempty"`
	Version                     string                              `json:"version"`
	Apps                        []WorkspaceApp                      `json:"apps"`
	// DERPLatency is mapped by region name (e.g. "New York City", "Seattle").
	DERPLatency              map[string]DERPRegion `json:"latency,omitempty"`
	ConnectionTimeoutSeconds int32                 `json:"connection_timeout_seconds"`
	TroubleshootingURL       string                `json:"troubleshooting_url"`
	// Deprecated: Use StartupScriptBehavior instead.
	LoginBeforeReady             bool                 `json:"login_before_ready"`
	ShutdownScript               string               `json:"shutdown_script,omitempty"`
	ShutdownScriptTimeoutSeconds int32                `json:"shutdown_script_timeout_seconds"`
	Subsystem                    AgentSubsystem       `json:"subsystem"`
	Health                       WorkspaceAgentHealth `json:"health"` // Health reports the health of the agent.

type WorkspaceAgentConn added in v0.16.0

type WorkspaceAgentConn struct {
	// contains filtered or unexported fields

WorkspaceAgentConn represents a connection to a workspace agent. @typescript-ignore WorkspaceAgentConn

func NewWorkspaceAgentConn added in v0.26.2

func NewWorkspaceAgentConn(conn *tailnet.Conn, opts WorkspaceAgentConnOptions) *WorkspaceAgentConn

NewWorkspaceAgentConn creates a new WorkspaceAgentConn. `conn` may be unique to the WorkspaceAgentConn, or it may be shared in the case of coderd. If the conn is shared and closing it is undesirable, you may return ErrNoClose from opts.CloseFunc. This will ensure the underlying conn is not closed.

func (*WorkspaceAgentConn) AwaitReachable added in v0.16.0

func (c *WorkspaceAgentConn) AwaitReachable(ctx context.Context) bool

AwaitReachable waits for the agent to be reachable.

func (*WorkspaceAgentConn) Close added in v0.16.0

func (c *WorkspaceAgentConn) Close() error

Close ends the connection to the workspace agent.

func (*WorkspaceAgentConn) DialContext added in v0.16.0

func (c *WorkspaceAgentConn) DialContext(ctx context.Context, network string, addr string) (net.Conn, error)

DialContext dials the address provided in the workspace agent. The network must be "tcp" or "udp".

func (*WorkspaceAgentConn) ListeningPorts added in v0.16.0

ListeningPorts lists the ports that are currently in use by the workspace.

func (*WorkspaceAgentConn) Ping added in v0.16.0

Ping pings the agent and returns the round-trip time. The bool returns true if the ping was made P2P.

func (*WorkspaceAgentConn) ReconnectingPTY added in v0.16.0

func (c *WorkspaceAgentConn) ReconnectingPTY(ctx context.Context, id uuid.UUID, height, width uint16, command string) (net.Conn, error)

ReconnectingPTY spawns a new reconnecting terminal session. `ReconnectingPTYRequest` should be JSON marshaled and written to the returned net.Conn. Raw terminal output will be read from the returned net.Conn.

func (*WorkspaceAgentConn) SSH added in v0.16.0

SSH pipes the SSH protocol over the returned net.Conn. This connects to the built-in SSH server in the workspace agent.

func (*WorkspaceAgentConn) SSHClient added in v0.16.0

func (c *WorkspaceAgentConn) SSHClient(ctx context.Context) (*ssh.Client, error)

SSHClient calls SSH to create a client that uses a weak cipher to improve throughput.

func (*WorkspaceAgentConn) Speedtest added in v0.16.0

func (c *WorkspaceAgentConn) Speedtest(ctx context.Context, direction speedtest.Direction, duration time.Duration) ([]speedtest.Result, error)

Speedtest runs a speedtest against the workspace agent.

type WorkspaceAgentConnOptions added in v0.26.2

type WorkspaceAgentConnOptions struct {
	AgentID   uuid.UUID
	AgentIP   netip.Addr
	CloseFunc func() error

@typescript-ignore WorkspaceAgentConnOptions

type WorkspaceAgentConnectionInfo added in v0.8.11

type WorkspaceAgentConnectionInfo struct {
	DERPMap                  *tailcfg.DERPMap `json:"derp_map"`
	DisableDirectConnections bool             `json:"disable_direct_connections"`

WorkspaceAgentConnectionInfo returns required information for establishing a connection with a workspace. @typescript-ignore WorkspaceAgentConnectionInfo

type WorkspaceAgentHealth added in v0.26.0

type WorkspaceAgentHealth struct {
	Healthy bool   `json:"healthy" example:"false"`                              // Healthy is true if the agent is healthy.
	Reason  string `json:"reason,omitempty" example:"agent has lost connection"` // Reason is a human-readable explanation of the agent's health. It is empty if Healthy is true.

type WorkspaceAgentLifecycle added in v0.15.3

type WorkspaceAgentLifecycle string

WorkspaceAgentLifecycle represents the lifecycle state of a workspace agent.

The agent lifecycle starts in the "created" state, and transitions to "starting" when the agent reports it has begun preparing (e.g. started executing the startup script).

const (
	WorkspaceAgentLifecycleCreated         WorkspaceAgentLifecycle = "created"
	WorkspaceAgentLifecycleStarting        WorkspaceAgentLifecycle = "starting"
	WorkspaceAgentLifecycleStartTimeout    WorkspaceAgentLifecycle = "start_timeout"
	WorkspaceAgentLifecycleStartError      WorkspaceAgentLifecycle = "start_error"
	WorkspaceAgentLifecycleReady           WorkspaceAgentLifecycle = "ready"
	WorkspaceAgentLifecycleShuttingDown    WorkspaceAgentLifecycle = "shutting_down"
	WorkspaceAgentLifecycleShutdownTimeout WorkspaceAgentLifecycle = "shutdown_timeout"
	WorkspaceAgentLifecycleShutdownError   WorkspaceAgentLifecycle = "shutdown_error"
	WorkspaceAgentLifecycleOff             WorkspaceAgentLifecycle = "off"

WorkspaceAgentLifecycle enums.

func (WorkspaceAgentLifecycle) ShuttingDown added in v0.25.0

func (l WorkspaceAgentLifecycle) ShuttingDown() bool

ShuttingDown returns true if the agent is in the process of shutting down or has shut down.

func (WorkspaceAgentLifecycle) Starting added in v0.25.0

func (l WorkspaceAgentLifecycle) Starting() bool

Starting returns true if the agent is in the process of starting.

type WorkspaceAgentListeningPort added in v0.16.0

type WorkspaceAgentListeningPort struct {
	ProcessName string `json:"process_name"` // may be empty
	Network     string `json:"network"`      // only "tcp" at the moment
	Port        uint16 `json:"port"`

type WorkspaceAgentListeningPortsResponse added in v0.16.0

type WorkspaceAgentListeningPortsResponse struct {
	// If there are no ports in the list, nothing should be displayed in the UI.
	// There must not be a "no ports available" message or anything similar, as
	// there will always be no ports displayed on platforms where our port
	// detection logic is unsupported.
	Ports []WorkspaceAgentListeningPort `json:"ports"`

type WorkspaceAgentMetadata added in v0.9.0

type WorkspaceAgentMetadata struct {
	Result      WorkspaceAgentMetadataResult      `json:"result"`
	Description WorkspaceAgentMetadataDescription `json:"description"`

type WorkspaceAgentMetadataDescription added in v0.21.3

type WorkspaceAgentMetadataDescription struct {
	DisplayName string `json:"display_name"`
	Key         string `json:"key"`
	Script      string `json:"script"`
	Interval    int64  `json:"interval"`
	Timeout     int64  `json:"timeout"`

WorkspaceAgentMetadataDescription is a description of dynamic metadata the agent should report back to coderd. It is provided via the `metadata` list in the `coder_agent` block.

type WorkspaceAgentMetadataResult added in v0.21.3

type WorkspaceAgentMetadataResult struct {
	CollectedAt time.Time `json:"collected_at" format:"date-time"`
	// Age is the number of seconds since the metadata was collected.
	// It is provided in addition to CollectedAt to protect against clock skew.
	Age   int64  `json:"age"`
	Value string `json:"value"`
	Error string `json:"error"`

type WorkspaceAgentReconnectingPTYInit added in v0.16.0

type WorkspaceAgentReconnectingPTYInit struct {
	ID      uuid.UUID
	Height  uint16
	Width   uint16
	Command string

WorkspaceAgentReconnectingPTYInit initializes a new reconnecting PTY session. @typescript-ignore WorkspaceAgentReconnectingPTYInit

type WorkspaceAgentReconnectingPTYOpts added in v0.23.1

type WorkspaceAgentReconnectingPTYOpts struct {
	AgentID   uuid.UUID
	Reconnect uuid.UUID
	Width     uint16
	Height    uint16
	Command   string

	// SignedToken is an optional signed token from the
	// issue-reconnecting-pty-signed-token endpoint. If set, the session token
	// on the client will not be sent.
	SignedToken string


type WorkspaceAgentStartupLog added in v0.21.0

type WorkspaceAgentStartupLog struct {
	ID        int64     `json:"id"`
	CreatedAt time.Time `json:"created_at" format:"date-time"`
	Output    string    `json:"output"`
	Level     LogLevel  `json:"level"`

type WorkspaceAgentStartupScriptBehavior added in v0.24.0

type WorkspaceAgentStartupScriptBehavior string

WorkspaceAgentStartupScriptBehavior defines whether or not the startup script should be considered blocking or non-blocking. The blocking behavior means that the agent will not be considered ready until the startup script has completed and, for example, SSH connections will wait for the agent to be ready (can be overridden).

Presently, non-blocking is the default, but this may change in the future.

const (
	WorkspaceAgentStartupScriptBehaviorBlocking    WorkspaceAgentStartupScriptBehavior = "blocking"
	WorkspaceAgentStartupScriptBehaviorNonBlocking WorkspaceAgentStartupScriptBehavior = "non-blocking"

type WorkspaceAgentStatus

type WorkspaceAgentStatus string
const (
	WorkspaceAgentConnecting   WorkspaceAgentStatus = "connecting"
	WorkspaceAgentConnected    WorkspaceAgentStatus = "connected"
	WorkspaceAgentDisconnected WorkspaceAgentStatus = "disconnected"
	WorkspaceAgentTimeout      WorkspaceAgentStatus = "timeout"

This is also in database/modelmethods.go and should be kept in sync.

type WorkspaceApp added in v0.6.2

type WorkspaceApp struct {
	ID uuid.UUID `json:"id" format:"uuid"`
	// URL is the address being proxied to inside the workspace.
	// If external is specified, this will be opened on the client.
	URL string `json:"url"`
	// External specifies whether the URL should be opened externally on
	// the client or not.
	External bool `json:"external"`
	// Slug is a unique identifier within the agent.
	Slug string `json:"slug"`
	// DisplayName is a friendly name for the app.
	DisplayName string `json:"display_name"`
	Command     string `json:"command,omitempty"`
	// Icon is a relative path or external URL that specifies
	// an icon to be displayed in the dashboard.
	Icon string `json:"icon,omitempty"`
	// Subdomain denotes whether the app should be accessed via a path on the
	// `coder server` or via a hostname-based dev URL. If this is set to true
	// and there is no app wildcard configured on the server, the app will not
	// be accessible in the UI.
	Subdomain    bool                     `json:"subdomain"`
	SharingLevel WorkspaceAppSharingLevel `json:"sharing_level" enums:"owner,authenticated,public"`
	// Healthcheck specifies the configuration for checking app health.
	Healthcheck Healthcheck        `json:"healthcheck"`
	Health      WorkspaceAppHealth `json:"health"`

type WorkspaceAppHealth added in v0.9.0

type WorkspaceAppHealth string
const (
	WorkspaceAppHealthDisabled     WorkspaceAppHealth = "disabled"
	WorkspaceAppHealthInitializing WorkspaceAppHealth = "initializing"
	WorkspaceAppHealthHealthy      WorkspaceAppHealth = "healthy"
	WorkspaceAppHealthUnhealthy    WorkspaceAppHealth = "unhealthy"

type WorkspaceAppSharingLevel added in v0.10.0

type WorkspaceAppSharingLevel string
const (
	WorkspaceAppSharingLevelOwner         WorkspaceAppSharingLevel = "owner"
	WorkspaceAppSharingLevelAuthenticated WorkspaceAppSharingLevel = "authenticated"
	WorkspaceAppSharingLevelPublic        WorkspaceAppSharingLevel = "public"

type WorkspaceBuild

type WorkspaceBuild struct {
	ID                  uuid.UUID           `json:"id" format:"uuid"`
	CreatedAt           time.Time           `json:"created_at" format:"date-time"`
	UpdatedAt           time.Time           `json:"updated_at" format:"date-time"`
	WorkspaceID         uuid.UUID           `json:"workspace_id" format:"uuid"`
	WorkspaceName       string              `json:"workspace_name"`
	WorkspaceOwnerID    uuid.UUID           `json:"workspace_owner_id" format:"uuid"`
	WorkspaceOwnerName  string              `json:"workspace_owner_name"`
	TemplateVersionID   uuid.UUID           `json:"template_version_id" format:"uuid"`
	TemplateVersionName string              `json:"template_version_name"`
	BuildNumber         int32               `json:"build_number"`
	Transition          WorkspaceTransition `json:"transition" enums:"start,stop,delete"`
	InitiatorID         uuid.UUID           `json:"initiator_id" format:"uuid"`
	InitiatorUsername   string              `json:"initiator_name"`
	Job                 ProvisionerJob      `json:"job"`
	Reason              BuildReason         `db:"reason" json:"reason" enums:"initiator,autostart,autostop"`
	Resources           []WorkspaceResource `json:"resources"`
	Deadline            NullTime            `json:"deadline,omitempty" format:"date-time"`
	MaxDeadline         NullTime            `json:"max_deadline,omitempty" format:"date-time"`
	Status              WorkspaceStatus     `json:"status" enums:"pending,starting,running,stopping,stopped,failed,canceling,canceled,deleting,deleted"`
	DailyCost           int32               `json:"daily_cost"`

WorkspaceBuild is an at-point representation of a workspace state. BuildNumbers start at 1 and increase by 1 for each subsequent build

type WorkspaceBuildParameter added in v0.15.0

type WorkspaceBuildParameter struct {
	Name  string `json:"name"`
	Value string `json:"value"`

WorkspaceBuildParameter represents a parameter specific for a workspace build.

type WorkspaceBuildsRequest added in v0.6.0

type WorkspaceBuildsRequest struct {
	WorkspaceID uuid.UUID
	Since time.Time

type WorkspaceConnectionLatencyMS added in v0.19.0

type WorkspaceConnectionLatencyMS struct {
	P50 float64
	P95 float64

type WorkspaceDeploymentStats added in v0.19.0

type WorkspaceDeploymentStats struct {
	Pending  int64 `json:"pending"`
	Building int64 `json:"building"`
	Running  int64 `json:"running"`
	Failed   int64 `json:"failed"`
	Stopped  int64 `json:"stopped"`

	ConnectionLatencyMS WorkspaceConnectionLatencyMS `json:"connection_latency_ms"`
	RxBytes             int64                        `json:"rx_bytes"`
	TxBytes             int64                        `json:"tx_bytes"`

type WorkspaceFilter added in v0.6.0

type WorkspaceFilter struct {
	// Owner can be "me" or a username
	Owner string `json:"owner,omitempty" typescript:"-"`
	// Template is a template name
	Template string `json:"template,omitempty" typescript:"-"`
	// Name will return partial matches
	Name string `json:"name,omitempty" typescript:"-"`
	// Status is a workspace status, which is really the status of the latest build
	Status string `json:"status,omitempty" typescript:"-"`
	// Offset is the number of workspaces to skip before returning results.
	Offset int `json:"offset,omitempty" typescript:"-"`
	// Limit is a limit on the number of workspaces returned.
	Limit int `json:"limit,omitempty" typescript:"-"`
	// FilterQuery supports a raw filter query string
	FilterQuery string `json:"q,omitempty"`

type WorkspaceHealth added in v0.26.0

type WorkspaceHealth struct {
	Healthy       bool        `json:"healthy" example:"false"`      // Healthy is true if the workspace is healthy.
	FailingAgents []uuid.UUID `json:"failing_agents" format:"uuid"` // FailingAgents lists the IDs of the agents that are failing, if any.

type WorkspaceOptions added in v0.6.3

type WorkspaceOptions struct {
	IncludeDeleted bool `json:"include_deleted,omitempty"`

type WorkspaceProxy added in v0.22.0

type WorkspaceProxy struct {
	// Extends Region with extra information
	Region `table:"region,recursive_inline"`

	// Status is the latest status check of the proxy. This will be empty for deleted
	// proxies. This value can be used to determine if a workspace proxy is healthy
	// and ready to use.
	Status WorkspaceProxyStatus `json:"status,omitempty" table:"proxy,recursive"`

	CreatedAt time.Time `json:"created_at" format:"date-time" table:"created_at,default_sort"`
	UpdatedAt time.Time `json:"updated_at" format:"date-time" table:"updated_at"`
	Deleted   bool      `json:"deleted" table:"deleted"`

type WorkspaceProxyBuildInfo added in v0.23.0

type WorkspaceProxyBuildInfo struct {
	// TODO: @emyrk what should we include here?
	WorkspaceProxy bool `json:"workspace_proxy"`
	// DashboardURL is the URL of the coderd this proxy is connected to.
	DashboardURL string `json:"dashboard_url"`

type WorkspaceProxyStatus added in v0.23.0

type WorkspaceProxyStatus struct {
	Status ProxyHealthStatus `json:"status" table:"status,default_sort"`
	// Report provides more information about the health of the workspace proxy.
	Report    ProxyHealthReport `json:"report,omitempty" table:"report"`
	CheckedAt time.Time         `json:"checked_at" table:"checked_at" format:"date-time"`

type WorkspaceQuota added in v0.9.2

type WorkspaceQuota struct {
	CreditsConsumed int `json:"credits_consumed"`
	Budget          int `json:"budget"`

type WorkspaceResource

type WorkspaceResource struct {
	ID         uuid.UUID                   `json:"id" format:"uuid"`
	CreatedAt  time.Time                   `json:"created_at" format:"date-time"`
	JobID      uuid.UUID                   `json:"job_id" format:"uuid"`
	Transition WorkspaceTransition         `json:"workspace_transition" enums:"start,stop,delete"`
	Type       string                      `json:"type"`
	Name       string                      `json:"name"`
	Hide       bool                        `json:"hide"`
	Icon       string                      `json:"icon"`
	Agents     []WorkspaceAgent            `json:"agents,omitempty"`
	Metadata   []WorkspaceResourceMetadata `json:"metadata,omitempty"`
	DailyCost  int32                       `json:"daily_cost"`

WorkspaceResource describes resources used to create a workspace, for instance: containers, images, volumes.

type WorkspaceResourceMetadata added in v0.8.3

type WorkspaceResourceMetadata struct {
	Key       string `json:"key"`
	Value     string `json:"value"`
	Sensitive bool   `json:"sensitive"`

WorkspaceResourceMetadata annotates the workspace resource with custom key-value pairs.

type WorkspaceStatus added in v0.9.2

type WorkspaceStatus string
const (
	WorkspaceStatusPending   WorkspaceStatus = "pending"
	WorkspaceStatusStarting  WorkspaceStatus = "starting"
	WorkspaceStatusRunning   WorkspaceStatus = "running"
	WorkspaceStatusStopping  WorkspaceStatus = "stopping"
	WorkspaceStatusStopped   WorkspaceStatus = "stopped"
	WorkspaceStatusFailed    WorkspaceStatus = "failed"
	WorkspaceStatusCanceling WorkspaceStatus = "canceling"
	WorkspaceStatusCanceled  WorkspaceStatus = "canceled"
	WorkspaceStatusDeleting  WorkspaceStatus = "deleting"
	WorkspaceStatusDeleted   WorkspaceStatus = "deleted"

type WorkspaceTransition added in v0.6.0

type WorkspaceTransition string
const (
	WorkspaceTransitionStart  WorkspaceTransition = "start"
	WorkspaceTransitionStop   WorkspaceTransition = "stop"
	WorkspaceTransitionDelete WorkspaceTransition = "delete"

type WorkspacesRequest added in v0.11.0

type WorkspacesRequest struct {
	SearchQuery string `json:"q,omitempty"`

type WorkspacesResponse added in v0.12.6

type WorkspacesResponse struct {
	Workspaces []Workspace `json:"workspaces"`
	Count      int         `json:"count"`


Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL