codersdk

package
v0.12.6 Latest Latest
Warning

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

 Go to latest Published: Nov 10, 2022 License: AGPL-3.0 Imports: 38 Imported by: 2

Documentation

Index

Constants

View Source 
const (
	// SessionTokenKey represents the name of the cookie or query parameter the API key is stored in.
	SessionTokenKey = "coder_session_token"
	// SessionCustomHeader is the custom header to use for authentication.
	SessionCustomHeader = "Coder-Session-Token"
	OAuth2StateKey      = "oauth_state"
	OAuth2RedirectKey   = "oauth_redirect"

	// nolint: gosec
	BypassRatelimitHeader = "X-Coder-Bypass-Ratelimit"
)

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 (
	FeatureUserLimit        = "user_limit"
	FeatureAuditLog         = "audit_log"
	FeatureBrowserOnly      = "browser_only"
	FeatureSCIM             = "scim"
	FeatureWorkspaceQuota   = "workspace_quota"
	FeatureTemplateRBAC     = "template_rbac"
	FeatureHighAvailability = "high_availability"
	FeatureMultipleGitAuth  = "multiple_git_auth"
)
View Source 
const (
	GitProviderAzureDevops = "azure-devops"
	GitProviderGitHub      = "github"
	GitProviderGitLab      = "gitlab"
	GitProviderBitBucket   = "bitbucket"
)
View Source 
const (
	ContentTypeTar = "application/x-tar"
)

Variables

View Source 
var (
	// TailnetIP 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.
	TailnetIP                  = netip.MustParseAddr("fd7a:115c:a1e0:49d6:b259:b7ac:b1b2:48f4")
	TailnetSSHPort             = 1
	TailnetReconnectingPTYPort = 2
	TailnetSpeedtestPort       = 3
	// TailnetStatisticsPort serves a HTTP server with endpoints for gathering
	// agent statistics.
	TailnetStatisticsPort = 4

	// MinimumListeningPort 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.
	MinimumListeningPort = 9
)
View Source 
var FeatureNames = []string{
	FeatureUserLimit,
	FeatureAuditLog,
	FeatureBrowserOnly,
	FeatureSCIM,
	FeatureWorkspaceQuota,
	FeatureTemplateRBAC,
	FeatureHighAvailability,
	FeatureMultipleGitAuth,
}
View Source 
var IgnoredListeningPorts = 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: {},
}

IgnoredListeningPorts contains a list of ports in the global ignore list. This list contains common TCP ports that are not HTTP servers, such as databases, SSH, FTP, etc.

This is implemented as a map for fast lookup.

View Source 
var Me = "me"

Me is used as a replacement for your own ID.

Functions

func IsConnectionErr added in v0.8.1 

func IsConnectionErr(err error) bool

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

func ServerSentEventReader added in v0.9.0 

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

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.

Types

type APIKey added in v0.7.6 

type APIKey struct {
	ID string `json:"id" validate:"required"`
	// NOTE: do not ever return the HashedSecret
	UserID          uuid.UUID   `json:"user_id" validate:"required"`
	LastUsed        time.Time   `json:"last_used" validate:"required"`
	ExpiresAt       time.Time   `json:"expires_at" validate:"required"`
	CreatedAt       time.Time   `json:"created_at" validate:"required"`
	UpdatedAt       time.Time   `json:"updated_at" validate:"required"`
	LoginType       LoginType   `json:"login_type" validate:"required"`
	Scope           APIKeyScope `json:"scope" validate:"required"`
	LifetimeSeconds int64       `json:"lifetime_seconds" validate:"required"`
}

type APIKeyScope added in v0.10.0 

type APIKeyScope string
const (
	APIKeyScopeAll                APIKeyScope = "all"
	APIKeyScopeApplicationConnect APIKeyScope = "application_connect"
)

type AWSInstanceIdentityToken 

type AWSInstanceIdentityToken struct {
	Signature string `json:"signature" validate:"required"`
	Document  string `json:"document" validate:"required"`
}

@typescript-ignore AWSInstanceIdentityToken

type AddLicenseRequest added in v0.8.7 

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

type AgentConn added in v0.9.0 

type AgentConn struct {
	*tailnet.Conn
	CloseFunc func()
}

@typescript-ignore AgentConn

func (*AgentConn) Close added in v0.9.0 

func (c *AgentConn) Close() error

func (*AgentConn) CloseWithError added in v0.9.0 

func (c *AgentConn) CloseWithError(_ error) error

func (*AgentConn) DialContext added in v0.9.0 

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

func (*AgentConn) ListeningPorts added in v0.9.5 

func (c *AgentConn) ListeningPorts(ctx context.Context) (ListeningPortsResponse, error)

func (*AgentConn) Ping added in v0.9.0 

func (c *AgentConn) Ping(ctx context.Context) (time.Duration, error)

func (*AgentConn) ReconnectingPTY added in v0.9.0 

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

func (*AgentConn) SSH added in v0.9.0 

func (c *AgentConn) SSH(ctx context.Context) (net.Conn, error)

func (*AgentConn) SSHClient added in v0.9.0 

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

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

func (*AgentConn) Speedtest added in v0.9.0 

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

type AgentGitSSHKey added in v0.4.0 

type AgentGitSSHKey struct {
	PublicKey  string `json:"public_key"`
	PrivateKey string `json:"private_key"`
}

type AgentStats added in v0.9.0 

type AgentStats struct {
	NumConns int64 `json:"num_comms"`
	RxBytes  int64 `json:"rx_bytes"`
	TxBytes  int64 `json:"tx_bytes"`
}

