func BitmapToWeekdays(bitmapuint8) []string

func DefaultCacheDir()string

func IsConnectionError(errerror)bool

func IsSecretDeploymentOption(optclibase.Option)bool

func IsWorkspaceProxies(optclibase.Option)bool

func ParseSSHConfigOption(optstring) (keystring, valuestring, errerror)

func ReadBodyAsError(res *http.Response)error

func ServerSentEventReader(ctxcontext.Context, rcio.ReadCloser) func() (*ServerSentEvent,error)

func TimezoneOffsetHour(loc *time.Location)int

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

func ValidateWorkspaceBuildParameter(richParameterTemplateVersionParameter, buildParameter *WorkspaceBuildParameter, lastBuildParameter *WorkspaceBuildParameter)error

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

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

func WorkspaceDisplayStatus(jobStatusProvisionerJobStatus, transitionWorkspaceTransition)string

func WorkspaceNotifyChannel(iduuid.UUID)string

type APIKey struct {IDstring      `json:"id" validate:"required"`UserIDuuid.UUID   `json:"user_id" validate:"required" format:"uuid"`LastUsedtime.Time   `json:"last_used" validate:"required" format:"date-time"`ExpiresAttime.Time   `json:"expires_at" validate:"required" format:"date-time"`CreatedAttime.Time   `json:"created_at" validate:"required" format:"date-time"`UpdatedAttime.Time   `json:"updated_at" validate:"required" format:"date-time"`LoginTypeLoginType   `json:"login_type" validate:"required" enums:"password,github,oidc,token"`ScopeAPIKeyScope `json:"scope" validate:"required" enums:"all,application_connect"`TokenNamestring      `json:"token_name" validate:"required"`LifetimeSecondsint64       `json:"lifetime_seconds" validate:"required"`}

type APIKeyScopestring

type APIKeyWithOwner struct {APIKeyUsernamestring `json:"username"`}

type AddLicenseRequest struct {Licensestring `json:"license" validate:"required"`}

type AgentStatsReportRequest struct{}