Stats records the Agent's network connection statistics for use in user-facing metrics and debugging. Each member value must be written and read with atomic. @typescript-ignore AgentStats

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 received bytes.
	TxBytes int64 `json:"tx_bytes"`
}

AgentStatsReportResponse is returned for each report request by the agent.

type AssignableRoles added in v0.8.6 

type AssignableRoles struct {
	Role
	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"
)

func (AuditAction) FriendlyString added in v0.8.15 

func (a AuditAction) FriendlyString() 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"`
	RequestID      uuid.UUID    `json:"request_id"`
	Time           time.Time    `json:"time"`
	OrganizationID uuid.UUID    `json:"organization_id"`
	IP             netip.Addr   `json:"ip"`
	UserAgent      string       `json:"user_agent"`
	ResourceType   ResourceType `json:"resource_type"`
	ResourceID     uuid.UUID    `json:"resource_id"`
	// 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"`

	User *User `json:"user"`
}

type AuditLogCountRequest added in v0.9.0 

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

type AuditLogCountResponse added in v0.8.14 

type AuditLogCountResponse struct {
	Count int64 `json:"count"`
}

type AuditLogResponse added in v0.8.14 

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

type AuditLogsRequest added in v0.9.0 

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

type AuthMethods added in v0.4.4 

type AuthMethods struct {
	Password bool `json:"password"`
	Github   bool `json:"github"`
	OIDC     bool `json:"oidc"`
}

AuthMethods contains whether authentication types are enabled or not.

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
	//	- 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 can be 'create', 'read', 'update', or 'delete'
	Action string `json:"action"`
}

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 string `json:"resource_type"`
	// OwnerID (optional) is a user_id. It adds the set constraint to all resources owned
	// by a given user.
	OwnerID string `json:"owner_id,omitempty"`
	// OrganizationID (optional) is an organization_id. It 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 'OwnerID' and 'OrganizationID'
	// if possible. Be as specific as possible using all the fields relevant.
	ResourceID string `json:"resource_id,omitempty"`
}

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 AzureInstanceIdentityToken added in v0.4.4 

type AzureInstanceIdentityToken struct {
	Signature string `json:"signature" validate:"required"`
	Encoding  string `json:"encoding" validate:"required"`
}

@typescript-ignore ReconnectingPTYRequest

type BuildInfoResponse added in v0.4.1 

type BuildInfoResponse struct {
	// ExternalURL is a URL referencing 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"`
}

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

	// Logger can be provided to log requests. Request method, URL and response
	// status code will be logged by default.
	Logger slog.Logger
	// LogBodies determines whether the request and response bodies are logged
	// to the provided Logger. This is useful for debugging or testing.
	LogBodies bool

	// BypassRatelimits is an optional flag that can be set by the site owner to
	// disable ratelimit checks for the client.
	BypassRatelimits bool

	// PropagateTracing is an optional flag that can be set to propagate tracing
	// spans to the Coder API. This is useful for seeing the entire request
	// from end-to-end.
	PropagateTracing 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) AddLicense added in v0.8.7 

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

func (*Client) AgentGitSSHKey added in v0.4.0 

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

AgentGitSSHKey will return the user's SSH key pair for the workspace.

func (*Client) AgentReportStats added in v0.8.12 

func (c *Client) AgentReportStats(
	ctx context.Context,
	log slog.Logger,
	stats func() *AgentStats,
) (io.Closer, error)

AgentReportStats begins a stat streaming connection with the Coder server. It is resilient to network failures and intermittent coderd issues.

func (*Client) AuditLogCount added in v0.8.14 

func (c *Client) AuditLogCount(ctx context.Context, req AuditLogCountRequest) (AuditLogCountResponse, error)

AuditLogCount returns the count of all audit logs in the product.

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) 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) AuthWorkspaceAWSInstanceIdentity 

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

AuthWorkspaceAWSInstanceIdentity uses the Amazon Metadata API to fetch a signed payload, and exchange it for a session token for a workspace agent.

The requesting instance must be registered as a resource in the latest history for a workspace.

func (*Client) AuthWorkspaceAzureInstanceIdentity added in v0.4.4 

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

AuthWorkspaceAzureInstanceIdentity uses the Azure Instance Metadata Service to fetch a signed payload, and exchange it for a session token for a workspace agent.

func (*Client) AuthWorkspaceGoogleInstanceIdentity 

func (c *Client) AuthWorkspaceGoogleInstanceIdentity(ctx context.Context, serviceAccount string, gcpClient *metadata.Client) (WorkspaceAgentAuthenticateResponse, error)

AuthWorkspaceGoogleInstanceIdentity uses the Google Compute Engine Metadata API to fetch a signed JWT, and exchange it for a session token for a workspace agent.

The requesting instance must be registered as a resource in the latest history for a workspace.

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) CheckAuthorization added in v0.9.0 

func (c *Client) CheckAuthorization(ctx context.Context, req AuthorizationRequest) (AuthorizationResponse, error)

func (*Client) Clone added in v0.12.6 

func (c *Client) Clone() *Client

func (*Client) CreateAPIKey 

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

CreateAPIKey generates an API key for the user ID provided. DEPRECATED: use CreateToken instead.

func (*Client) CreateFirstUser 

func (c *Client) CreateFirstUser(ctx context.Context, req CreateFirstUserRequest) (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 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) CreateParameter 

func (c *Client) CreateParameter(ctx context.Context, scope ParameterScope, id uuid.UUID, req CreateParameterRequest) (Parameter, error)

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

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 that doesn't expire.

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) 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) DeleteParameter 

func (c *Client) DeleteParameter(ctx context.Context, scope ParameterScope, id uuid.UUID, name string) 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) 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) DialWorkspaceAgent 

func (c *Client) DialWorkspaceAgent(ctx context.Context, agentID uuid.UUID, options *DialWorkspaceAgentOptions) (*AgentConn, 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) GetAPIKey added in v0.7.6 

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

GetAPIKey returns the api key by id.

func (*Client) GetAppHost added in v0.9.0 

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

GetAppHost returns the site-wide application wildcard hostname without the leading "*.", 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) GetTokens added in v0.9.7 

func (c *Client) GetTokens(ctx context.Context, userID string) ([]APIKey, error)

GetTokens list machine API keys.

func (*Client) GetUserRoles added in v0.5.2 

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

GetUserRoles returns all roles the user has

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) 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) ListenWorkspaceAgent 

func (c *Client) ListenWorkspaceAgent(ctx context.Context) (net.Conn, error)

func (*Client) LoginWithPassword 

func (c *Client) LoginWithPassword(ctx context.Context, req LoginWithPasswordRequest) (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(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) Parameters 

func (c *Client) Parameters(ctx context.Context, scope ParameterScope, id uuid.UUID) ([]Parameter, error)

func (*Client) PatchGroup added in v0.9.9 

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

func (*Client) PostWorkspaceAgentAppHealth added in v0.9.0 

func (c *Client) PostWorkspaceAgentAppHealth(ctx context.Context, req PostWorkspaceAppHealthsRequest) error

PostWorkspaceAgentAppHealth updates the workspace agent app health status.

func (*Client) PostWorkspaceAgentVersion added in v0.8.11 

func (c *Client) PostWorkspaceAgentVersion(ctx context.Context, version string) 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) 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) SessionToken 

func (c *Client) SessionToken() string

func (*Client) SetSessionToken added in v0.12.6 

func (c *Client) SetSessionToken(token string)

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) (*TemplateDAUsResponse, error)

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) 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) TemplateVersionDryRunLogsBefore added in v0.6.1 

func (c *Client) TemplateVersionDryRunLogsBefore(ctx context.Context, version, job uuid.UUID, before int64) ([]ProvisionerJobLog, error)

TemplateVersionDryRunLogsBefore returns logs for a template version dry-run that occurred before 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) 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) TemplateVersionLogsBefore added in v0.4.0 

func (c *Client) TemplateVersionLogsBefore(ctx context.Context, version uuid.UUID, before int64) ([]ProvisionerJobLog, error)

TemplateVersionLogsBefore returns logs that occurred before a specific log ID.

func (*Client) TemplateVersionParameters added in v0.4.0 

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

TemplateVersionParameters returns computed parameters for a template version.

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) TemplateVersionSchema added in v0.4.0 

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

TemplateVersionSchema returns schemas for a template version by ID.

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) 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) 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) 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) 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) 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, content []byte) (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) UserCount added in v0.12.6 

func (c *Client) UserCount(ctx context.Context, req UserCountRequest) (UserCountResponse, error)

func (*Client) Users added in v0.4.4 

func (c *Client) Users(ctx context.Context, req UsersRequest) ([]User, 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) 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) WorkspaceAgentGitAuth added in v0.11.0 

func (c *Client) WorkspaceAgentGitAuth(ctx context.Context, gitURL string, listen bool) (WorkspaceAgentGitAuthResponse, error)

WorkspaceAgentGitAuth submits a URL to fetch a GIT_ASKPASS username and password for. nolint:revive

func (*Client) WorkspaceAgentListeningPorts added in v0.9.5 

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

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

func (*Client) WorkspaceAgentMetadata added in v0.8.11 

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

WorkspaceAgentMetadata fetches metadata for the currently authenticated workspace agent.

func (*Client) WorkspaceAgentReconnectingPTY added in v0.5.2 

func (c *Client) WorkspaceAgentReconnectingPTY(ctx context.Context, agentID, reconnect uuid.UUID, height, width int, command string) (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) 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) WorkspaceBuildLogsBefore 

func (c *Client) WorkspaceBuildLogsBefore(ctx context.Context, build uuid.UUID, before int64) ([]ProvisionerJobLog, error)

WorkspaceBuildLogsBefore returns logs that occurred before a specific log ID.

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) 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 ComputedParameter added in v0.7.2 

type ComputedParameter struct {
	Parameter
	SourceValue        string    `json:"source_value"`
	SchemaID           uuid.UUID `json:"schema_id"`
	DefaultSourceValue bool      `json:"default_source_value"`
}

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"`
	OrganizationName string `json:"organization" validate:"required,username"`
}

type CreateFirstUserResponse 

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

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

type CreateOrganizationRequest 

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

type CreateParameterRequest 

type CreateParameterRequest struct {
	// CloneID allows copying the value of another parameter.
	// The other param must be related to the same template_id for this to
	// succeed.
	// No other fields are required if using this, as all fields will be copied
	// from the other parameter.
	CloneID uuid.UUID `json:"copy_from_parameter,omitempty" validate:""`

	Name              string                     `json:"name" validate:"required"`
	SourceValue       string                     `json:"source_value" validate:"required"`
	SourceScheme      ParameterSourceScheme      `json:"source_scheme" validate:"oneof=data,required"`
	DestinationScheme ParameterDestinationScheme `json:"destination_scheme" validate:"oneof=environment_variable provisioner_variable,required"`
}

CreateParameterRequest is used to create a new parameter value for a scope.

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"`
	ParameterValues []CreateParameterRequest `json:"parameter_values,omitempty"`

	// DefaultTTLMillis allows optionally specifying the default TTL
	// for all workspaces created from this template.
	DefaultTTLMillis *int64 `json:"default_ttl_ms,omitempty"`
}