type AgentStatsReportResponse struct {NumConnsint64 `json:"num_comms"`// RxBytes is the number of received bytes.RxBytesint64 `json:"rx_bytes"`// TxBytes is the number of transmitted bytes.TxBytesint64 `json:"tx_bytes"`}

type AgentSubsystemstring

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

type AppearanceConfig struct {LogoURLstring              `json:"logo_url"`ServiceBannerServiceBannerConfig `json:"service_banner"`SupportLinks  []LinkConfig        `json:"support_links,omitempty"`}

type AssignableRoles struct {RoleAssignablebool `json:"assignable"`}

type AuditActionstring

func (AuditAction)Friendly¶added inv0.16.0

func (aAuditAction) Friendly()string

type AuditDiff map[string]AuditDiffField

type AuditDiffField struct {Oldany  `json:"old,omitempty"`Newany  `json:"new,omitempty"`Secretbool `json:"secret"`}

type AuditLog struct {IDuuid.UUID    `json:"id" format:"uuid"`RequestIDuuid.UUID    `json:"request_id" format:"uuid"`Timetime.Time    `json:"time" format:"date-time"`OrganizationIDuuid.UUID    `json:"organization_id" format:"uuid"`IPnetip.Addr   `json:"ip"`UserAgentstring       `json:"user_agent"`ResourceTypeResourceType `json:"resource_type"`ResourceIDuuid.UUID    `json:"resource_id" format:"uuid"`// ResourceTarget is the name of the resource.ResourceTargetstring          `json:"resource_target"`ResourceIconstring          `json:"resource_icon"`ActionAuditAction     `json:"action"`DiffAuditDiff       `json:"diff"`StatusCodeint32           `json:"status_code"`AdditionalFieldsjson.RawMessage `json:"additional_fields"`Descriptionstring          `json:"description"`ResourceLinkstring          `json:"resource_link"`IsDeletedbool            `json:"is_deleted"`User *User `json:"user"`}

type AuditLogResponse struct {AuditLogs []AuditLog `json:"audit_logs"`Countint64      `json:"count"`}

type AuditLogsRequest struct {SearchQuerystring `json:"q,omitempty"`Pagination}

type AuthMethod struct {Enabledbool `json:"enabled"`}

type AuthMethods struct {ConvertToOIDCEnabledbool           `json:"convert_to_oidc_enabled"`PasswordAuthMethod     `json:"password"`GithubAuthMethod     `json:"github"`OIDCOIDCAuthMethod `json:"oidc"`}

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.ObjectAuthorizationObject `json:"object"`Actionstring              `json:"action" enums:"create,read,update,delete"`}

type AuthorizationObject struct {// ResourceType is the name of the resource.// `./coderd/rbac/object.go` has the list of valid resource types.ResourceTypeRBACResource `json:"resource_type"`// OwnerID (optional) adds the set constraint to all resources owned by a given user.OwnerIDstring `json:"owner_id,omitempty"`// OrganizationID (optional) adds the set constraint to all resources owned by a given organization.OrganizationIDstring `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.ResourceIDstring `json:"resource_id,omitempty"`}

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"`}

type AuthorizationResponse map[string]bool

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.ExternalURLstring `json:"external_url"`// Version returns the semantic version of the build.Versionstring `json:"version"`// DashboardURL is the URL to hit the deployment's dashboard.// For external workspace proxies, this is the coderd they are connected// to.DashboardURLstring `json:"dashboard_url"`WorkspaceProxybool `json:"workspace_proxy"`}

func (BuildInfoResponse)CanonicalVersion¶added inv0.7.7

func (bBuildInfoResponse) CanonicalVersion()string

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

type BuildReasonstring

type Client struct {HTTPClient *http.ClientURL        *url.URL// SessionTokenHeader is an optional custom header to use for setting tokens. By// default 'Coder-Session-Token' is used.SessionTokenHeaderstring// PlainLogger may be set to log HTTP traffic in a human-readable form.// It uses the LogBodies option.PlainLoggerio.Writer// Trace can be enabled to propagate tracing spans to the Coder API.// This is useful for tracking a request end-to-end.Tracebool// DisableDirectConnections forces any connections to workspaces to go// through DERP, regardless of the BlockEndpoints setting on each// connection.DisableDirectConnectionsbool// contains filtered or unexported fields}

funcNew¶

func New(serverURL *url.URL) *Client

New creates a Coder client for the provided URL.

func (*Client)APIKeyByID¶added inv0.19.0

func (c *Client) APIKeyByID(ctxcontext.Context, userIDstring, idstring) (*APIKey,error)

APIKeyByID returns the api key by id.

func (*Client)APIKeyByName¶added inv0.19.0

func (c *Client) APIKeyByName(ctxcontext.Context, userIDstring, namestring) (*APIKey,error)

APIKeyByName returns the api key by name.

func (*Client)AddLicense¶added inv0.8.7

func (c *Client) AddLicense(ctxcontext.Context, rAddLicenseRequest) (License,error)

func (*Client)AppHost¶added inv0.16.0

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

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

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

func (*Client)Appearance¶added inv0.14.0

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

Appearance returns the configuration that modifies the visualdisplay of the dashboard.

func (*Client)AuditLogs¶added inv0.8.14

func (c *Client) AuditLogs(ctxcontext.Context, reqAuditLogsRequest) (AuditLogResponse,error)

AuditLogs retrieves audit logs from the given page.

func (*Client)AuthCheck¶added inv0.16.0

func (c *Client) AuthCheck(ctxcontext.Context, reqAuthorizationRequest) (AuthorizationResponse,error)

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

func (*Client)AuthMethods¶added inv0.4.4

func (c *Client) AuthMethods(ctxcontext.Context) (AuthMethods,error)

AuthMethods returns types of authentication available to the user.

func (*Client)BuildInfo¶added inv0.4.1

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

BuildInfo returns build information for this instance of Coder.

func (*Client)CancelTemplateVersion¶added inv0.4.0

func (c *Client) CancelTemplateVersion(ctxcontext.Context, versionuuid.UUID)error

CancelTemplateVersion marks a template version job as canceled.

func (*Client)CancelTemplateVersionDryRun¶added inv0.6.1

func (c *Client) CancelTemplateVersionDryRun(ctxcontext.Context, version, jobuuid.UUID)error

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

func (*Client)CancelWorkspaceBuild¶

func (c *Client) CancelWorkspaceBuild(ctxcontext.Context, iduuid.UUID)error

CancelWorkspaceBuild marks a workspace build job as canceled.

func (*Client)ConvertLoginType¶added inv0.25.0

func (c *Client) ConvertLoginType(ctxcontext.Context, reqConvertLoginRequest) (OAuthConversionResponse,error)

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

func (*Client)CreateAPIKey¶

func (c *Client) CreateAPIKey(ctxcontext.Context, userstring) (GenerateAPIKeyResponse,error)

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

func (*Client)CreateFirstUser¶

func (c *Client) CreateFirstUser(ctxcontext.Context, reqCreateFirstUserRequest) (CreateFirstUserResponse,error)

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 inv0.9.9

func (c *Client) CreateGroup(ctxcontext.Context, orgIDuuid.UUID, reqCreateGroupRequest) (Group,error)

func (*Client)CreateOrganization¶

func (c *Client) CreateOrganization(ctxcontext.Context, reqCreateOrganizationRequest) (Organization,error)

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

func (*Client)CreateTemplate¶added inv0.4.0

func (c *Client) CreateTemplate(ctxcontext.Context, organizationIDuuid.UUID, requestCreateTemplateRequest) (Template,error)

CreateTemplate creates a new template inside an organization.

func (*Client)CreateTemplateVersion¶added inv0.4.0

func (c *Client) CreateTemplateVersion(ctxcontext.Context, organizationIDuuid.UUID, reqCreateTemplateVersionRequest) (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 inv0.6.1

func (c *Client) CreateTemplateVersionDryRun(ctxcontext.Context, versionuuid.UUID, reqCreateTemplateVersionDryRunRequest) (ProvisionerJob,error)

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

func (*Client)CreateTestAuditLog¶added inv0.8.14

func (c *Client) CreateTestAuditLog(ctxcontext.Context, reqCreateTestAuditLogRequest)error

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

func (*Client)CreateToken¶added inv0.9.7

func (c *Client) CreateToken(ctxcontext.Context, userIDstring, reqCreateTokenRequest) (GenerateAPIKeyResponse,error)

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

func (*Client)CreateUser¶

func (c *Client) CreateUser(ctxcontext.Context, reqCreateUserRequest) (User,error)

CreateUser creates a new user.

func (*Client)CreateWorkspace¶

func (c *Client) CreateWorkspace(ctxcontext.Context, organizationIDuuid.UUID, userstring, requestCreateWorkspaceRequest) (Workspace,error)

CreateWorkspace creates a new workspace for the template specified.

func (*Client)CreateWorkspaceBuild¶

func (c *Client) CreateWorkspaceBuild(ctxcontext.Context, workspaceuuid.UUID, requestCreateWorkspaceBuildRequest) (WorkspaceBuild,error)

CreateWorkspaceBuild queues a new build to occur for a workspace.

func (*Client)CreateWorkspaceProxy¶added inv0.22.0

func (c *Client) CreateWorkspaceProxy(ctxcontext.Context, reqCreateWorkspaceProxyRequest) (UpdateWorkspaceProxyResponse,error)

func (*Client)DeleteAPIKey¶added inv0.9.7

func (c *Client) DeleteAPIKey(ctxcontext.Context, userIDstring, idstring)error

DeleteAPIKey deletes API key by id.

func (*Client)DeleteGroup¶added inv0.9.9

func (c *Client) DeleteGroup(ctxcontext.Context, groupuuid.UUID)error

func (*Client)DeleteLicense¶added inv0.8.7

func (c *Client) DeleteLicense(ctxcontext.Context, idint32)error

func (*Client)DeleteTemplate¶added inv0.4.0

func (c *Client) DeleteTemplate(ctxcontext.Context, templateuuid.UUID)error

func (*Client)DeleteUser¶added inv0.8.15

func (c *Client) DeleteUser(ctxcontext.Context, iduuid.UUID)error

DeleteUser deletes a user.

func (*Client)DeleteWorkspaceProxyByID¶added inv0.23.0

func (c *Client) DeleteWorkspaceProxyByID(ctxcontext.Context, iduuid.UUID)error

func (*Client)DeleteWorkspaceProxyByName¶added inv0.23.0

func (c *Client) DeleteWorkspaceProxyByName(ctxcontext.Context, namestring)error

func (*Client)DeletedWorkspace¶added inv0.6.0

func (c *Client) DeletedWorkspace(ctxcontext.Context, iduuid.UUID) (Workspace,error)

DeletedWorkspace returns a single workspace that was deleted.

func (*Client)DeploymentConfig¶added inv0.11.0

func (c *Client) DeploymentConfig(ctxcontext.Context) (*DeploymentConfig,error)

DeploymentConfig returns the deployment config for the coder server.

func (*Client)DeploymentDAUs¶added inv0.15.3

func (c *Client) DeploymentDAUs(ctxcontext.Context, tzOffsetint) (*DAUsResponse,error)

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

func (*Client)DeploymentDAUsLocalTZ¶added inv0.24.0

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

func (*Client)DeploymentStats¶added inv0.19.0

func (c *Client) DeploymentStats(ctxcontext.Context) (DeploymentStats,error)

func (*Client)DialWorkspaceAgent¶

func (c *Client) DialWorkspaceAgent(ctxcontext.Context, agentIDuuid.UUID, options *DialWorkspaceAgentOptions) (agentConn *WorkspaceAgentConn, errerror)

func (*Client)Download¶

func (c *Client) Download(ctxcontext.Context, iduuid.UUID) ([]byte,string,error)

Download fetches a file by uploaded hash.

func (*Client)Entitlements¶added inv0.8.6

func (c *Client) Entitlements(ctxcontext.Context) (Entitlements,error)

func (*Client)Experiments¶added inv0.15.0

func (c *Client) Experiments(ctxcontext.Context) (Experiments,error)

func (*Client)GetTokenConfig¶added inv0.20.0

func (c *Client) GetTokenConfig(ctxcontext.Context, userIDstring) (TokenConfig,error)

GetTokenConfig returns deployment options related to token management

func (*Client)GitAuthByID¶added inv0.25.0

func (c *Client) GitAuthByID(ctxcontext.Context, providerstring) (GitAuth,error)

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

func (*Client)GitAuthDeviceByID¶added inv0.25.0

func (c *Client) GitAuthDeviceByID(ctxcontext.Context, providerstring) (GitAuthDevice,error)

func (*Client)GitAuthDeviceExchange¶added inv0.25.0

func (c *Client) GitAuthDeviceExchange(ctxcontext.Context, providerstring, reqGitAuthDeviceExchange)error

ExchangeGitAuth exchanges a device code for a git auth token.

func (*Client)GitSSHKey¶added inv0.4.0

func (c *Client) GitSSHKey(ctxcontext.Context, userstring) (GitSSHKey,error)

GitSSHKey returns the user's git SSH public key.

func (*Client)Group¶added inv0.9.9

func (c *Client) Group(ctxcontext.Context, groupuuid.UUID) (Group,error)

func (*Client)GroupByOrgAndName¶added inv0.12.0

func (c *Client) GroupByOrgAndName(ctxcontext.Context, orgIDuuid.UUID, namestring) (Group,error)

func (*Client)GroupsByOrganization¶added inv0.9.9

func (c *Client) GroupsByOrganization(ctxcontext.Context, orgIDuuid.UUID) ([]Group,error)

func (*Client)HasFirstUser¶

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

HasFirstUser returns whether the first user has been created.

func (*Client)IssueReconnectingPTYSignedToken¶added inv0.23.0

func (c *Client) IssueReconnectingPTYSignedToken(ctxcontext.Context, reqIssueReconnectingPTYSignedTokenRequest) (IssueReconnectingPTYSignedTokenResponse,error)

func (*Client)Licenses¶added inv0.8.7

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

func (*Client)ListOrganizationRoles¶added inv0.5.4

func (c *Client) ListOrganizationRoles(ctxcontext.Context, orguuid.UUID) ([]AssignableRoles,error)

ListOrganizationRoles lists all assignable roles for a given organization.

func (*Client)ListSiteRoles¶added inv0.5.4

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

ListSiteRoles lists all assignable site wide roles.

func (*Client)LogBodies¶added inv0.12.6

func (c *Client) LogBodies()bool

LogBodies returns whether requests and response bodies are logged.

func (*Client)Logger¶added inv0.12.6

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

Logger returns the logger for the client.

func (*Client)LoginWithPassword¶

func (c *Client) LoginWithPassword(ctxcontext.Context, reqLoginWithPasswordRequest) (LoginWithPasswordResponse,error)

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(ctxcontext.Context)error

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

func (*Client)Organization¶

func (c *Client) Organization(ctxcontext.Context, iduuid.UUID) (Organization,error)

func (*Client)OrganizationByName¶

func (c *Client) OrganizationByName(ctxcontext.Context, userstring, namestring) (Organization,error)

func (*Client)OrganizationsByUser¶

func (c *Client) OrganizationsByUser(ctxcontext.Context, userstring) ([]Organization,error)

OrganizationsByUser returns all organizations the user is a member of.

func (*Client)PatchGroup¶added inv0.9.9

func (c *Client) PatchGroup(ctxcontext.Context, groupuuid.UUID, reqPatchGroupRequest) (Group,error)

func (*Client)PatchWorkspaceProxy¶added inv0.23.3

func (c *Client) PatchWorkspaceProxy(ctxcontext.Context, reqPatchWorkspaceProxy) (UpdateWorkspaceProxyResponse,error)

func (*Client)PreviousTemplateVersion¶added inv0.13.2

func (c *Client) PreviousTemplateVersion(ctxcontext.Context, organizationuuid.UUID, templateName, versionNamestring) (TemplateVersion,error)

func (*Client)ProvisionerDaemons¶added inv0.6.1

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

ProvisionerDaemonsByOrganization returns provisioner daemons available for an organization.

func (*Client)PutExtendWorkspace¶added inv0.6.1

func (c *Client) PutExtendWorkspace(ctxcontext.Context, iduuid.UUID, reqPutExtendWorkspaceRequest)error

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

func (*Client)RegenerateGitSSHKey¶added inv0.4.0

func (c *Client) RegenerateGitSSHKey(ctxcontext.Context, userstring) (GitSSHKey,error)

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

func (*Client)Regions¶added inv0.23.1

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

func (*Client)Replicas¶added inv0.10.0

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

Replicas fetches the list of replicas.

func (*Client)Request¶added inv0.5.10

func (c *Client) Request(ctxcontext.Context, method, pathstring, body interface{}, opts ...RequestOption) (*http.Response,error)

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

func (*Client)SSHConfiguration¶added inv0.20.0

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

SSHConfiguration returns information about the SSH configuration for theCoder instance.

func (*Client)ServeProvisionerDaemon¶added inv0.12.8

func (c *Client) ServeProvisionerDaemon(ctxcontext.Context, organizationuuid.UUID, provisioners []ProvisionerType, tags map[string]string) (proto.DRPCProvisionerDaemonClient,error)

ListenProvisionerDaemon returns the gRPC service for a provisioner daemonimplementation. The context is during dial, not during the lifetime of theclient. 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 inv0.26.0

func (c *Client) SetLogBodies(logBodiesbool)

SetLogBodies sets whether to log request and response bodies.

func (*Client)SetLogger¶added inv0.26.0

func (c *Client) SetLogger(loggerslog.Logger)

SetLogger sets the logger for the client.

func (*Client)SetSessionToken¶added inv0.12.6

func (c *Client) SetSessionToken(tokenstring)

SetSessionToken returns the currently set token for the client.

func (*Client)Template¶added inv0.4.0

func (c *Client) Template(ctxcontext.Context, templateuuid.UUID) (Template,error)

Template returns a single template.

func (*Client)TemplateACL¶added inv0.9.9

func (c *Client) TemplateACL(ctxcontext.Context, templateIDuuid.UUID) (TemplateACL,error)

func (*Client)TemplateByName¶added inv0.4.0

func (c *Client) TemplateByName(ctxcontext.Context, organizationIDuuid.UUID, namestring) (Template,error)

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

func (*Client)TemplateDAUs¶added inv0.8.12

func (c *Client) TemplateDAUs(ctxcontext.Context, templateIDuuid.UUID, tzOffsetint) (*DAUsResponse,error)

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

func (*Client)TemplateDAUsLocalTZ¶added inv0.24.0

func (c *Client) TemplateDAUsLocalTZ(ctxcontext.Context, templateIDuuid.UUID) (*DAUsResponse,error)

func (*Client)TemplateExamples¶added inv0.13.2

func (c *Client) TemplateExamples(ctxcontext.Context, organizationIDuuid.UUID) ([]TemplateExample,error)

TemplateExamples lists example templates embedded in coder.

func (*Client)TemplateInsights¶added inv0.27.1

func (c *Client) TemplateInsights(ctxcontext.Context, reqTemplateInsightsRequest) (TemplateInsightsResponse,error)

func (*Client)TemplateVersion¶added inv0.4.0

func (c *Client) TemplateVersion(ctxcontext.Context, iduuid.UUID) (TemplateVersion,error)

TemplateVersion returns a template version by ID.

func (*Client)TemplateVersionByName¶added inv0.4.0

func (c *Client) TemplateVersionByName(ctxcontext.Context, templateuuid.UUID, namestring) (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 inv0.12.8

func (c *Client) TemplateVersionByOrganizationAndName(ctxcontext.Context, organizationIDuuid.UUID, templateName, versionNamestring) (TemplateVersion,error)

func (*Client)TemplateVersionDryRun¶added inv0.6.1

func (c *Client) TemplateVersionDryRun(ctxcontext.Context, version, jobuuid.UUID) (ProvisionerJob,error)

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

func (*Client)TemplateVersionDryRunLogsAfter¶added inv0.6.1

func (c *Client) TemplateVersionDryRunLogsAfter(ctxcontext.Context, version, jobuuid.UUID, afterint64) (<-chanProvisionerJobLog,io.Closer,error)

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

func (*Client)TemplateVersionDryRunResources¶added inv0.6.1

func (c *Client) TemplateVersionDryRunResources(ctxcontext.Context, version, jobuuid.UUID) ([]WorkspaceResource,error)

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

func (*Client)TemplateVersionGitAuth¶added inv0.18.0

func (c *Client) TemplateVersionGitAuth(ctxcontext.Context, versionuuid.UUID) ([]TemplateVersionGitAuth,error)

TemplateVersionGitAuth returns git authentication for the requested template version.

func (*Client)TemplateVersionLogsAfter¶added inv0.4.0

func (c *Client) TemplateVersionLogsAfter(ctxcontext.Context, versionuuid.UUID, afterint64) (<-chanProvisionerJobLog,io.Closer,error)

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

func (*Client)TemplateVersionResources¶added inv0.4.0

func (c *Client) TemplateVersionResources(ctxcontext.Context, versionuuid.UUID) ([]WorkspaceResource,error)

TemplateVersionResources returns resources a template version declares.

func (*Client)TemplateVersionRichParameters¶added inv0.15.0

func (c *Client) TemplateVersionRichParameters(ctxcontext.Context, versionuuid.UUID) ([]TemplateVersionParameter,error)

TemplateVersionParameters returns parameters a template version exposes.

func (*Client)TemplateVersionVariables¶added inv0.17.4

func (c *Client) TemplateVersionVariables(ctxcontext.Context, versionuuid.UUID) ([]TemplateVersionVariable,error)

TemplateVersionVariables returns resources a template version variables.

func (*Client)TemplateVersionsByTemplate¶added inv0.4.0

func (c *Client) TemplateVersionsByTemplate(ctxcontext.Context, reqTemplateVersionsByTemplateRequest) ([]TemplateVersion,error)

TemplateVersionsByTemplate lists versions associated with a template.

func (*Client)TemplatesByOrganization¶added inv0.4.0

func (c *Client) TemplatesByOrganization(ctxcontext.Context, organizationIDuuid.UUID) ([]Template,error)

TemplatesByOrganization lists all templates inside of an organization.

func (*Client)Tokens¶added inv0.16.0

func (c *Client) Tokens(ctxcontext.Context, userIDstring, filterTokensFilter) ([]APIKeyWithOwner,error)

Tokens list machine API keys.

func (*Client)UpdateActiveTemplateVersion¶added inv0.4.0

func (c *Client) UpdateActiveTemplateVersion(ctxcontext.Context, templateuuid.UUID, reqUpdateActiveTemplateVersion)error

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

func (*Client)UpdateAppearance¶added inv0.14.0

func (c *Client) UpdateAppearance(ctxcontext.Context, appearanceUpdateAppearanceConfig)error

func (*Client)UpdateCheck¶added inv0.13.0

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

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

func (*Client)UpdateOrganizationMemberRoles¶added inv0.5.2

func (c *Client) UpdateOrganizationMemberRoles(ctxcontext.Context, organizationIDuuid.UUID, userstring, reqUpdateRoles) (OrganizationMember,error)

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

func (*Client)UpdateTemplateACL¶added inv0.9.9

func (c *Client) UpdateTemplateACL(ctxcontext.Context, templateIDuuid.UUID, reqUpdateTemplateACL)error

func (*Client)UpdateTemplateMeta¶added inv0.6.3

func (c *Client) UpdateTemplateMeta(ctxcontext.Context, templateIDuuid.UUID, reqUpdateTemplateMeta) (Template,error)

func (*Client)UpdateTemplateVersion¶added inv0.21.0

func (c *Client) UpdateTemplateVersion(ctxcontext.Context, versionIDuuid.UUID, reqPatchTemplateVersionRequest) (TemplateVersion,error)

func (*Client)UpdateUserPassword¶added inv0.5.5

func (c *Client) UpdateUserPassword(ctxcontext.Context, userstring, reqUpdateUserPasswordRequest)error

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

func (*Client)UpdateUserProfile¶added inv0.4.2

func (c *Client) UpdateUserProfile(ctxcontext.Context, userstring, reqUpdateUserProfileRequest) (User,error)

UpdateUserProfile enables callers to update profile information

func (*Client)UpdateUserQuietHoursSchedule¶added inv0.26.2

func (c *Client) UpdateUserQuietHoursSchedule(ctxcontext.Context, userIdentstring, reqUpdateUserQuietHoursScheduleRequest) (UserQuietHoursScheduleResponse,error)

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

func (*Client)UpdateUserRoles¶added inv0.5.2

func (c *Client) UpdateUserRoles(ctxcontext.Context, userstring, reqUpdateRoles) (User,error)

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

func (*Client)UpdateUserStatus¶added inv0.5.8

func (c *Client) UpdateUserStatus(ctxcontext.Context, userstring, statusUserStatus) (User,error)

UpdateUserStatus sets the user status to the given status

func (*Client)UpdateWorkspace¶added inv0.8.7

func (c *Client) UpdateWorkspace(ctxcontext.Context, iduuid.UUID, reqUpdateWorkspaceRequest)error

func (*Client)UpdateWorkspaceAutostart¶added inv0.4.1

func (c *Client) UpdateWorkspaceAutostart(ctxcontext.Context, iduuid.UUID, reqUpdateWorkspaceAutostartRequest)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 inv0.25.0

func (c *Client) UpdateWorkspaceLock(ctxcontext.Context, iduuid.UUID, reqUpdateWorkspaceLock)error

UpdateWorkspaceLock locks or unlocks a workspace.

func (*Client)UpdateWorkspaceTTL¶added inv0.6.0

func (c *Client) UpdateWorkspaceTTL(ctxcontext.Context, iduuid.UUID, reqUpdateWorkspaceTTLRequest)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(ctxcontext.Context, contentTypestring, rdio.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(ctxcontext.Context, userIdentstring) (User,error)

User returns a user for the ID/username provided.

func (*Client)UserLatencyInsights¶added inv0.27.1

func (c *Client) UserLatencyInsights(ctxcontext.Context, reqUserLatencyInsightsRequest) (UserLatencyInsightsResponse,error)

func (*Client)UserQuietHoursSchedule¶added inv0.26.2

func (c *Client) UserQuietHoursSchedule(ctxcontext.Context, userIdentstring) (UserQuietHoursScheduleResponse,error)

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

func (*Client)UserRoles¶added inv0.16.0

func (c *Client) UserRoles(ctxcontext.Context, userstring) (UserRoles,error)

UserRoles returns all roles the user has

func (*Client)Users¶added inv0.4.4

func (c *Client) Users(ctxcontext.Context, reqUsersRequest) (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 inv0.6.0

func (c *Client) WatchWorkspace(ctxcontext.Context, iduuid.UUID) (<-chanWorkspace,error)

func (*Client)WatchWorkspaceAgentMetadata¶added inv0.21.3

func (c *Client) WatchWorkspaceAgentMetadata(ctxcontext.Context, iduuid.UUID) (<-chan []WorkspaceAgentMetadata, <-chanerror)

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

func (*Client)Workspace¶

func (c *Client) Workspace(ctxcontext.Context, iduuid.UUID) (Workspace,error)

Workspace returns a single workspace.

func (*Client)WorkspaceAgent¶added inv0.4.1

func (c *Client) WorkspaceAgent(ctxcontext.Context, iduuid.UUID) (WorkspaceAgent,error)

WorkspaceAgent returns an agent by ID.

func (*Client)WorkspaceAgentConnectionInfo¶added inv0.25.0

func (c *Client) WorkspaceAgentConnectionInfo(ctxcontext.Context) (*WorkspaceAgentConnectionInfo,error)

func (*Client)WorkspaceAgentListeningPorts¶added inv0.9.5

func (c *Client) WorkspaceAgentListeningPorts(ctxcontext.Context, agentIDuuid.UUID) (WorkspaceAgentListeningPortsResponse,error)

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

func (*Client)WorkspaceAgentReconnectingPTY¶added inv0.5.2

func (c *Client) WorkspaceAgentReconnectingPTY(ctxcontext.Context, optsWorkspaceAgentReconnectingPTYOpts) (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 inv0.21.0

func (c *Client) WorkspaceAgentStartupLogsAfter(ctxcontext.Context, agentIDuuid.UUID, afterint64, followbool) (<-chan []WorkspaceAgentStartupLog,io.Closer,error)

func (*Client)WorkspaceBuild¶

func (c *Client) WorkspaceBuild(ctxcontext.Context, iduuid.UUID) (WorkspaceBuild,error)

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

func (*Client)WorkspaceBuildByUsernameAndWorkspaceNameAndBuildNumber¶added inv0.6.6

func (c *Client) WorkspaceBuildByUsernameAndWorkspaceNameAndBuildNumber(ctxcontext.Context, usernamestring, workspaceNamestring, buildNumberstring) (WorkspaceBuild,error)

func (*Client)WorkspaceBuildLogsAfter¶

func (c *Client) WorkspaceBuildLogsAfter(ctxcontext.Context, builduuid.UUID, afterint64) (<-chanProvisionerJobLog,io.Closer,error)

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

func (*Client)WorkspaceBuildParameters¶added inv0.15.0

func (c *Client) WorkspaceBuildParameters(ctxcontext.Context, builduuid.UUID) ([]WorkspaceBuildParameter,error)

func (*Client)WorkspaceBuildState¶added inv0.5.3

func (c *Client) WorkspaceBuildState(ctxcontext.Context, builduuid.UUID) ([]byte,error)

WorkspaceBuildState returns the provisioner state of the build.

func (*Client)WorkspaceBuilds¶

func (c *Client) WorkspaceBuilds(ctxcontext.Context, reqWorkspaceBuildsRequest) ([]WorkspaceBuild,error)

func (*Client)WorkspaceByOwnerAndName¶added inv0.5.0

func (c *Client) WorkspaceByOwnerAndName(ctxcontext.Context, ownerstring, namestring, paramsWorkspaceOptions) (Workspace,error)

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

func (*Client)WorkspaceProxies¶added inv0.23.0

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

func (*Client)WorkspaceProxyByID¶added inv0.23.3

func (c *Client) WorkspaceProxyByID(ctxcontext.Context, iduuid.UUID) (WorkspaceProxy,error)

func (*Client)WorkspaceProxyByName¶added inv0.23.3

func (c *Client) WorkspaceProxyByName(ctxcontext.Context, namestring) (WorkspaceProxy,error)

func (*Client)WorkspaceQuota¶added inv0.9.2

func (c *Client) WorkspaceQuota(ctxcontext.Context, userIDstring) (WorkspaceQuota,error)

func (*Client)Workspaces¶added inv0.6.0

func (c *Client) Workspaces(ctxcontext.Context, filterWorkspaceFilter) (WorkspacesResponse,error)

Workspaces returns all workspaces the authenticated user has access to.

type ConnectionLatency struct {P50float64 `json:"p50" example:"31.312"`P95float64 `json:"p95" example:"119.832"`}

type ConvertLoginRequest struct {// ToType is the login type to convert to.ToTypeLoginType `json:"to_type" validate:"required"`Passwordstring    `json:"password" validate:"required"`}

type CreateFirstUserRequest struct {Emailstring `json:"email" validate:"required,email"`Usernamestring `json:"username" validate:"required,username"`Passwordstring `json:"password" validate:"required"`Trialbool   `json:"trial"`}

type CreateFirstUserResponse struct {UserIDuuid.UUID `json:"user_id" format:"uuid"`OrganizationIDuuid.UUID `json:"organization_id" format:"uuid"`}

type CreateGroupRequest struct {Namestring `json:"name"`AvatarURLstring `json:"avatar_url"`QuotaAllowanceint    `json:"quota_allowance"`}

type CreateOrganizationRequest struct {Namestring `json:"name" validate:"required,username"`}

type CreateTemplateRequest struct {// Name is the name of the template.Namestring `json:"name" validate:"template_name,required"`// DisplayName is the displayed name of the template.DisplayNamestring `json:"display_name,omitempty" validate:"template_display_name"`// Description is a description of what the template contains. It must be// less than 128 bytes.Descriptionstring `json:"description,omitempty" validate:"lt=128"`// Icon is a relative path or external URL that specifies// an icon to be displayed in the dashboard.Iconstring `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.VersionIDuuid.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 maturedMaxTTLMillis *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.DisableEveryoneGroupAccessbool `json:"disable_everyone_group_access"`}

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

type CreateTemplateVersionRequest struct {Namestring `json:"name,omitempty" validate:"omitempty,template_version_name"`Messagestring `json:"message,omitempty" validate:"lt=1048577"`// TemplateID optionally associates a version with a template.TemplateIDuuid.UUID                `json:"template_id,omitempty" format:"uuid"`StorageMethodProvisionerStorageMethod `json:"storage_method" validate:"oneof=file,required" enums:"file"`FileIDuuid.UUID                `json:"file_id,omitempty" validate:"required_without=ExampleID" format:"uuid"`ExampleIDstring                   `json:"example_id,omitempty" validate:"required_without=FileID"`ProvisionerProvisionerType          `json:"provisioner" validate:"oneof=terraform echo,required"`ProvisionerTags map[string]string        `json:"tags"`UserVariableValues []VariableValue `json:"user_variable_values,omitempty"`}

type CreateTestAuditLogRequest struct {ActionAuditAction     `json:"action,omitempty" enums:"create,write,delete,start,stop"`ResourceTypeResourceType    `json:"resource_type,omitempty" enums:"template,template_version,user,workspace,workspace_build,git_ssh_key,auditable_group"`ResourceIDuuid.UUID       `json:"resource_id,omitempty" format:"uuid"`AdditionalFieldsjson.RawMessage `json:"additional_fields,omitempty"`Timetime.Time       `json:"time,omitempty" format:"date-time"`BuildReasonBuildReason     `json:"build_reason,omitempty" enums:"autostart,autostop,initiator"`}

type CreateTokenRequest struct {Lifetimetime.Duration `json:"lifetime"`ScopeAPIKeyScope   `json:"scope" enums:"all,application_connect"`TokenNamestring        `json:"token_name"`}

type CreateUserRequest struct {Emailstring `json:"email" validate:"required,email" format:"email"`Usernamestring `json:"username" validate:"required,username"`Passwordstring `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.DisableLoginbool      `json:"disable_login"`OrganizationIDuuid.UUID `json:"organization_id" validate:"" format:"uuid"`}

type CreateWorkspaceBuildRequest struct {TemplateVersionIDuuid.UUID           `json:"template_version_id,omitempty" format:"uuid"`TransitionWorkspaceTransition `json:"transition" validate:"oneof=create start stop delete,required"`DryRunbool                `json:"dry_run,omitempty"`ProvisionerState  []byte              `json:"state,omitempty"`// Orphan may be set for the Destroy transition.Orphanbool `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).LogLevelProvisionerLogLevel `json:"log_level,omitempty" validate:"omitempty,oneof=debug"`}

type CreateWorkspaceProxyRequest struct {Namestring `json:"name" validate:"required"`DisplayNamestring `json:"display_name"`Iconstring `json:"icon"`}

type CreateWorkspaceRequest struct {TemplateIDuuid.UUID `json:"template_id" validate:"required" format:"uuid"`Namestring    `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"`}

type DAUEntry struct {Datetime.Time `json:"date" format:"date-time"`Amountint       `json:"amount"`}

type DAURequest struct {TZHourOffsetint}

type DAUsResponse struct {Entries      []DAUEntry `json:"entries"`TZHourOffsetint        `json:"tz_hour_offset"`}

type DERP struct {ServerDERPServerConfig `json:"server" typescript:",notnull"`ConfigDERPConfig       `json:"config" typescript:",notnull"`}

type DERPConfig struct {BlockDirectclibase.Bool   `json:"block_direct" typescript:",notnull"`URLclibase.String `json:"url" typescript:",notnull"`Pathclibase.String `json:"path" typescript:",notnull"`}

type DERPRegion struct {Preferredbool    `json:"preferred"`LatencyMillisecondsfloat64 `json:"latency_ms"`}

type DERPServerConfig struct {Enableclibase.Bool        `json:"enable" typescript:",notnull"`RegionIDclibase.Int64       `json:"region_id" typescript:",notnull"`RegionCodeclibase.String      `json:"region_code" typescript:",notnull"`RegionNameclibase.String      `json:"region_name" typescript:",notnull"`STUNAddressesclibase.StringArray `json:"stun_addresses" typescript:",notnull"`RelayURLclibase.URL         `json:"relay_url" typescript:",notnull"`}

type DangerousConfig struct {AllowPathAppSharingclibase.Bool `json:"allow_path_app_sharing" typescript:",notnull"`AllowPathAppSiteOwnerAccessclibase.Bool `json:"allow_path_app_site_owner_access" typescript:",notnull"`AllowAllCorsclibase.Bool `json:"allow_all_cors" typescript:",notnull"`}

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

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

type DeploymentValues struct {Verboseclibase.Bool `json:"verbose,omitempty"`AccessURLclibase.URL  `json:"access_url,omitempty"`WildcardAccessURLclibase.URL  `json:"wildcard_access_url,omitempty"`DocsURLclibase.URL  `json:"docs_url,omitempty"`RedirectToAccessURLclibase.Bool `json:"redirect_to_access_url,omitempty"`// HTTPAddress is a string because it may be set to zero to disable.HTTPAddressclibase.String                  `json:"http_address,omitempty" typescript:",notnull"`AutobuildPollIntervalclibase.Duration                `json:"autobuild_poll_interval,omitempty"`JobHangDetectorIntervalclibase.Duration                `json:"job_hang_detector_interval,omitempty"`DERPDERP                            `json:"derp,omitempty" typescript:",notnull"`PrometheusPrometheusConfig                `json:"prometheus,omitempty" typescript:",notnull"`PprofPprofConfig                     `json:"pprof,omitempty" typescript:",notnull"`ProxyTrustedHeadersclibase.StringArray             `json:"proxy_trusted_headers,omitempty" typescript:",notnull"`ProxyTrustedOriginsclibase.StringArray             `json:"proxy_trusted_origins,omitempty" typescript:",notnull"`CacheDirclibase.String                  `json:"cache_directory,omitempty" typescript:",notnull"`InMemoryDatabaseclibase.Bool                    `json:"in_memory_database,omitempty" typescript:",notnull"`PostgresURLclibase.String                  `json:"pg_connection_url,omitempty" typescript:",notnull"`OAuth2OAuth2Config                    `json:"oauth2,omitempty" typescript:",notnull"`OIDCOIDCConfig                      `json:"oidc,omitempty" typescript:",notnull"`TelemetryTelemetryConfig                 `json:"telemetry,omitempty" typescript:",notnull"`TLSTLSConfig                       `json:"tls,omitempty" typescript:",notnull"`TraceTraceConfig                     `json:"trace,omitempty" typescript:",notnull"`SecureAuthCookieclibase.Bool                    `json:"secure_auth_cookie,omitempty" typescript:",notnull"`StrictTransportSecurityclibase.Int64                   `json:"strict_transport_security,omitempty" typescript:",notnull"`StrictTransportSecurityOptionsclibase.StringArray             `json:"strict_transport_security_options,omitempty" typescript:",notnull"`SSHKeygenAlgorithmclibase.String                  `json:"ssh_keygen_algorithm,omitempty" typescript:",notnull"`MetricsCacheRefreshIntervalclibase.Duration                `json:"metrics_cache_refresh_interval,omitempty" typescript:",notnull"`AgentStatRefreshIntervalclibase.Duration                `json:"agent_stat_refresh_interval,omitempty" typescript:",notnull"`AgentFallbackTroubleshootingURLclibase.URL                     `json:"agent_fallback_troubleshooting_url,omitempty" typescript:",notnull"`BrowserOnlyclibase.Bool                    `json:"browser_only,omitempty" typescript:",notnull"`SCIMAPIKeyclibase.String                  `json:"scim_api_key,omitempty" typescript:",notnull"`ProvisionerProvisionerConfig               `json:"provisioner,omitempty" typescript:",notnull"`RateLimitRateLimitConfig                 `json:"rate_limit,omitempty" typescript:",notnull"`Experimentsclibase.StringArray             `json:"experiments,omitempty" typescript:",notnull"`UpdateCheckclibase.Bool                    `json:"update_check,omitempty" typescript:",notnull"`MaxTokenLifetimeclibase.Duration                `json:"max_token_lifetime,omitempty" typescript:",notnull"`SwaggerSwaggerConfig                   `json:"swagger,omitempty" typescript:",notnull"`LoggingLoggingConfig                   `json:"logging,omitempty" typescript:",notnull"`DangerousDangerousConfig                 `json:"dangerous,omitempty" typescript:",notnull"`DisablePathAppsclibase.Bool                    `json:"disable_path_apps,omitempty" typescript:",notnull"`SessionDurationclibase.Duration                `json:"max_session_expiry,omitempty" typescript:",notnull"`DisableSessionExpiryRefreshclibase.Bool                    `json:"disable_session_expiry_refresh,omitempty" typescript:",notnull"`DisablePasswordAuthclibase.Bool                    `json:"disable_password_auth,omitempty" typescript:",notnull"`SupportSupportConfig                   `json:"support,omitempty" typescript:",notnull"`GitAuthProvidersclibase.Struct[[]GitAuthConfig] `json:"git_auth,omitempty" typescript:",notnull"`SSHConfigSSHConfig                       `json:"config_ssh,omitempty" typescript:",notnull"`WgtunnelHostclibase.String                  `json:"wgtunnel_host,omitempty" typescript:",notnull"`DisableOwnerWorkspaceExecclibase.Bool                    `json:"disable_owner_workspace_exec,omitempty" typescript:",notnull"`ProxyHealthStatusIntervalclibase.Duration                `json:"proxy_health_status_interval,omitempty" typescript:",notnull"`EnableTerraformDebugModeclibase.Bool                    `json:"enable_terraform_debug_mode,omitempty" typescript:",notnull"`UserQuietHoursScheduleUserQuietHoursScheduleConfig    `json:"user_quiet_hours_schedule,omitempty" typescript:",notnull"`Configclibase.YAMLConfigPath `json:"config,omitempty" typescript:",notnull"`WriteConfigclibase.Bool           `json:"write_config,omitempty" typescript:",notnull"`// DEPRECATED: Use HTTPAddress or TLS.Address instead.Addressclibase.HostPort `json:"address,omitempty" typescript:",notnull"`}

func (*DeploymentValues)Options¶added inv0.19.0

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

func (*DeploymentValues)WithoutSecrets¶added inv0.19.0

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

WithoutSecrets returns a copy of the config without secret values.

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

type Entitlementstring

type Entitlements struct {Features         map[FeatureName]Feature `json:"features"`Warnings         []string                `json:"warnings"`Errors           []string                `json:"errors"`HasLicensebool                    `json:"has_license"`Trialbool                    `json:"trial"`RequireTelemetrybool                    `json:"require_telemetry"`}

type Error struct {ResponseHelperstring// contains filtered or unexported fields}

funcAsError¶added inv0.9.9

func AsError(errerror) (*Error,bool)

func (*Error)Error¶

func (e *Error) Error()string

func (*Error)Friendly¶added inv0.8.0

func (e *Error) Friendly()string

func (*Error)StatusCode¶

func (e *Error) StatusCode()int

type Experimentstring

type Experiments []Experiment

func (Experiments)Enabled¶added inv0.15.0

func (eExperiments) Enabled(exExperiment)bool

type Feature struct {EntitlementEntitlement `json:"entitlement"`Enabledbool        `json:"enabled"`Limit       *int64      `json:"limit,omitempty"`Actual      *int64      `json:"actual,omitempty"`}

type FeatureNamestring

func (FeatureName)AlwaysEnable¶added inv0.15.0

func (nFeatureName) 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 inv0.15.0

func (nFeatureName) Humanize()string

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

type GenerateAPIKeyResponse struct {Keystring `json:"key"`}

type GetUsersResponse struct {Users []User `json:"users"`Countint    `json:"count"`}

type GitAuth struct {Authenticatedbool   `json:"authenticated"`Devicebool   `json:"device"`Typestring `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.AppInstallablebool `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.AppInstallURLstring `json:"app_install_url"`}

type GitAuthAppInstallation struct {IDint         `json:"id"`AccountGitAuthUser `json:"account"`ConfigureURLstring      `json:"configure_url"`}

type GitAuthConfig struct {IDstring   `json:"id"`Typestring   `json:"type"`ClientIDstring   `json:"client_id"`ClientSecretstring   `json:"-" yaml:"client_secret"`AuthURLstring   `json:"auth_url"`TokenURLstring   `json:"token_url"`ValidateURLstring   `json:"validate_url"`AppInstallURLstring   `json:"app_install_url"`AppInstallationsURLstring   `json:"app_installations_url"`Regexstring   `json:"regex"`NoRefreshbool     `json:"no_refresh"`Scopes              []string `json:"scopes"`DeviceFlowbool     `json:"device_flow"`DeviceCodeURLstring   `json:"device_code_url"`}

type GitAuthDevice struct {DeviceCodestring `json:"device_code"`UserCodestring `json:"user_code"`VerificationURIstring `json:"verification_uri"`ExpiresInint    `json:"expires_in"`Intervalint    `json:"interval"`}

type GitAuthDeviceExchange struct {DeviceCodestring `json:"device_code"`}

type GitAuthUser struct {Loginstring `json:"login"`AvatarURLstring `json:"avatar_url"`ProfileURLstring `json:"profile_url"`Namestring `json:"name"`}

type GitProviderstring

func (GitProvider)Pretty¶added inv0.18.0

func (gGitProvider) Pretty()string

type GitSSHKey struct {UserIDuuid.UUID `json:"user_id" format:"uuid"`CreatedAttime.Time `json:"created_at" format:"date-time"`UpdatedAttime.Time `json:"updated_at" format:"date-time"`PublicKeystring    `json:"public_key"`}

type Group struct {IDuuid.UUID `json:"id" format:"uuid"`Namestring    `json:"name"`OrganizationIDuuid.UUID `json:"organization_id" format:"uuid"`Members        []User    `json:"members"`AvatarURLstring    `json:"avatar_url"`QuotaAllowanceint       `json:"quota_allowance"`}

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

type InsightsReportIntervalstring

const (InsightsReportIntervalDayInsightsReportInterval = "day")

InsightsReportInterval enums.

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

type IssueReconnectingPTYSignedTokenResponse struct {SignedTokenstring `json:"signed_token"`}

type JobErrorCodestring

type License struct {IDint32     `json:"id"`UUIDuuid.UUID `json:"uuid" format:"uuid"`UploadedAttime.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 inv0.26.1

func (l *License) AllFeaturesClaim()bool

func (*License)ExpiresAt¶added inv0.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 inv0.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 inv0.26.1

func (l *License) Trial()bool

type LinkConfig struct {Namestring `json:"name" yaml:"name"`Targetstring `json:"target" yaml:"target"`Iconstring `json:"icon" yaml:"icon"`}

type LogLevelstring

type LogSourcestring

type LoggingConfig struct {Humanclibase.String `json:"human" typescript:",notnull"`JSONclibase.String `json:"json" typescript:",notnull"`Stackdriverclibase.String `json:"stackdriver" typescript:",notnull"`}

type LoginTypestring

type LoginWithPasswordRequest struct {Emailstring `json:"email" validate:"required,email" format:"email"`Passwordstring `json:"password" validate:"required"`}

type LoginWithPasswordResponse struct {SessionTokenstring `json:"session_token" validate:"required"`}

type NullTime struct {sql.NullTime}

funcNewNullTime¶added inv0.8.7

func NewNullTime(ttime.Time, validbool)NullTime

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

func (NullTime)IsZero¶added inv0.8.7

func (tNullTime) IsZero()bool

IsZero return true if the time is null or zero.

func (NullTime)MarshalJSON¶added inv0.8.7

func (tNullTime) MarshalJSON() ([]byte,error)

MarshalJSON implements json.Marshaler.

func (*NullTime)UnmarshalJSON¶added inv0.8.7

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

UnmarshalJSON implements json.Unmarshaler.

type OAuth2Config struct {GithubOAuth2GithubConfig `json:"github" typescript:",notnull"`}

type OAuth2GithubConfig struct {ClientIDclibase.String      `json:"client_id" typescript:",notnull"`ClientSecretclibase.String      `json:"client_secret" typescript:",notnull"`AllowedOrgsclibase.StringArray `json:"allowed_orgs" typescript:",notnull"`AllowedTeamsclibase.StringArray `json:"allowed_teams" typescript:",notnull"`AllowSignupsclibase.Bool        `json:"allow_signups" typescript:",notnull"`AllowEveryoneclibase.Bool        `json:"allow_everyone" typescript:",notnull"`EnterpriseBaseURLclibase.String      `json:"enterprise_base_url" typescript:",notnull"`}

type OAuthConversionResponse struct {StateStringstring    `json:"state_string"`ExpiresAttime.Time `json:"expires_at" format:"date-time"`ToTypeLoginType `json:"to_type"`UserIDuuid.UUID `json:"user_id" format:"uuid"`}

type OIDCAuthMethod struct {AuthMethodSignInTextstring `json:"signInText"`IconURLstring `json:"iconUrl"`}

type OIDCConfig struct {AllowSignupsclibase.Bool                      `json:"allow_signups" typescript:",notnull"`ClientIDclibase.String                    `json:"client_id" typescript:",notnull"`ClientSecretclibase.String                    `json:"client_secret" typescript:",notnull"`EmailDomainclibase.StringArray               `json:"email_domain" typescript:",notnull"`IssuerURLclibase.String                    `json:"issuer_url" typescript:",notnull"`Scopesclibase.StringArray               `json:"scopes" typescript:",notnull"`IgnoreEmailVerifiedclibase.Bool                      `json:"ignore_email_verified" typescript:",notnull"`UsernameFieldclibase.String                    `json:"username_field" typescript:",notnull"`EmailFieldclibase.String                    `json:"email_field" typescript:",notnull"`AuthURLParamsclibase.Struct[map[string]string] `json:"auth_url_params" typescript:",notnull"`IgnoreUserInfoclibase.Bool                      `json:"ignore_user_info" typescript:",notnull"`GroupFieldclibase.String                    `json:"groups_field" typescript:",notnull"`GroupMappingclibase.Struct[map[string]string] `json:"group_mapping" typescript:",notnull"`SignInTextclibase.String                    `json:"sign_in_text" typescript:",notnull"`IconURLclibase.URL                       `json:"icon_url" typescript:",notnull"`}

type Organization struct {IDuuid.UUID `json:"id" validate:"required" format:"uuid"`Namestring    `json:"name" validate:"required"`CreatedAttime.Time `json:"created_at" validate:"required" format:"date-time"`UpdatedAttime.Time `json:"updated_at" validate:"required" format:"date-time"`}

type OrganizationMember struct {UserIDuuid.UUID `db:"user_id" json:"user_id" format:"uuid"`OrganizationIDuuid.UUID `db:"organization_id" json:"organization_id" format:"uuid"`CreatedAttime.Time `db:"created_at" json:"created_at" format:"date-time"`UpdatedAttime.Time `db:"updated_at" json:"updated_at" format:"date-time"`Roles          []Role    `db:"roles" json:"roles"`}

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.AfterIDuuid.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.Limitint `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.Offsetint `json:"offset,omitempty"`}

type ParameterResolver struct {Rich []WorkspaceBuildParameter}

func (*ParameterResolver)ValidateResolve¶added inv0.23.6

func (r *ParameterResolver) ValidateResolve(pTemplateVersionParameter, v *WorkspaceBuildParameter) (valuestring, errerror)

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

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

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

type PatchWorkspaceProxy struct {IDuuid.UUID `json:"id" format:"uuid" validate:"required"`Namestring    `json:"name" validate:"required"`DisplayNamestring    `json:"display_name" validate:"required"`Iconstring    `json:"icon" validate:"required"`RegenerateTokenbool      `json:"regenerate_token"`}

type PprofConfig struct {Enableclibase.Bool     `json:"enable" typescript:",notnull"`Addressclibase.HostPort `json:"address" typescript:",notnull"`}

type PrometheusConfig struct {Enableclibase.Bool     `json:"enable" typescript:",notnull"`Addressclibase.HostPort `json:"address" typescript:",notnull"`CollectAgentStatsclibase.Bool     `json:"collect_agent_stats" typescript:",notnull"`CollectDBMetricsclibase.Bool     `json:"collect_db_metrics" typescript:",notnull"`}

type ProvisionerConfig struct {Daemonsclibase.Int64    `json:"daemons" typescript:",notnull"`DaemonsEchoclibase.Bool     `json:"daemons_echo" typescript:",notnull"`DaemonPollIntervalclibase.Duration `json:"daemon_poll_interval" typescript:",notnull"`DaemonPollJitterclibase.Duration `json:"daemon_poll_jitter" typescript:",notnull"`ForceCancelIntervalclibase.Duration `json:"force_cancel_interval" typescript:",notnull"`}

type ProvisionerDaemon struct {IDuuid.UUID         `json:"id" format:"uuid"`CreatedAttime.Time         `json:"created_at" format:"date-time"`UpdatedAtsql.NullTime      `json:"updated_at" format:"date-time"`Namestring            `json:"name"`Provisioners []ProvisionerType `json:"provisioners"`Tags         map[string]string `json:"tags"`}

type ProvisionerJob struct {IDuuid.UUID            `json:"id" format:"uuid"`CreatedAttime.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"`Errorstring               `json:"error,omitempty"`ErrorCodeJobErrorCode         `json:"error_code,omitempty" enums:"MISSING_TEMPLATE_PARAMETER,REQUIRED_TEMPLATE_VARIABLES"`StatusProvisionerJobStatus `json:"status" enums:"pending,running,succeeded,canceling,canceled,failed"`WorkerID      *uuid.UUID           `json:"worker_id,omitempty" format:"uuid"`FileIDuuid.UUID            `json:"file_id" format:"uuid"`Tags          map[string]string    `json:"tags"`QueuePositionint                  `json:"queue_position"`QueueSizeint                  `json:"queue_size"`}

type ProvisionerJobLog struct {IDint64     `json:"id"`CreatedAttime.Time `json:"created_at" format:"date-time"`SourceLogSource `json:"log_source"`LevelLogLevel  `json:"log_level" enums:"trace,debug,info,warn,error"`Stagestring    `json:"stage"`Outputstring    `json:"output"`}

type ProvisionerJobStatusstring

func (ProvisionerJobStatus)Active¶added inv0.4.4

func (pProvisionerJobStatus) Active()bool

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

type ProvisionerLogLevelstring

type ProvisionerStorageMethodstring

type ProvisionerTypestring

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

type ProxyHealthStatusstring

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

type RBACResourcestring

func (RBACResource)String¶added inv0.22.1

func (rRBACResource) String()string

type RateLimitConfig struct {DisableAllclibase.Bool  `json:"disable_all" typescript:",notnull"`APIclibase.Int64 `json:"api" typescript:",notnull"`}

type ReconnectingPTYRequest struct {Datastring `json:"data,omitempty"`Heightuint16 `json:"height,omitempty"`Widthuint16 `json:"width,omitempty"`}

type Region struct {IDuuid.UUID `json:"id" format:"uuid" table:"id"`Namestring    `json:"name" table:"name,default_sort"`DisplayNamestring    `json:"display_name" table:"display_name"`IconURLstring    `json:"icon_url" table:"icon_url"`Healthybool      `json:"healthy" table:"healthy"`// PathAppURL is the URL to the base path for path apps. Optional// unless wildcard_hostname is set.// E.g.https://us.example.comPathAppURLstring `json:"path_app_url" table:"url"`// WildcardHostname is the wildcard hostname for subdomain apps.// E.g. *.us.example.com// E.g. *--suffix.au.example.com// Optional. Does not need to be on the same domain as PathAppURL.WildcardHostnamestring `json:"wildcard_hostname" table:"wildcard_hostname"`}

type RegionTypes interface {Region |WorkspaceProxy}

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

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

type RequestOption func(*http.Request)

funcWithQueryParam¶added inv0.9.8

func WithQueryParam(key, valuestring)RequestOption

WithQueryParam adds a query parameter to the request.

type ResourceTypestring

func (ResourceType)FriendlyString¶added inv0.8.15

func (rResourceType) FriendlyString()string

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."Messagestring `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"Detailstring `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"`}

type Role struct {Namestring `json:"name"`DisplayNamestring `json:"display_name"`}

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

func (SSHConfig)ParseOptions¶added inv0.20.0

func (cSSHConfig) ParseOptions() (map[string]string,error)

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

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

type ServerSentEventTypestring

type ServiceBannerConfig struct {Enabledbool   `json:"enabled"`Messagestring `json:"message,omitempty"`BackgroundColorstring `json:"background_color,omitempty"`}

type SessionCountDeploymentStats struct {VSCodeint64 `json:"vscode"`SSHint64 `json:"ssh"`JetBrainsint64 `json:"jetbrains"`ReconnectingPTYint64 `json:"reconnecting_pty"`}

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

type SwaggerConfig struct {Enableclibase.Bool `json:"enable" typescript:",notnull"`}

type TLSConfig struct {Enableclibase.Bool        `json:"enable" typescript:",notnull"`Addressclibase.HostPort    `json:"address" typescript:",notnull"`RedirectHTTPclibase.Bool        `json:"redirect_http" typescript:",notnull"`CertFilesclibase.StringArray `json:"cert_file" typescript:",notnull"`ClientAuthclibase.String      `json:"client_auth" typescript:",notnull"`ClientCAFileclibase.String      `json:"client_ca_file" typescript:",notnull"`KeyFilesclibase.StringArray `json:"key_file" typescript:",notnull"`MinVersionclibase.String      `json:"min_version" typescript:",notnull"`ClientCertFileclibase.String      `json:"client_cert_file" typescript:",notnull"`ClientKeyFileclibase.String      `json:"client_key_file" typescript:",notnull"`}

type TelemetryConfig struct {Enableclibase.Bool `json:"enable" typescript:",notnull"`Traceclibase.Bool `json:"trace" typescript:",notnull"`URLclibase.URL  `json:"url" typescript:",notnull"`}

type Template struct {IDuuid.UUID       `json:"id" format:"uuid"`CreatedAttime.Time       `json:"created_at" format:"date-time"`UpdatedAttime.Time       `json:"updated_at" format:"date-time"`OrganizationIDuuid.UUID       `json:"organization_id" format:"uuid"`Namestring          `json:"name"`DisplayNamestring          `json:"display_name"`ProvisionerProvisionerType `json:"provisioner" enums:"terraform"`ActiveVersionIDuuid.UUID       `json:"active_version_id" format:"uuid"`// ActiveUserCount is set to -1 when loading.ActiveUserCountint                    `json:"active_user_count"`BuildTimeStatsTemplateBuildTimeStats `json:"build_time_stats"`Descriptionstring                 `json:"description"`Iconstring                 `json:"icon"`DefaultTTLMillisint64                  `json:"default_ttl_ms"`// TODO(@dean): remove max_ttl once restart_requirement is maturedMaxTTLMillisint64 `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.RestartRequirementTemplateRestartRequirement `json:"restart_requirement"`CreatedByIDuuid.UUID                  `json:"created_by_id" format:"uuid"`CreatedByNamestring                     `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.AllowUserAutostartbool `json:"allow_user_autostart"`AllowUserAutostopbool `json:"allow_user_autostop"`AllowUserCancelWorkspaceJobsbool `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.FailureTTLMillisint64 `json:"failure_ttl_ms"`InactivityTTLMillisint64 `json:"inactivity_ttl_ms"`LockedTTLMillisint64 `json:"locked_ttl_ms"`}

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

type TemplateAppUsage struct {TemplateIDs []uuid.UUID      `json:"template_ids" format:"uuid"`TypeTemplateAppsType `json:"type" example:"builtin"`DisplayNamestring           `json:"display_name" example:"Visual Studio Code"`Slugstring           `json:"slug" example:"vscode"`Iconstring           `json:"icon"`Secondsint64            `json:"seconds" example:"80500"`}

type TemplateAppsTypestring

const (TemplateAppsTypeBuiltinTemplateAppsType = "builtin")

TemplateAppsType enums.

type TemplateBuildTimeStats map[WorkspaceTransition]TransitionStats

type TemplateExample struct {IDstring   `json:"id" format:"uuid"`URLstring   `json:"url"`Namestring   `json:"name"`Descriptionstring   `json:"description"`Iconstring   `json:"icon"`Tags        []string `json:"tags"`Markdownstring   `json:"markdown"`}

type TemplateGroup struct {GroupRoleTemplateRole `json:"role" enums:"admin,use"`}

type TemplateInsightsIntervalReport struct {StartTimetime.Time              `json:"start_time" format:"date-time"`EndTimetime.Time              `json:"end_time" format:"date-time"`TemplateIDs []uuid.UUID            `json:"template_ids" format:"uuid"`IntervalInsightsReportInterval `json:"interval"`ActiveUsersint64                  `json:"active_users" example:"14"`}

type TemplateInsightsReport struct {StartTimetime.Time          `json:"start_time" format:"date-time"`EndTimetime.Time          `json:"end_time" format:"date-time"`TemplateIDs []uuid.UUID        `json:"template_ids" format:"uuid"`ActiveUsersint64              `json:"active_users" example:"22"`AppsUsage   []TemplateAppUsage `json:"apps_usage"`}

type TemplateInsightsRequest struct {StartTimetime.Time              `json:"start_time" format:"date-time"`EndTimetime.Time              `json:"end_time" format:"date-time"`TemplateIDs []uuid.UUID            `json:"template_ids" format:"uuid"`IntervalInsightsReportInterval `json:"interval"`}

type TemplateInsightsResponse struct {ReportTemplateInsightsReport           `json:"report"`IntervalReports []TemplateInsightsIntervalReport `json:"interval_reports"`}

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.Weeksint64 `json:"weeks"`}

type TemplateRolestring

type TemplateUser struct {UserRoleTemplateRole `json:"role" enums:"admin,use"`}

type TemplateVersion struct {IDuuid.UUID      `json:"id" format:"uuid"`TemplateID     *uuid.UUID     `json:"template_id,omitempty" format:"uuid"`OrganizationIDuuid.UUID      `json:"organization_id,omitempty" format:"uuid"`CreatedAttime.Time      `json:"created_at" format:"date-time"`UpdatedAttime.Time      `json:"updated_at" format:"date-time"`Namestring         `json:"name"`Messagestring         `json:"message"`JobProvisionerJob `json:"job"`Readmestring         `json:"readme"`CreatedByUser           `json:"created_by"`Warnings []TemplateVersionWarning `json:"warnings,omitempty" enums:"DEPRECATED_PARAMETERS"`}

type TemplateVersionGitAuth struct {IDstring      `json:"id"`TypeGitProvider `json:"type"`AuthenticateURLstring      `json:"authenticate_url"`Authenticatedbool        `json:"authenticated"`}

type TemplateVersionParameter struct {Namestring                           `json:"name"`DisplayNamestring                           `json:"display_name,omitempty"`Descriptionstring                           `json:"description"`DescriptionPlaintextstring                           `json:"description_plaintext"`Typestring                           `json:"type" enums:"string,number,bool,list(string)"`Mutablebool                             `json:"mutable"`DefaultValuestring                           `json:"default_value"`Iconstring                           `json:"icon"`Options              []TemplateVersionParameterOption `json:"options"`ValidationErrorstring                           `json:"validation_error,omitempty"`ValidationRegexstring                           `json:"validation_regex,omitempty"`ValidationMin        *int32                           `json:"validation_min,omitempty"`ValidationMax        *int32                           `json:"validation_max,omitempty"`ValidationMonotonicValidationMonotonicOrder         `json:"validation_monotonic,omitempty" enums:"increasing,decreasing"`Requiredbool                             `json:"required"`Ephemeralbool                             `json:"ephemeral"`}

type TemplateVersionParameterOption struct {Namestring `json:"name"`Descriptionstring `json:"description"`Valuestring `json:"value"`Iconstring `json:"icon"`}

type TemplateVersionVariable struct {Namestring `json:"name"`Descriptionstring `json:"description"`Typestring `json:"type" enums:"string,number,bool"`Valuestring `json:"value"`DefaultValuestring `json:"default_value"`Requiredbool   `json:"required"`Sensitivebool   `json:"sensitive"`}

type TemplateVersionWarningstring

type TemplateVersionsByTemplateRequest struct {TemplateIDuuid.UUID `json:"template_id" validate:"required" format:"uuid"`Pagination}

type TokenConfig struct {MaxTokenLifetimetime.Duration `json:"max_token_lifetime"`}

type TokensFilter struct {IncludeAllbool `json:"include_all"`}

type TraceConfig struct {Enableclibase.Bool   `json:"enable" typescript:",notnull"`HoneycombAPIKeyclibase.String `json:"honeycomb_api_key" typescript:",notnull"`CaptureLogsclibase.Bool   `json:"capture_logs" typescript:",notnull"`}

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

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

type UpdateAppearanceConfig struct {LogoURLstring              `json:"logo_url"`ServiceBannerServiceBannerConfig `json:"service_banner"`}

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

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

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 struct {Namestring `json:"name,omitempty" validate:"omitempty,template_name"`DisplayNamestring `json:"display_name,omitempty" validate:"omitempty,template_display_name"`Descriptionstring `json:"description,omitempty"`Iconstring `json:"icon,omitempty"`DefaultTTLMillisint64  `json:"default_ttl_ms,omitempty"`// TODO(@dean): remove max_ttl once restart_requirement is maturedMaxTTLMillisint64 `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"`AllowUserAutostartbool                        `json:"allow_user_autostart,omitempty"`AllowUserAutostopbool                        `json:"allow_user_autostop,omitempty"`AllowUserCancelWorkspaceJobsbool                        `json:"allow_user_cancel_workspace_jobs,omitempty"`FailureTTLMillisint64                       `json:"failure_ttl_ms,omitempty"`InactivityTTLMillisint64                       `json:"inactivity_ttl_ms,omitempty"`LockedTTLMillisint64                       `json:"locked_ttl_ms,omitempty"`}

type UpdateUserPasswordRequest struct {OldPasswordstring `json:"old_password" validate:""`Passwordstring `json:"password" validate:"required"`}

type UpdateUserProfileRequest struct {Usernamestring `json:"username" validate:"required,username"`}

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.Schedulestring `json:"schedule" validate:"required"`}

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

type UpdateWorkspaceLock struct {Lockbool `json:"lock"`}

type UpdateWorkspaceProxyResponse struct {ProxyWorkspaceProxy `json:"proxy" table:"proxy,recursive"`// The recursive table sort is not working very well.ProxyTokenstring `json:"proxy_token" table:"proxy token,default_sort"`}

type UpdateWorkspaceRequest struct {Namestring `json:"name,omitempty" validate:"username"`}

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

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

type User struct {IDuuid.UUID `json:"id" validate:"required" table:"id" format:"uuid"`Usernamestring    `json:"username" validate:"required" table:"username,default_sort"`Emailstring    `json:"email" validate:"required" table:"email" format:"email"`CreatedAttime.Time `json:"created_at" validate:"required" table:"created at" format:"date-time"`LastSeenAttime.Time `json:"last_seen_at" format:"date-time"`StatusUserStatus  `json:"status" table:"status" enums:"active,suspended"`OrganizationIDs []uuid.UUID `json:"organization_ids" format:"uuid"`Roles           []Role      `json:"roles"`AvatarURLstring      `json:"avatar_url" format:"uri"`}

type UserLatency struct {TemplateIDs []uuid.UUID       `json:"template_ids" format:"uuid"`UserIDuuid.UUID         `json:"user_id" format:"uuid"`Usernamestring            `json:"username"`LatencyMSConnectionLatency `json:"latency_ms"`}

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

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

type UserLatencyInsightsResponse struct {ReportUserLatencyInsightsReport `json:"report"`}

type UserLoginType struct {LoginTypeLoginType `json:"login_type"`}

type UserQuietHoursScheduleConfig struct {DefaultScheduleclibase.String `json:"default_schedule" typescript:",notnull"`}

type UserQuietHoursScheduleResponse struct {RawSchedulestring `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.UserSetbool `json:"user_set"`// Time is the time of day that the quiet hours window starts in the given// Timezone each day.Timestring `json:"time"`// HH:mm (24-hour)Timezonestring `json:"timezone"`// raw format from the cron expression, UTC if unspecified// Next is the next time that the quiet hours window will start.Nexttime.Time `json:"next" format:"date-time"`}

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

type UserStatusstring

type UsersRequest struct {Searchstring `json:"search,omitempty" typescript:"-"`// Filter users by status.StatusUserStatus `json:"status,omitempty" typescript:"-"`// Filter users that have the given role.Rolestring `json:"role,omitempty" typescript:"-"`SearchQuerystring `json:"q,omitempty"`Pagination}

type ValidationError struct {Fieldstring `json:"field" validate:"required"`Detailstring `json:"detail" validate:"required"`}

func (ValidationError)Error¶added inv0.8.2