CreateTemplateRequest provides options when creating a template.

type CreateTemplateVersionDryRunRequest added in v0.6.1 

type CreateTemplateVersionDryRunRequest struct {
	WorkspaceName   string                   `json:"workspace_name"`
	ParameterValues []CreateParameterRequest `json:"parameter_values"`
}

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_name"`
	// TemplateID optionally associates a version with a template.
	TemplateID uuid.UUID `json:"template_id,omitempty"`

	StorageMethod ProvisionerStorageMethod `json:"storage_method" validate:"oneof=file,required"`
	FileID        uuid.UUID                `json:"file_id" validate:"required"`
	Provisioner   ProvisionerType          `json:"provisioner" validate:"oneof=terraform echo,required"`
	// ParameterValues allows for additional parameters to be provided
	// during the dry-run provision stage.
	ParameterValues []CreateParameterRequest `json:"parameter_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"`
	ResourceType ResourceType `json:"resource_type,omitempty"`
	ResourceID   uuid.UUID    `json:"resource_id,omitempty"`
	Time         time.Time    `json:"time,omitempty"`
}

type CreateTokenRequest added in v0.10.0 

type CreateTokenRequest struct {
	Scope APIKeyScope `json:"scope"`
}

type CreateUserRequest 

type CreateUserRequest struct {
	Email          string    `json:"email" validate:"required,email"`
	Username       string    `json:"username" validate:"required,username"`
	Password       string    `json:"password" validate:"required"`
	OrganizationID uuid.UUID `json:"organization_id" validate:"required"`
}

type CreateWorkspaceBuildRequest 

type CreateWorkspaceBuildRequest struct {
	TemplateVersionID uuid.UUID           `json:"template_version_id,omitempty"`
	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.
	ParameterValues []CreateParameterRequest `json:"parameter_values,omitempty"`
}

CreateWorkspaceBuildRequest provides options to update the latest workspace build.

type CreateWorkspaceRequest 

type CreateWorkspaceRequest struct {
	TemplateID        uuid.UUID `json:"template_id" validate:"required"`
	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.
	ParameterValues []CreateParameterRequest `json:"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"`
	Amount int       `json:"amount"`
}

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 {
	URL  *DeploymentConfigField[string] `json:"url" typescript:",notnull"`
	Path *DeploymentConfigField[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        *DeploymentConfigField[bool]     `json:"enable" typescript:",notnull"`
	RegionID      *DeploymentConfigField[int]      `json:"region_id" typescript:",notnull"`
	RegionCode    *DeploymentConfigField[string]   `json:"region_code" typescript:",notnull"`
	RegionName    *DeploymentConfigField[string]   `json:"region_name" typescript:",notnull"`
	STUNAddresses *DeploymentConfigField[[]string] `json:"stun_addresses" typescript:",notnull"`
	RelayURL      *DeploymentConfigField[string]   `json:"relay_url" typescript:",notnull"`
}

type DeploymentConfig added in v0.11.0 

type DeploymentConfig struct {
	AccessURL                   *DeploymentConfigField[string]          `json:"access_url" typescript:",notnull"`
	WildcardAccessURL           *DeploymentConfigField[string]          `json:"wildcard_access_url" typescript:",notnull"`
	Address                     *DeploymentConfigField[string]          `json:"address" typescript:",notnull"`
	AutobuildPollInterval       *DeploymentConfigField[time.Duration]   `json:"autobuild_poll_interval" typescript:",notnull"`
	DERP                        *DERP                                   `json:"derp" typescript:",notnull"`
	GitAuth                     *DeploymentConfigField[[]GitAuthConfig] `json:"gitauth" typescript:",notnull"`
	Prometheus                  *PrometheusConfig                       `json:"prometheus" typescript:",notnull"`
	Pprof                       *PprofConfig                            `json:"pprof" typescript:",notnull"`
	ProxyTrustedHeaders         *DeploymentConfigField[[]string]        `json:"proxy_trusted_headers" typescript:",notnull"`
	ProxyTrustedOrigins         *DeploymentConfigField[[]string]        `json:"proxy_trusted_origins" typescript:",notnull"`
	CacheDirectory              *DeploymentConfigField[string]          `json:"cache_directory" typescript:",notnull"`
	InMemoryDatabase            *DeploymentConfigField[bool]            `json:"in_memory_database" typescript:",notnull"`
	PostgresURL                 *DeploymentConfigField[string]          `json:"pg_connection_url" typescript:",notnull"`
	OAuth2                      *OAuth2Config                           `json:"oauth2" typescript:",notnull"`
	OIDC                        *OIDCConfig                             `json:"oidc" typescript:",notnull"`
	Telemetry                   *TelemetryConfig                        `json:"telemetry" typescript:",notnull"`
	TLS                         *TLSConfig                              `json:"tls" typescript:",notnull"`
	Trace                       *TraceConfig                            `json:"trace" typescript:",notnull"`
	SecureAuthCookie            *DeploymentConfigField[bool]            `json:"secure_auth_cookie" typescript:",notnull"`
	SSHKeygenAlgorithm          *DeploymentConfigField[string]          `json:"ssh_keygen_algorithm" typescript:",notnull"`
	AutoImportTemplates         *DeploymentConfigField[[]string]        `json:"auto_import_templates" typescript:",notnull"`
	MetricsCacheRefreshInterval *DeploymentConfigField[time.Duration]   `json:"metrics_cache_refresh_interval" typescript:",notnull"`
	AgentStatRefreshInterval    *DeploymentConfigField[time.Duration]   `json:"agent_stat_refresh_interval" typescript:",notnull"`
	AuditLogging                *DeploymentConfigField[bool]            `json:"audit_logging" typescript:",notnull"`
	BrowserOnly                 *DeploymentConfigField[bool]            `json:"browser_only" typescript:",notnull"`
	SCIMAPIKey                  *DeploymentConfigField[string]          `json:"scim_api_key" typescript:",notnull"`
	UserWorkspaceQuota          *DeploymentConfigField[int]             `json:"user_workspace_quota" typescript:",notnull"`
	Provisioner                 *ProvisionerConfig                      `json:"provisioner" typescript:",notnull"`
	APIRateLimit                *DeploymentConfigField[int]             `json:"api_rate_limit" typescript:",notnull"`
	Experimental                *DeploymentConfigField[bool]            `json:"experimental" typescript:",notnull"`
}

DeploymentConfig is the central configuration for the coder server.

type DeploymentConfigField added in v0.11.0 

type DeploymentConfigField[T Flaggable] struct {
	Name       string `json:"name"`
	Usage      string `json:"usage"`
	Flag       string `json:"flag"`
	Shorthand  string `json:"shorthand"`
	Enterprise bool   `json:"enterprise"`
	Hidden     bool   `json:"hidden"`
	Secret     bool   `json:"secret"`
	Default    T      `json:"default"`
	Value      T      `json:"value"`
}

func (*DeploymentConfigField[T]) MarshalJSON added in v0.11.0 

func (f *DeploymentConfigField[T]) MarshalJSON() ([]byte, error)

MarshalJSON removes the Value field from the JSON output of any fields marked Secret. nolint:revive

type DialWorkspaceAgentOptions added in v0.10.0 

type DialWorkspaceAgentOptions struct {
	Logger slog.Logger
	// BlockEndpoints forced a direct connection through DERP.
	BlockEndpoints bool
}

@typescript-ignore DialWorkspaceAgentOptions

type Entitlement added in v0.8.6 

type Entitlement string
const (
	EntitlementEntitled    Entitlement = "entitled"
	EntitlementGracePeriod Entitlement = "grace_period"
	EntitlementNotEntitled Entitlement = "not_entitled"
)

type Entitlements added in v0.8.6 

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

type Error 

type Error struct {
	Response

	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 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 Flaggable added in v0.11.0 

type Flaggable interface {
	string | time.Duration | bool | int | []string | []GitAuthConfig
}

type GenerateAPIKeyResponse 

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

GenerateAPIKeyResponse contains an API key for a user.

type GetAppHostResponse added in v0.9.0 

type GetAppHostResponse struct {
	Host string `json:"host"`
}

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"`
	Regex        string   `json:"regex"`
	Scopes       []string `json:"scopes"`
}

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. @typescript-ignore GitProvider

type GitSSHKey added in v0.4.0 

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

type GoogleInstanceIdentityToken 

type GoogleInstanceIdentityToken struct {
	JSONWebToken string `json:"json_web_token" validate:"required"`
}

@typescript-ignore GoogleInstanceIdentityToken

type Group added in v0.9.9 

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

type Healthcheck added in v0.9.0 

type Healthcheck struct {
	// URL specifies the url 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 License added in v0.8.7 

type License struct {
	ID         int32     `json:"id"`
	UploadedAt time.Time `json:"uploaded_at"`
	// 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"`
}

type ListeningPort added in v0.9.5 

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

type ListeningPortNetwork added in v0.9.5 

type ListeningPortNetwork string
const (
	ListeningPortNetworkTCP ListeningPortNetwork = "tcp"
)

type ListeningPortsResponse added in v0.9.5 

type ListeningPortsResponse 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 []ListeningPort `json:"ports"`
}

type LogLevel added in v0.6.0 

type LogLevel string
const (
	LogLevelTrace LogLevel = "trace"
	LogLevelDebug LogLevel = "debug"
	LogLevelInfo  LogLevel = "info"
	LogLevelWarn  LogLevel = "warn"
	LogLevelError LogLevel = "error"
)

type LogSource added in v0.6.0 

type LogSource string
const (
	LogSourceProvisionerDaemon LogSource = "provisioner_daemon"
	LogSourceProvisioner       LogSource = "provisioner"
)

type LoginType added in v0.7.6 

type LoginType string
const (
	LoginTypePassword LoginType = "password"
	LoginTypeGithub   LoginType = "github"
	LoginTypeOIDC     LoginType = "oidc"
	LoginTypeToken    LoginType = "token"
)

type LoginWithPasswordRequest 

type LoginWithPasswordRequest struct {
	Email    string `json:"email" validate:"required,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 {
	sql.NullTime
}

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          *DeploymentConfigField[string]   `json:"client_id" typescript:",notnull"`
	ClientSecret      *DeploymentConfigField[string]   `json:"client_secret" typescript:",notnull"`
	AllowedOrgs       *DeploymentConfigField[[]string] `json:"allowed_orgs" typescript:",notnull"`
	AllowedTeams      *DeploymentConfigField[[]string] `json:"allowed_teams" typescript:",notnull"`
	AllowSignups      *DeploymentConfigField[bool]     `json:"allow_signups" typescript:",notnull"`
	EnterpriseBaseURL *DeploymentConfigField[string]   `json:"enterprise_base_url" typescript:",notnull"`
}

type OIDCConfig added in v0.11.0 

type OIDCConfig struct {
	AllowSignups *DeploymentConfigField[bool]     `json:"allow_signups" typescript:",notnull"`
	ClientID     *DeploymentConfigField[string]   `json:"client_id" typescript:",notnull"`
	ClientSecret *DeploymentConfigField[string]   `json:"client_secret" typescript:",notnull"`
	EmailDomain  *DeploymentConfigField[string]   `json:"email_domain" typescript:",notnull"`
	IssuerURL    *DeploymentConfigField[string]   `json:"issuer_url" typescript:",notnull"`
	Scopes       *DeploymentConfigField[[]string] `json:"scopes" typescript:",notnull"`
}

type Organization 

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

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"`
	OrganizationID uuid.UUID `db:"organization_id" json:"organization_id"`
	CreatedAt      time.Time `db:"created_at" json:"created_at"`
	UpdatedAt      time.Time `db:"updated_at" json:"updated_at"`
	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"`
	// 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 Parameter 

type Parameter struct {
	ID                uuid.UUID                  `json:"id" table:"id"`
	Scope             ParameterScope             `json:"scope" table:"scope"`
	ScopeID           uuid.UUID                  `json:"scope_id" table:"scope id"`
	Name              string                     `json:"name" table:"name"`
	SourceScheme      ParameterSourceScheme      `json:"source_scheme" table:"source scheme" validate:"ne=none"`
	DestinationScheme ParameterDestinationScheme `json:"destination_scheme" table:"destination scheme" validate:"ne=none"`
	CreatedAt         time.Time                  `json:"created_at" table:"created at"`
	UpdatedAt         time.Time                  `json:"updated_at" table:"updated at"`
}

Parameter represents a set value for the scope.

type ParameterDestinationScheme added in v0.6.0 

type ParameterDestinationScheme string
const (
	ParameterDestinationSchemeNone                ParameterDestinationScheme = "none"
	ParameterDestinationSchemeEnvironmentVariable ParameterDestinationScheme = "environment_variable"
	ParameterDestinationSchemeProvisionerVariable ParameterDestinationScheme = "provisioner_variable"
)

type ParameterSchema added in v0.6.0 

type ParameterSchema struct {
	ID                       uuid.UUID                  `json:"id"`
	CreatedAt                time.Time                  `json:"created_at"`
	JobID                    uuid.UUID                  `json:"job_id"`
	Name                     string                     `json:"name"`
	Description              string                     `json:"description"`
	DefaultSourceScheme      ParameterSourceScheme      `json:"default_source_scheme"`
	DefaultSourceValue       string                     `json:"default_source_value"`
	AllowOverrideSource      bool                       `json:"allow_override_source"`
	DefaultDestinationScheme ParameterDestinationScheme `json:"default_destination_scheme"`
	AllowOverrideDestination bool                       `json:"allow_override_destination"`
	DefaultRefresh           string                     `json:"default_refresh"`
	RedisplayValue           bool                       `json:"redisplay_value"`
	ValidationError          string                     `json:"validation_error"`
	ValidationCondition      string                     `json:"validation_condition"`
	ValidationTypeSystem     string                     `json:"validation_type_system"`
	ValidationValueType      string                     `json:"validation_value_type"`

	// This is a special array of items provided if the validation condition
	// explicitly states the value must be one of a set.
	ValidationContains []string `json:"validation_contains,omitempty"`
}

type ParameterScope 

type ParameterScope string
const (
	ParameterTemplate  ParameterScope = "template"
	ParameterWorkspace ParameterScope = "workspace"
	ParameterImportJob ParameterScope = "import_job"
)

type ParameterSourceScheme added in v0.6.0 

type ParameterSourceScheme string
const (
	ParameterSourceSchemeNone ParameterSourceScheme = "none"
	ParameterSourceSchemeData ParameterSourceScheme = "data"
)

type ParameterTypeSystem added in v0.6.0 

type ParameterTypeSystem string
const (
	ParameterTypeSystemNone ParameterTypeSystem = "none"
	ParameterTypeSystemHCL  ParameterTypeSystem = "hcl"
)

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

type PostWorkspaceAgentVersionRequest added in v0.8.11 

type PostWorkspaceAgentVersionRequest struct {
	Version string `json:"version"`
}

@typescript-ignore PostWorkspaceAgentVersionRequest

type PostWorkspaceAppHealthsRequest added in v0.9.0 

type PostWorkspaceAppHealthsRequest struct {
	// Healths is a map of the workspace app name and the health of the app.
	Healths map[uuid.UUID]WorkspaceAppHealth
}

@typescript-ignore PostWorkspaceAppHealthsRequest

type PprofConfig added in v0.11.0 

type PprofConfig struct {
	Enable  *DeploymentConfigField[bool]   `json:"enable" typescript:",notnull"`
	Address *DeploymentConfigField[string] `json:"address" typescript:",notnull"`
}

type PrometheusConfig added in v0.11.0 

type PrometheusConfig struct {
	Enable  *DeploymentConfigField[bool]   `json:"enable" typescript:",notnull"`
	Address *DeploymentConfigField[string] `json:"address" typescript:",notnull"`
}

type ProvisionerConfig added in v0.12.6 

type ProvisionerConfig struct {
	Daemons             *DeploymentConfigField[int]           `json:"daemons" typescript:",notnull"`
	ForceCancelInterval *DeploymentConfigField[time.Duration] `json:"force_cancel_interval" typescript:",notnull"`
}

type ProvisionerDaemon 

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

type ProvisionerJob 

type ProvisionerJob struct {
	ID          uuid.UUID            `json:"id"`
	CreatedAt   time.Time            `json:"created_at"`
	StartedAt   *time.Time           `json:"started_at,omitempty"`
	CompletedAt *time.Time           `json:"completed_at,omitempty"`
	CanceledAt  *time.Time           `json:"canceled_at,omitempty"`
	Error       string               `json:"error,omitempty"`
	Status      ProvisionerJobStatus `json:"status"`
	WorkerID    *uuid.UUID           `json:"worker_id,omitempty"`
	FileID      uuid.UUID            `json:"file_id"`
}

type ProvisionerJobLog 

type ProvisionerJobLog struct {
	ID        int64     `json:"id"`
	CreatedAt time.Time `json:"created_at"`
	Source    LogSource `json:"log_source"`
	Level     LogLevel  `json:"log_level"`
	Stage     string    `json:"stage"`
	Output    string    `json:"output"`
}

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 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 PutExtendWorkspaceRequest added in v0.6.1 

type PutExtendWorkspaceRequest struct {
	Deadline time.Time `json:"deadline" validate:"required"`
}

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

type ReconnectingPTYInit added in v0.9.0 

type ReconnectingPTYInit struct {
	ID      string
	Height  uint16
	Width   uint16
	Command string
}

@typescript-ignore ReconnectingPTYInit

type ReconnectingPTYRequest added in v0.9.0 

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

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

type Replica added in v0.10.0 

type Replica struct {
	// ID is the unique identifier for the replica.
	ID uuid.UUID `json:"id"`
	// Hostname is the hostname of the replica.
	Hostname string `json:"hostname"`
	// CreatedAt is when the replica was first seen.
	CreatedAt time.Time `json:"created_at"`
	// 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 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)

func WithQueryParam added in v0.9.8 

func WithQueryParam(key, value string) RequestOption

type ResourceType added in v0.8.11 

type ResourceType string
const (
	ResourceTypeOrganization    ResourceType = "organization"
	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"
)

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 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 TLSConfig added in v0.11.0 

type TLSConfig struct {
	Enable       *DeploymentConfigField[bool]     `json:"enable" typescript:",notnull"`
	CertFiles    *DeploymentConfigField[[]string] `json:"cert_file" typescript:",notnull"`
	ClientAuth   *DeploymentConfigField[string]   `json:"client_auth" typescript:",notnull"`
	ClientCAFile *DeploymentConfigField[string]   `json:"client_ca_file" typescript:",notnull"`
	KeyFiles     *DeploymentConfigField[[]string] `json:"key_file" typescript:",notnull"`
	MinVersion   *DeploymentConfigField[string]   `json:"min_version" typescript:",notnull"`
}

type TelemetryConfig added in v0.11.0 

type TelemetryConfig struct {
	Enable *DeploymentConfigField[bool]   `json:"enable" typescript:",notnull"`
	Trace  *DeploymentConfigField[bool]   `json:"trace" typescript:",notnull"`
	URL    *DeploymentConfigField[string] `json:"url" typescript:",notnull"`
}

type Template added in v0.4.0 

type Template struct {
	ID                  uuid.UUID       `json:"id"`
	CreatedAt           time.Time       `json:"created_at"`
	UpdatedAt           time.Time       `json:"updated_at"`
	OrganizationID      uuid.UUID       `json:"organization_id"`
	Name                string          `json:"name"`
	DisplayName         string          `json:"display_name"`
	Provisioner         ProvisionerType `json:"provisioner"`
	ActiveVersionID     uuid.UUID       `json:"active_version_id"`
	WorkspaceOwnerCount uint32          `json:"workspace_owner_count"`
	// 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"`
	CreatedByID      uuid.UUID              `json:"created_by_id"`
	CreatedByName    string                 `json:"created_by_name"`
}

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 TemplateBuildTimeStats added in v0.10.0 

type TemplateBuildTimeStats struct {
	StartMillis  *int64 `json:"start_ms"`
	StopMillis   *int64 `json:"stop_ms"`
	DeleteMillis *int64 `json:"delete_ms"`
}

type TemplateDAUsResponse added in v0.8.12 

type TemplateDAUsResponse struct {
	Entries []DAUEntry `json:"entries"`
}

type TemplateGroup added in v0.9.9 

type TemplateGroup struct {
	Group
	Role TemplateRole `json:"role"`
}

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 {
	User
	Role TemplateRole `json:"role"`
}

type TemplateVersion added in v0.4.0 

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

TemplateVersion represents a single version of a template.

type TemplateVersionsByTemplateRequest added in v0.5.6 

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

TemplateVersionsByTemplateRequest defines the request parameters for TemplateVersionsByTemplate.

type TraceConfig added in v0.12.0 

type TraceConfig struct {
	Enable          *DeploymentConfigField[bool]   `json:"enable" typescript:",notnull"`
	HoneycombAPIKey *DeploymentConfigField[string] `json:"honeycomb_api_key" typescript:",notnull"`
	CaptureLogs     *DeploymentConfigField[bool]   `json:"capture_logs" typescript:",notnull"`
}

type UpdateActiveTemplateVersion added in v0.4.0 

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

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  map[string]TemplateRole `json:"user_perms,omitempty"`
	GroupPerms map[string]TemplateRole `json:"group_perms,omitempty"`
}

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

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

UploadResponse contains the hash to reference the uploaded file.

type User 

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

	Status          UserStatus  `json:"status" table:"status"`
	OrganizationIDs []uuid.UUID `json:"organization_ids"`
	Roles           []Role      `json:"roles"`
	AvatarURL       string      `json:"avatar_url"`
}

User represents a user in Coder.

type UserCountRequest added in v0.12.6 

type UserCountRequest 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 UserCountResponse added in v0.12.6 

type UserCountResponse struct {
	Count int64 `json:"count"`
}

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

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 Workspace 

type Workspace struct {
	ID                uuid.UUID      `json:"id"`
	CreatedAt         time.Time      `json:"created_at"`
	UpdatedAt         time.Time      `json:"updated_at"`
	OwnerID           uuid.UUID      `json:"owner_id"`
	OwnerName         string         `json:"owner_name"`
	TemplateID        uuid.UUID      `json:"template_id"`
	TemplateName      string         `json:"template_name"`
	TemplateIcon      string         `json:"template_icon"`
	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"`
}

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"`
	CreatedAt            time.Time            `json:"created_at"`
	UpdatedAt            time.Time            `json:"updated_at"`
	FirstConnectedAt     *time.Time           `json:"first_connected_at,omitempty"`
	LastConnectedAt      *time.Time           `json:"last_connected_at,omitempty"`
	DisconnectedAt       *time.Time           `json:"disconnected_at,omitempty"`
	Status               WorkspaceAgentStatus `json:"status"`
	Name                 string               `json:"name"`
	ResourceID           uuid.UUID            `json:"resource_id"`
	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"`
	Directory            string               `json:"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,omitempty"`
}

type WorkspaceAgentAuthenticateResponse 

type WorkspaceAgentAuthenticateResponse struct {
	SessionToken string `json:"session_token"`
}

WorkspaceAgentAuthenticateResponse is returned when an instance ID has been exchanged for a session token. @typescript-ignore WorkspaceAgentAuthenticateResponse

type WorkspaceAgentConnectionInfo added in v0.8.11 

type WorkspaceAgentConnectionInfo struct {
	DERPMap *tailcfg.DERPMap `json:"derp_map"`
}

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

type WorkspaceAgentGitAuthResponse added in v0.11.0 

type WorkspaceAgentGitAuthResponse struct {
	Username string `json:"username"`
	Password string `json:"password"`
	URL      string `json:"url"`
}

type WorkspaceAgentInstanceMetadata 

type WorkspaceAgentInstanceMetadata struct {
	JailOrchestrator   string `json:"jail_orchestrator"`
	OperatingSystem    string `json:"operating_system"`
	Platform           string `json:"platform"`
	PlatformFamily     string `json:"platform_family"`
	KernelVersion      string `json:"kernel_version"`
	KernelArchitecture string `json:"kernel_architecture"`
	Cloud              string `json:"cloud"`
	Jail               string `json:"jail"`
	VNC                bool   `json:"vnc"`
}

type WorkspaceAgentMetadata added in v0.9.0 

type WorkspaceAgentMetadata struct {
	// GitAuthConfigs stores the number of Git configurations
	// the Coder deployment has. If this number is >0, we
	// set up special configuration in the workspace.
	GitAuthConfigs       int               `json:"git_auth_configs"`
	VSCodePortProxyURI   string            `json:"vscode_port_proxy_uri"`
	Apps                 []WorkspaceApp    `json:"apps"`
	DERPMap              *tailcfg.DERPMap  `json:"derpmap"`
	EnvironmentVariables map[string]string `json:"environment_variables"`
	StartupScript        string            `json:"startup_script"`
	Directory            string            `json:"directory"`
}

@typescript-ignore WorkspaceAgentMetadata

type WorkspaceAgentResourceMetadata 

type WorkspaceAgentResourceMetadata struct {
	MemoryTotal uint64  `json:"memory_total"`
	DiskTotal   uint64  `json:"disk_total"`
	CPUCores    uint64  `json:"cpu_cores"`
	CPUModel    string  `json:"cpu_model"`
	CPUMhz      float64 `json:"cpu_mhz"`
}

type WorkspaceAgentStatus 

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

type WorkspaceApp added in v0.6.2 

type WorkspaceApp struct {
	ID uuid.UUID `json:"id"`
	// 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"`
	// 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"`
	CreatedAt          time.Time           `json:"created_at"`
	UpdatedAt          time.Time           `json:"updated_at"`
	WorkspaceID        uuid.UUID           `json:"workspace_id"`
	WorkspaceName      string              `json:"workspace_name"`
	WorkspaceOwnerID   uuid.UUID           `json:"workspace_owner_id"`
	WorkspaceOwnerName string              `json:"workspace_owner_name"`
	TemplateVersionID  uuid.UUID           `json:"template_version_id"`
	BuildNumber        int32               `json:"build_number"`
	Transition         WorkspaceTransition `json:"transition"`
	InitiatorID        uuid.UUID           `json:"initiator_id"`
	InitiatorUsername  string              `json:"initiator_name"`
	Job                ProvisionerJob      `json:"job"`
	Reason             BuildReason         `db:"reason" json:"reason"`
	Resources          []WorkspaceResource `json:"resources"`
	Deadline           NullTime            `json:"deadline,omitempty"`
	Status             WorkspaceStatus     `json:"status"`
}

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

type WorkspaceBuildsRequest added in v0.6.0 

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

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 WorkspaceOptions added in v0.6.3 

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

type WorkspaceQuota added in v0.9.2 

type WorkspaceQuota struct {
	UserWorkspaceCount int `json:"user_workspace_count"`
	UserWorkspaceLimit int `json:"user_workspace_limit"`
}

type WorkspaceResource 

type WorkspaceResource struct {
	ID         uuid.UUID                   `json:"id"`
	CreatedAt  time.Time                   `json:"created_at"`
	JobID      uuid.UUID                   `json:"job_id"`
	Transition WorkspaceTransition         `json:"workspace_transition"`
	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"`
}

type WorkspaceResourceMetadata added in v0.8.3 

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

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

type WorkspacesResponse added in v0.12.6 

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

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.