Schemas
agentsdk.AWSInstanceIdentityToken
{
"document" : "string" ,
"signature" : "string"
}
Properties
Name Type Required Restrictions Description document
string true signature
string true
agentsdk.AgentMetric
{
"labels" : [
{
"name" : "string" ,
"value" : "string"
}
],
"name" : "string" ,
"type" : "counter" ,
"value" : 0
}
Properties
Enumerated Values
Property Value type
counter
type
gauge
agentsdk.AgentMetricLabel
{
"name" : "string" ,
"value" : "string"
}
Properties
Name Type Required Restrictions Description name
string true value
string true
agentsdk.AgentMetricType
Properties
Enumerated Values
agentsdk.AuthenticateResponse
{
"session_token" : "string"
}
Properties
Name Type Required Restrictions Description session_token
string false
agentsdk.AzureInstanceIdentityToken
{
"encoding" : "string" ,
"signature" : "string"
}
Properties
Name Type Required Restrictions Description encoding
string true signature
string true
agentsdk.GitAuthResponse
{
"password" : "string" ,
"url" : "string" ,
"username" : "string"
}
Properties
Name Type Required Restrictions Description password
string false url
string false username
string false
agentsdk.GitSSHKey
{
"private_key" : "string" ,
"public_key" : "string"
}
Properties
Name Type Required Restrictions Description private_key
string false public_key
string false
agentsdk.GoogleInstanceIdentityToken
{
"json_web_token" : "string"
}
Properties
Name Type Required Restrictions Description json_web_token
string true
agentsdk.Manifest
{
"apps" : [
{
"command" : "string" ,
"display_name" : "string" ,
"external" : true ,
"health" : "disabled" ,
"healthcheck" : {
"interval" : 0 ,
"threshold" : 0 ,
"url" : "string"
},
"icon" : "string" ,
"id" : "497f6eca-6276-4993-bfeb-53cbbbba6f08" ,
"sharing_level" : "owner" ,
"slug" : "string" ,
"subdomain" : true ,
"url" : "string"
}
],
"derpmap" : {
"omitDefaultRegions" : true ,
"regions" : {
"property1" : {
"avoid" : true ,
"embeddedRelay" : true ,
"nodes" : [
{
"certName" : "string" ,
"derpport" : 0 ,
"forceHTTP" : true ,
"hostName" : "string" ,
"insecureForTests" : true ,
"ipv4" : "string" ,
"ipv6" : "string" ,
"name" : "string" ,
"regionID" : 0 ,
"stunonly" : true ,
"stunport" : 0 ,
"stuntestIP" : "string"
}
],
"regionCode" : "string" ,
"regionID" : 0 ,
"regionName" : "string"
},
"property2" : {
"avoid" : true ,
"embeddedRelay" : true ,
"nodes" : [
{
"certName" : "string" ,
"derpport" : 0 ,
"forceHTTP" : true ,
"hostName" : "string" ,
"insecureForTests" : true ,
"ipv4" : "string" ,
"ipv6" : "string" ,
"name" : "string" ,
"regionID" : 0 ,
"stunonly" : true ,
"stunport" : 0 ,
"stuntestIP" : "string"
}
],
"regionCode" : "string" ,
"regionID" : 0 ,
"regionName" : "string"
}
}
},
"directory" : "string" ,
"environment_variables" : {
"property1" : "string" ,
"property2" : "string"
},
"git_auth_configs" : 0 ,
"metadata" : [
{
"display_name" : "string" ,
"interval" : 0 ,
"key" : "string" ,
"script" : "string" ,
"timeout" : 0
}
],
"motd_file" : "string" ,
"shutdown_script" : "string" ,
"shutdown_script_timeout" : 0 ,
"startup_script" : "string" ,
"startup_script_timeout" : 0 ,
"vscode_port_proxy_uri" : "string"
}
Properties
Name Type Required Restrictions Description apps
array of codersdk.WorkspaceApp false derpmap
tailcfg.DERPMap false directory
string false environment_variables
object false » [any property]
string false git_auth_configs
integer false Git auth configs stores the number of Git configurations the Coder deployment has. If this number is >0, we set up special configuration in the workspace. metadata
array of codersdk.WorkspaceAgentMetadataDescription false motd_file
string false shutdown_script
string false shutdown_script_timeout
integer false startup_script
string false startup_script_timeout
integer false vscode_port_proxy_uri
string false
agentsdk.PatchStartupLogs
{
"logs" : [
{
"created_at" : "string" ,
"level" : "trace" ,
"output" : "string"
}
]
}
Properties
agentsdk.PostAppHealthsRequest
{
"healths" : {
"property1" : "disabled" ,
"property2" : "disabled"
}
}
Properties
Name Type Required Restrictions Description healths
object false Healths is a map of the workspace app name and the health of the app. » [any property]
codersdk.WorkspaceAppHealth false
agentsdk.PostLifecycleRequest
Properties
agentsdk.PostMetadataRequest
{
"age" : 0 ,
"collected_at" : "2019-08-24T14:15:22Z" ,
"error" : "string" ,
"value" : "string"
}
Properties
Name Type Required Restrictions Description age
integer false Age is the number of seconds since the metadata was collected. It is provided in addition to CollectedAt to protect against clock skew. collected_at
string false error
string false value
string false
agentsdk.PostStartupRequest
{
"expanded_directory" : "string" ,
"subsystem" : "envbox" ,
"version" : "string"
}
Properties
Name Type Required Restrictions Description expanded_directory
string false subsystem
codersdk.AgentSubsystem false version
string false
agentsdk.StartupLog
{
"created_at" : "string" ,
"level" : "trace" ,
"output" : "string"
}
Properties
Name Type Required Restrictions Description created_at
string false level
codersdk.LogLevel false output
string false
agentsdk.Stats
{
"connection_count" : 0 ,
"connection_median_latency_ms" : 0 ,
"connections_by_proto" : {
"property1" : 0 ,
"property2" : 0
},
"metrics" : [
{
"labels" : [
{
"name" : "string" ,
"value" : "string"
}
],
"name" : "string" ,
"type" : "counter" ,
"value" : 0
}
],
"rx_bytes" : 0 ,
"rx_packets" : 0 ,
"session_count_jetbrains" : 0 ,
"session_count_reconnecting_pty" : 0 ,
"session_count_ssh" : 0 ,
"session_count_vscode" : 0 ,
"tx_bytes" : 0 ,
"tx_packets" : 0
}
Properties
Name Type Required Restrictions Description connection_count
integer false Connection count is the number of connections received by an agent. connection_median_latency_ms
number false Connection median latency ms is the median latency of all connections in milliseconds. connections_by_proto
object false Connections by proto is a count of connections by protocol. » [any property]
integer false metrics
array of agentsdk.AgentMetric false Metrics collected by the agent rx_bytes
integer false Rx bytes is the number of received bytes. rx_packets
integer false Rx packets is the number of received packets. session_count_jetbrains
integer false Session count jetbrains is the number of connections received by an agent that are from our JetBrains extension. session_count_reconnecting_pty
integer false Session count reconnecting pty is the number of connections received by an agent that are from the reconnecting web terminal. session_count_ssh
integer false Session count ssh is the number of connections received by an agent that are normal, non-tagged SSH sessions. session_count_vscode
integer false Session count vscode is the number of connections received by an agent that are from our VS Code extension. tx_bytes
integer false Tx bytes is the number of transmitted bytes. tx_packets
integer false Tx packets is the number of transmitted bytes.
agentsdk.StatsResponse
Properties
Name Type Required Restrictions Description report_interval
integer false Report interval is the duration after which the agent should send stats again.
clibase.Annotations
{
"property1" : "string" ,
"property2" : "string"
}
Properties
Name Type Required Restrictions Description [any property]
string false
clibase.Group
{
"description" : "string" ,
"name" : "string" ,
"parent" : {
"description" : "string" ,
"name" : "string" ,
"parent" : {},
"yaml" : "string"
},
"yaml" : "string"
}
Properties
Name Type Required Restrictions Description description
string false name
string false parent
clibase.Group false yaml
string false
clibase.HostPort
{
"host" : "string" ,
"port" : "string"
}
Properties
Name Type Required Restrictions Description host
string false port
string false
clibase.Option
{
"annotations" : {
"property1" : "string" ,
"property2" : "string"
},
"default" : "string" ,
"description" : "string" ,
"env" : "string" ,
"flag" : "string" ,
"flag_shorthand" : "string" ,
"group" : {
"description" : "string" ,
"name" : "string" ,
"parent" : {
"description" : "string" ,
"name" : "string" ,
"parent" : {},
"yaml" : "string"
},
"yaml" : "string"
},
"hidden" : true ,
"name" : "string" ,
"use_instead" : [
{
"annotations" : {
"property1" : "string" ,
"property2" : "string"
},
"default" : "string" ,
"description" : "string" ,
"env" : "string" ,
"flag" : "string" ,
"flag_shorthand" : "string" ,
"group" : {
"description" : "string" ,
"name" : "string" ,
"parent" : {
"description" : "string" ,
"name" : "string" ,
"parent" : {},
"yaml" : "string"
},
"yaml" : "string"
},
"hidden" : true ,
"name" : "string" ,
"use_instead" : [],
"value" : null ,
"value_source" : "" ,
"yaml" : "string"
}
],
"value" : null ,
"value_source" : "" ,
"yaml" : "string"
}
Properties
Name Type Required Restrictions Description annotations
clibase.Annotations false Annotations enable extensions to clibase higher up in the stack. It's useful for help formatting and documentation generation. default
string false Default is parsed into Value if set. description
string false env
string false Env is the environment variable used to configure this option. If unset, environment configuring is disabled. flag
string false Flag is the long name of the flag used to configure this option. If unset, flag configuring is disabled. flag_shorthand
string false Flag shorthand is the one-character shorthand for the flag. If unset, no shorthand is used. group
clibase.Group false Group is a group hierarchy that helps organize this option in help, configs and other documentation. hidden
boolean false name
string false use_instead
array of clibase.Option false Use instead is a list of options that should be used instead of this one. The field is used to generate a deprecation warning. value
any false Value includes the types listed in values.go. value_source
clibase.ValueSource false yaml
string false Yaml is the YAML key used to configure this option. If unset, YAML configuring is disabled.
clibase.Struct-array_codersdk_GitAuthConfig
{
"value" : [
{
"auth_url" : "string" ,
"client_id" : "string" ,
"id" : "string" ,
"no_refresh" : true ,
"regex" : "string" ,
"scopes" : ["string" ],
"token_url" : "string" ,
"type" : "string" ,
"validate_url" : "string"
}
]
}
Properties
clibase.Struct-array_codersdk_LinkConfig
{
"value" : [
{
"icon" : "string" ,
"name" : "string" ,
"target" : "string"
}
]
}
Properties
clibase.URL
{
"forceQuery" : true ,
"fragment" : "string" ,
"host" : "string" ,
"omitHost" : true ,
"opaque" : "string" ,
"path" : "string" ,
"rawFragment" : "string" ,
"rawPath" : "string" ,
"rawQuery" : "string" ,
"scheme" : "string" ,
"user" : {}
}
Properties
Name Type Required Restrictions Description forceQuery
boolean false append a query ('?') even if RawQuery is empty fragment
string false fragment for references, without '#' host
string false host or host:port omitHost
boolean false do not emit empty host (authority) opaque
string false encoded opaque data path
string false path (relative paths may omit leading slash) rawFragment
string false encoded fragment hint (see EscapedFragment method) rawPath
string false encoded path hint (see EscapedPath method) rawQuery
string false encoded query values, without '?' scheme
string false user
url.Userinfo false username and password information
clibase.ValueSource
Properties
Enumerated Values
Value `` flag
env
yaml
default
coderd.SCIMUser
{
"active" : true ,
"emails" : [
{
"display" : "string" ,
"primary" : true ,
"type" : "string" ,
"value" : "[email protected] "
}
],
"groups" : [null ],
"id" : "string" ,
"meta" : {
"resourceType" : "string"
},
"name" : {
"familyName" : "string" ,
"givenName" : "string"
},
"schemas" : ["string" ],
"userName" : "string"
}
Properties
Name Type Required Restrictions Description active
boolean false emails
array of object false » display
string false » primary
boolean false » type
string false » value
string false groups
array of undefined false id
string false meta
object false » resourceType
string false name
object false » familyName
string false » givenName
string false schemas
array of string false userName
string false
coderd.cspViolation
Properties
Name Type Required Restrictions Description csp-report
object false
codersdk.APIKey
{
"created_at" : "2019-08-24T14:15:22Z" ,
"expires_at" : "2019-08-24T14:15:22Z" ,
"id" : "string" ,
"last_used" : "2019-08-24T14:15:22Z" ,
"lifetime_seconds" : 0 ,
"login_type" : "password" ,
"scope" : "all" ,
"token_name" : "string" ,
"updated_at" : "2019-08-24T14:15:22Z" ,
"user_id" : "a169451c-8525-4352-b8ca-070dd449a1a5"
}
Properties
Name Type Required Restrictions Description created_at
string true expires_at
string true id
string true last_used
string true lifetime_seconds
integer true login_type
codersdk.LoginType true scope
codersdk.APIKeyScope true token_name
string true updated_at
string true user_id
string true
Enumerated Values
Property Value login_type
password
login_type
github
login_type
oidc
login_type
token
scope
all
scope
application_connect
codersdk.APIKeyScope
Properties
Enumerated Values
Value all
application_connect
codersdk.AddLicenseRequest
Properties
Name Type Required Restrictions Description license
string true
codersdk.AgentSubsystem
Properties
Enumerated Values
codersdk.AppHostResponse
Properties
Name Type Required Restrictions Description host
string false Host is the externally accessible URL for the Coder instance.
codersdk.AppearanceConfig
{
"logo_url" : "string" ,
"service_banner" : {
"background_color" : "string" ,
"enabled" : true ,
"message" : "string"
},
"support_links" : [
{
"icon" : "string" ,
"name" : "string" ,
"target" : "string"
}
]
}
Properties
codersdk.AssignableRoles
{
"assignable" : true ,
"display_name" : "string" ,
"name" : "string"
}
Properties
Name Type Required Restrictions Description assignable
boolean false display_name
string false name
string false
codersdk.AuditAction
Properties
Enumerated Values
Value create
write
delete
start
stop
login
logout
register
codersdk.AuditDiff
{
"property1" : {
"new" : null ,
"old" : null ,
"secret" : true
},
"property2" : {
"new" : null ,
"old" : null ,
"secret" : true
}
}
Properties
codersdk.AuditDiffField
{
"new" : null ,
"old" : null ,
"secret" : true
}
Properties
Name Type Required Restrictions Description new
any false old
any false secret
boolean false
codersdk.AuditLog
{
"action" : "create" ,
"additional_fields" : [0 ],
"description" : "string" ,
"diff" : {
"property1" : {
"new" : null ,
"old" : null ,
"secret" : true
},
"property2" : {
"new" : null ,
"old" : null ,
"secret" : true
}
},
"id" : "497f6eca-6276-4993-bfeb-53cbbbba6f08" ,
"ip" : "string" ,
"is_deleted" : true ,
"organization_id" : "7c60d51f-b44e-4682-87d6-449835ea4de6" ,
"request_id" : "266ea41d-adf5-480b-af50-15b940c2b846" ,
"resource_icon" : "string" ,
"resource_id" : "4d5215ed-38bb-48ed-879a-fdb9ca58522f" ,
"resource_link" : "string" ,
"resource_target" : "string" ,
"resource_type" : "template" ,
"status_code" : 0 ,
"time" : "2019-08-24T14:15:22Z" ,
"user" : {
"avatar_url" : "http://example.com" ,
"created_at" : "2019-08-24T14:15:22Z" ,
"email" : "[email protected] " ,
"id" : "497f6eca-6276-4993-bfeb-53cbbbba6f08" ,
"last_seen_at" : "2019-08-24T14:15:22Z" ,
"organization_ids" : ["497f6eca-6276-4993-bfeb-53cbbbba6f08" ],
"roles" : [
{
"display_name" : "string" ,
"name" : "string"
}
],
"status" : "active" ,
"username" : "string"
},
"user_agent" : "string"
}
Properties
Name Type Required Restrictions Description action
codersdk.AuditAction false additional_fields
array of integer false description
string false diff
codersdk.AuditDiff false id
string false ip
string false is_deleted
boolean false organization_id
string false request_id
string false resource_icon
string false resource_id
string false resource_link
string false resource_target
string false Resource target is the name of the resource. resource_type
codersdk.ResourceType false status_code
integer false time
string false user
codersdk.User false user_agent
string false
codersdk.AuditLogResponse
{
"audit_logs" : [
{
"action" : "create" ,
"additional_fields" : [0 ],
"description" : "string" ,
"diff" : {
"property1" : {
"new" : null ,
"old" : null ,
"secret" : true
},
"property2" : {
"new" : null ,
"old" : null ,
"secret" : true
}
},
"id" : "497f6eca-6276-4993-bfeb-53cbbbba6f08" ,
"ip" : "string" ,
"is_deleted" : true ,
"organization_id" : "7c60d51f-b44e-4682-87d6-449835ea4de6" ,
"request_id" : "266ea41d-adf5-480b-af50-15b940c2b846" ,
"resource_icon" : "string" ,
"resource_id" : "4d5215ed-38bb-48ed-879a-fdb9ca58522f" ,
"resource_link" : "string" ,
"resource_target" : "string" ,
"resource_type" : "template" ,
"status_code" : 0 ,
"time" : "2019-08-24T14:15:22Z" ,
"user" : {
"avatar_url" : "http://example.com" ,
"created_at" : "2019-08-24T14:15:22Z" ,
"email" : "[email protected] " ,
"id" : "497f6eca-6276-4993-bfeb-53cbbbba6f08" ,
"last_seen_at" : "2019-08-24T14:15:22Z" ,
"organization_ids" : ["497f6eca-6276-4993-bfeb-53cbbbba6f08" ],
"roles" : [
{
"display_name" : "string" ,
"name" : "string"
}
],
"status" : "active" ,
"username" : "string"
},
"user_agent" : "string"
}
],
"count" : 0
}
Properties
Name Type Required Restrictions Description audit_logs
array of codersdk.AuditLog false count
integer false
codersdk.AuthMethod
Properties
Name Type Required Restrictions Description enabled
boolean false
codersdk.AuthMethods
{
"github" : {
"enabled" : true
},
"oidc" : {
"enabled" : true ,
"iconUrl" : "string" ,
"signInText" : "string"
},
"password" : {
"enabled" : true
}
}
Properties
codersdk.AuthorizationCheck
{
"action" : "create" ,
"object" : {
"organization_id" : "string" ,
"owner_id" : "string" ,
"resource_id" : "string" ,
"resource_type" : "workspace"
}
}
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.
Properties
Name Type Required Restrictions Description action
string false object
codersdk.AuthorizationObject false Object can represent a "set" of objects, such as: all workspaces in an organization, all workspaces owned by me, and all workspaces across the entire product. When defining an object, use the most specific language when possible to produce the smallest set. Meaning to set as many fields on 'Object' as you can. Example, if you want to check if you can update all workspaces owned by 'me', try to also add an 'OrganizationID' to the settings. Omitting the 'OrganizationID' could produce the incorrect value, as workspaces have both user
and organization
owners.
Enumerated Values
Property Value action
create
action
read
action
update
action
delete
codersdk.AuthorizationObject
{
"organization_id" : "string" ,
"owner_id" : "string" ,
"resource_id" : "string" ,
"resource_type" : "workspace"
}
AuthorizationObject can represent a "set" of objects, such as: all workspaces in an organization, all workspaces owned by me, all workspaces across the entire product.
Properties
Name Type Required Restrictions Description organization_id
string false Organization ID (optional) adds the set constraint to all resources owned by a given organization. owner_id
string false Owner ID (optional) adds the set constraint to all resources owned by a given user. resource_id
string false Resource ID (optional) reduces the set to a singular resource. This assigns a resource ID to the resource type, eg: a single workspace. The rbac library will not fetch the resource from the database, so if you are using this option, you should also set the owner ID and organization ID if possible. Be as specific as possible using all the fields relevant. resource_type
codersdk.RBACResource false Resource type is the name of the resource. ./coderd/rbac/object.go
has the list of valid resource types.
codersdk.AuthorizationRequest
{
"checks" : {
"property1" : {
"action" : "create" ,
"object" : {
"organization_id" : "string" ,
"owner_id" : "string" ,
"resource_id" : "string" ,
"resource_type" : "workspace"
}
},
"property2" : {
"action" : "create" ,
"object" : {
"organization_id" : "string" ,
"owner_id" : "string" ,
"resource_id" : "string" ,
"resource_type" : "workspace"
}
}
}
}
Properties
Name Type Required Restrictions Description checks
object false 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. » [any property]
codersdk.AuthorizationCheck false It is used to check if the currently authenticated user (or the specified user) can do a given action to a given set of objects.
codersdk.AuthorizationResponse
{
"property1" : true ,
"property2" : true
}
Properties
Name Type Required Restrictions Description [any property]
boolean false
codersdk.BuildInfoResponse
{
"dashboard_url" : "string" ,
"external_url" : "string" ,
"version" : "string" ,
"workspace_proxy" : true
}
Properties
Name Type Required Restrictions Description dashboard_url
string false Dashboard URL is the URL to hit the deployment's dashboard. For external workspace proxies, this is the coderd they are connected to. external_url
string false External URL references the current Coder version. For production builds, this will link directly to a release. For development builds, this will link to a commit. version
string false Version returns the semantic version of the build. workspace_proxy
boolean false
codersdk.BuildReason
Properties
Enumerated Values
Value initiator
autostart
autostop
codersdk.CreateFirstUserRequest
{
"email" : "string" ,
"password" : "string" ,
"trial" : true ,
"username" : "string"
}
Properties
Name Type Required Restrictions Description email
string true password
string true trial
boolean false username
string true
codersdk.CreateFirstUserResponse
{
"organization_id" : "7c60d51f-b44e-4682-87d6-449835ea4de6" ,
"user_id" : "a169451c-8525-4352-b8ca-070dd449a1a5"
}
Properties
Name Type Required Restrictions Description organization_id
string false user_id
string false
codersdk.CreateGroupRequest
{
"avatar_url" : "string" ,
"name" : "string" ,
"quota_allowance" : 0
}
Properties
Name Type Required Restrictions Description avatar_url
string false name
string false quota_allowance
integer false
codersdk.CreateOrganizationRequest
Properties
Name Type Required Restrictions Description name
string true
codersdk.CreateTemplateRequest
{
"allow_user_autostart" : true ,
"allow_user_autostop" : true ,
"allow_user_cancel_workspace_jobs" : true ,
"default_ttl_ms" : 0 ,
"description" : "string" ,
"display_name" : "string" ,
"failure_ttl_ms" : 0 ,
"icon" : "string" ,
"inactivity_ttl_ms" : 0 ,
"max_ttl_ms" : 0 ,
"name" : "string" ,
"template_version_id" : "0ba39c92-1f1b-4c32-aa3e-9925d7713eb1"
}
Properties
Name Type Required Restrictions Description allow_user_autostart
boolean false Allow user autostart allows users to set a schedule for autostarting their workspace. By default this is true. This can only be disabled when using an enterprise license. allow_user_autostop
boolean false Allow user autostop allows users to set a custom workspace TTL to use in place of the template's DefaultTTL field. By default this is true. If false, the DefaultTTL will always be used. This can only be disabled when using an enterprise license. allow_user_cancel_workspace_jobs
boolean false Allow users to cancel in-progress workspace jobs. *bool as the default value is "true". default_ttl_ms
integer false Default ttl ms allows optionally specifying the default TTL for all workspaces created from this template. description
string false Description is a description of what the template contains. It must be less than 128 bytes. display_name
string false Display name is the displayed name of the template. failure_ttl_ms
integer false Failure ttl ms allows optionally specifying the max lifetime before Coder stops all resources for failed workspaces created from this template. icon
string false Icon is a relative path or external URL that specifies an icon to be displayed in the dashboard. inactivity_ttl_ms
integer false Inactivity ttl ms allows optionally specifying the max lifetime before Coder deletes inactive workspaces created from this template. max_ttl_ms
integer false Max ttl ms allows optionally specifying the max lifetime for workspaces created from this template. name
string true Name is the name of the template. template_version_id
string true Template version ID 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.
codersdk.CreateTemplateVersionDryRunRequest
{
"rich_parameter_values" : [
{
"name" : "string" ,
"value" : "string"
}
],
"user_variable_values" : [
{
"name" : "string" ,
"value" : "string"
}
],
"workspace_name" : "string"
}
Properties
codersdk.CreateTemplateVersionRequest
{
"example_id" : "string" ,
"file_id" : "8a0cfb4f-ddc9-436d-91bb-75133c583767" ,
"name" : "string" ,
"provisioner" : "terraform" ,
"storage_method" : "file" ,
"tags" : {
"property1" : "string" ,
"property2" : "string"
},
"template_id" : "c6d67e98-83ea-49f0-8812-e4abae2b68bc" ,
"user_variable_values" : [
{
"name" : "string" ,
"value" : "string"
}
]
}
Properties
Name Type Required Restrictions Description example_id
string false file_id
string false name
string false provisioner
string true storage_method
codersdk.ProvisionerStorageMethod true tags
object false » [any property]
string false template_id
string false Template ID optionally associates a version with a template. user_variable_values
array of codersdk.VariableValue false
Enumerated Values
Property Value provisioner
terraform
provisioner
echo
storage_method
file
codersdk.CreateTestAuditLogRequest
{
"action" : "create" ,
"additional_fields" : [0 ],
"build_reason" : "autostart" ,
"resource_id" : "4d5215ed-38bb-48ed-879a-fdb9ca58522f" ,
"resource_type" : "template" ,
"time" : "2019-08-24T14:15:22Z"
}
Properties
Enumerated Values
Property Value action
create
action
write
action
delete
action
start
action
stop
build_reason
autostart
build_reason
autostop
build_reason
initiator
resource_type
template
resource_type
template_version
resource_type
user
resource_type
workspace
resource_type
workspace_build
resource_type
git_ssh_key
resource_type
auditable_group
codersdk.CreateTokenRequest
{
"lifetime" : 0 ,
"scope" : "all" ,
"token_name" : "string"
}
Properties
Name Type Required Restrictions Description lifetime
integer false scope
codersdk.APIKeyScope false token_name
string false
Enumerated Values
Property Value scope
all
scope
application_connect
codersdk.CreateUserRequest
{
"email" : "[email protected] " ,
"organization_id" : "7c60d51f-b44e-4682-87d6-449835ea4de6" ,
"password" : "string" ,
"username" : "string"
}
Properties
Name Type Required Restrictions Description email
string true organization_id
string false password
string true username
string true
codersdk.CreateWorkspaceBuildRequest
{
"dry_run" : true ,
"log_level" : "debug" ,
"orphan" : true ,
"rich_parameter_values" : [
{
"name" : "string" ,
"value" : "string"
}
],
"state" : [0 ],
"template_version_id" : "0ba39c92-1f1b-4c32-aa3e-9925d7713eb1" ,
"transition" : "create"
}
Properties
Name Type Required Restrictions Description dry_run
boolean false log_level
codersdk.ProvisionerLogLevel false Log level changes the default logging verbosity of a provider ("info" if empty). orphan
boolean false Orphan may be set for the Destroy transition. rich_parameter_values
array of codersdk.WorkspaceBuildParameter false Rich parameter values 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. state
array of integer false template_version_id
string false transition
codersdk.WorkspaceTransition true
Enumerated Values
Property Value log_level
debug
transition
create
transition
start
transition
stop
transition
delete
codersdk.CreateWorkspaceProxyRequest
{
"display_name" : "string" ,
"icon" : "string" ,
"name" : "string"
}
Properties
Name Type Required Restrictions Description display_name
string false icon
string false name
string true
codersdk.CreateWorkspaceRequest
{
"autostart_schedule" : "string" ,
"name" : "string" ,
"rich_parameter_values" : [
{
"name" : "string" ,
"value" : "string"
}
],
"template_id" : "c6d67e98-83ea-49f0-8812-e4abae2b68bc" ,
"ttl_ms" : 0
}
Properties
Name Type Required Restrictions Description autostart_schedule
string false name
string true rich_parameter_values
array of codersdk.WorkspaceBuildParameter false Rich parameter values allows for additional parameters to be provided during the initial provision. template_id
string true ttl_ms
integer false
codersdk.DAUEntry
{
"amount" : 0 ,
"date" : "2019-08-24T14:15:22Z"
}
Properties
Name Type Required Restrictions Description amount
integer false date
string false
codersdk.DAUsResponse
{
"entries" : [
{
"amount" : 0 ,
"date" : "2019-08-24T14:15:22Z"
}
],
"tz_hour_offset" : 0
}
Properties
Name Type Required Restrictions Description entries
array of codersdk.DAUEntry false tz_hour_offset
integer false
codersdk.DERP
{
"config" : {
"path" : "string" ,
"url" : "string"
},
"server" : {
"enable" : true ,
"region_code" : "string" ,
"region_id" : 0 ,
"region_name" : "string" ,
"relay_url" : {
"forceQuery" : true ,
"fragment" : "string" ,
"host" : "string" ,
"omitHost" : true ,
"opaque" : "string" ,
"path" : "string" ,
"rawFragment" : "string" ,
"rawPath" : "string" ,
"rawQuery" : "string" ,
"scheme" : "string" ,
"user" : {}
},
"stun_addresses" : ["string" ]
}
}
Properties
codersdk.DERPConfig
{
"path" : "string" ,
"url" : "string"
}
Properties
Name Type Required Restrictions Description path
string false url
string false
codersdk.DERPRegion
{
"latency_ms" : 0 ,
"preferred" : true
}
Properties
Name Type Required Restrictions Description latency_ms
number false preferred
boolean false
codersdk.DERPServerConfig
{
"enable" : true ,
"region_code" : "string" ,
"region_id" : 0 ,
"region_name" : "string" ,
"relay_url" : {
"forceQuery" : true ,
"fragment" : "string" ,
"host" : "string" ,
"omitHost" : true ,
"opaque" : "string" ,
"path" : "string" ,
"rawFragment" : "string" ,
"rawPath" : "string" ,
"rawQuery" : "string" ,
"scheme" : "string" ,
"user" : {}
},
"stun_addresses" : ["string" ]
}
Properties
Name Type Required Restrictions Description enable
boolean false region_code
string false region_id
integer false region_name
string false relay_url
clibase.URL false stun_addresses
array of string false
codersdk.DangerousConfig
{
"allow_all_cors" : true ,
"allow_path_app_sharing" : true ,
"allow_path_app_site_owner_access" : true
}
Properties
Name Type Required Restrictions Description allow_all_cors
boolean false allow_path_app_sharing
boolean false allow_path_app_site_owner_access
boolean false
codersdk.DeploymentConfig
{
"config" : {
"access_url" : {
"forceQuery" : true ,
"fragment" : "string" ,
"host" : "string" ,
"omitHost" : true ,
"opaque" : "string" ,
"path" : "string" ,
"rawFragment" : "string" ,
"rawPath" : "string" ,
"rawQuery" : "string" ,
"scheme" : "string" ,
"user" : {}
},
"address" : {
"host" : "string" ,
"port" : "string"
},
"agent_fallback_troubleshooting_url" : {
"forceQuery" : true ,
"fragment" : "string" ,
"host" : "string" ,
"omitHost" : true ,
"opaque" : "string" ,
"path" : "string" ,
"rawFragment" : "string" ,
"rawPath" : "string" ,
"rawQuery" : "string" ,
"scheme" : "string" ,
"user" : {}
},
"agent_stat_refresh_interval" : 0 ,
"autobuild_poll_interval" : 0 ,
"browser_only" : true ,
"cache_directory" : "string" ,
"config" : "string" ,
"config_ssh" : {
"deploymentName" : "string" ,
"sshconfigOptions" : ["string" ]
},
"dangerous" : {
"allow_all_cors" : true ,
"allow_path_app_sharing" : true ,
"allow_path_app_site_owner_access" : true
},
"derp" : {
"config" : {
"path" : "string" ,
"url" : "string"
},
"server" : {
"enable" : true ,
"region_code" : "string" ,
"region_id" : 0 ,
"region_name" : "string" ,
"relay_url" : {
"forceQuery" : true ,
"fragment" : "string" ,
"host" : "string" ,
"omitHost" : true ,
"opaque" : "string" ,
"path" : "string" ,
"rawFragment" : "string" ,
"rawPath" : "string" ,
"rawQuery" : "string" ,
"scheme" : "string" ,
"user" : {}
},
"stun_addresses" : ["string" ]
}
},
"disable_owner_workspace_exec" : true ,
"disable_password_auth" : true ,
"disable_path_apps" : true ,
"disable_session_expiry_refresh" : true ,
"experiments" : ["string" ],
"git_auth" : {
"value" : [
{
"auth_url" : "string" ,
"client_id" : "string" ,
"id" : "string" ,
"no_refresh" : true ,
"regex" : "string" ,
"scopes" : ["string" ],
"token_url" : "string" ,
"type" : "string" ,
"validate_url" : "string"
}
]
},
"http_address" : "string" ,
"in_memory_database" : true ,
"logging" : {
"human" : "string" ,
"json" : "string" ,
"stackdriver" : "string"
},
"max_session_expiry" : 0 ,
"max_token_lifetime" : 0 ,
"metrics_cache_refresh_interval" : 0 ,
"oauth2" : {
"github" : {
"allow_everyone" : true ,
"allow_signups" : true ,
"allowed_orgs" : ["string" ],
"allowed_teams" : ["string" ],
"client_id" : "string" ,
"client_secret" : "string" ,
"enterprise_base_url" : "string"
}
},
"oidc" : {
"allow_signups" : true ,
"auth_url_params" : {},
"client_id" : "string" ,
"client_secret" : "string" ,
"email_domain" : ["string" ],
"email_field" : "string" ,
"group_mapping" : {},
"groups_field" : "string" ,
"icon_url" : {
"forceQuery" : true ,
"fragment" : "string" ,
"host" : "string" ,
"omitHost" : true ,
"opaque" : "string" ,
"path" : "string" ,
"rawFragment" : "string" ,
"rawPath" : "string" ,
"rawQuery" : "string" ,
"scheme" : "string" ,
"user" : {}
},
"ignore_email_verified" : true ,
"ignore_user_info" : true ,
"issuer_url" : "string" ,
"scopes" : ["string" ],
"sign_in_text" : "string" ,
"username_field" : "string"
},
"pg_connection_url" : "string" ,
"pprof" : {
"address" : {
"host" : "string" ,
"port" : "string"
},
"enable" : true
},
"prometheus" : {
"address" : {
"host" : "string" ,
"port" : "string"
},
"collect_agent_stats" : true ,
"enable" : true
},
"provisioner" : {
"daemon_poll_interval" : 0 ,
"daemon_poll_jitter" : 0 ,
"daemons" : 0 ,
"force_cancel_interval" : 0
},
"proxy_trusted_headers" : ["string" ],
"proxy_trusted_origins" : ["string" ],
"rate_limit" : {
"api" : 0 ,
"disable_all" : true
},
"redirect_to_access_url" : true ,
"scim_api_key" : "string" ,
"secure_auth_cookie" : true ,
"ssh_keygen_algorithm" : "string" ,
"strict_transport_security" : 0 ,
"strict_transport_security_options" : ["string" ],
"support" : {
"links" : {
"value" : [
{
"icon" : "string" ,
"name" : "string" ,
"target" : "string"
}
]
}
},
"swagger" : {
"enable" : true
},
"telemetry" : {
"enable" : true ,
"trace" : true ,
"url" : {
"forceQuery" : true ,
"fragment" : "string" ,
"host" : "string" ,
"omitHost" : true ,
"opaque" : "string" ,
"path" : "string" ,
"rawFragment" : "string" ,
"rawPath" : "string" ,
"rawQuery" : "string" ,
"scheme" : "string" ,
"user" : {}
}
},
"tls" : {
"address" : {
"host" : "string" ,
"port" : "string"
},
"cert_file" : ["string" ],
"client_auth" : "string" ,
"client_ca_file" : "string" ,
"client_cert_file" : "string" ,
"client_key_file" : "string" ,
"enable" : true ,
"key_file" : ["string" ],
"min_version" : "string" ,
"redirect_http" : true
},
"trace" : {
"capture_logs" : true ,
"enable" : true ,
"honeycomb_api_key" : "string"
},
"update_check" : true ,
"verbose" : true ,
"wgtunnel_host" : "string" ,
"wildcard_access_url" : {
"forceQuery" : true ,
"fragment" : "string" ,
"host" : "string" ,
"omitHost" : true ,
"opaque" : "string" ,
"path" : "string" ,
"rawFragment" : "string" ,
"rawPath" : "string" ,
"rawQuery" : "string" ,
"scheme" : "string" ,
"user" : {}
},
"write_config" : true
},
"options" : [
{
"annotations" : {
"property1" : "string" ,
"property2" : "string"
},
"default" : "string" ,
"description" : "string" ,
"env" : "string" ,
"flag" : "string" ,
"flag_shorthand" : "string" ,
"group" : {
"description" : "string" ,
"name" : "string" ,
"parent" : {
"description" : "string" ,
"name" : "string" ,
"parent" : {},
"yaml" : "string"
},
"yaml" : "string"
},
"hidden" : true ,
"name" : "string" ,
"use_instead" : [{}],
"value" : null ,
"value_source" : "" ,
"yaml" : "string"
}
]
}
Properties
codersdk.DeploymentStats
{
"aggregated_from" : "2019-08-24T14:15:22Z" ,
"collected_at" : "2019-08-24T14:15:22Z" ,
"next_update_at" : "2019-08-24T14:15:22Z" ,
"session_count" : {
"jetbrains" : 0 ,
"reconnecting_pty" : 0 ,
"ssh" : 0 ,
"vscode" : 0
},
"workspaces" : {
"building" : 0 ,
"connection_latency_ms" : {
"p50" : 0 ,
"p95" : 0
},
"failed" : 0 ,
"pending" : 0 ,
"running" : 0 ,
"rx_bytes" : 0 ,
"stopped" : 0 ,
"tx_bytes" : 0
}
}
Properties
Name Type Required Restrictions Description aggregated_from
string false Aggregated from is the time in which stats are aggregated from. This might be back in time a specific duration or interval. collected_at
string false Collected at is the time in which stats are collected at. next_update_at
string false Next update at is the time when the next batch of stats will be updated. session_count
codersdk.SessionCountDeploymentStats false workspaces
codersdk.WorkspaceDeploymentStats false
codersdk.DeploymentValues
{
"access_url" : {
"forceQuery" : true ,
"fragment" : "string" ,
"host" : "string" ,
"omitHost" : true ,
"opaque" : "string" ,
"path" : "string" ,
"rawFragment" : "string" ,
"rawPath" : "string" ,
"rawQuery" : "string" ,
"scheme" : "string" ,
"user" : {}
},
"address" : {
"host" : "string" ,
"port" : "string"
},
"agent_fallback_troubleshooting_url" : {
"forceQuery" : true ,
"fragment" : "string" ,
"host" : "string" ,
"omitHost" : true ,
"opaque" : "string" ,
"path" : "string" ,
"rawFragment" : "string" ,
"rawPath" : "string" ,
"rawQuery" : "string" ,
"scheme" : "string" ,
"user" : {}
},
"agent_stat_refresh_interval" : 0 ,
"autobuild_poll_interval" : 0 ,
"browser_only" : true ,
"cache_directory" : "string" ,
"config" : "string" ,
"config_ssh" : {
"deploymentName" : "string" ,
"sshconfigOptions" : ["string" ]
},
"dangerous" : {
"allow_all_cors" : true ,
"allow_path_app_sharing" : true ,
"allow_path_app_site_owner_access" : true
},
"derp" : {
"config" : {
"path" : "string" ,
"url" : "string"
},
"server" : {
"enable" : true ,
"region_code" : "string" ,
"region_id" : 0 ,
"region_name" : "string" ,
"relay_url" : {
"forceQuery" : true ,
"fragment" : "string" ,
"host" : "string" ,
"omitHost" : true ,
"opaque" : "string" ,
"path" : "string" ,
"rawFragment" : "string" ,
"rawPath" : "string" ,
"rawQuery" : "string" ,
"scheme" : "string" ,
"user" : {}
},
"stun_addresses" : ["string" ]
}
},
"disable_owner_workspace_exec" : true ,
"disable_password_auth" : true ,
"disable_path_apps" : true ,
"disable_session_expiry_refresh" : true ,
"experiments" : ["string" ],
"git_auth" : {
"value" : [
{
"auth_url" : "string" ,
"client_id" : "string" ,
"id" : "string" ,
"no_refresh" : true ,
"regex" : "string" ,
"scopes" : ["string" ],
"token_url" : "string" ,
"type" : "string" ,
"validate_url" : "string"
}
]
},
"http_address" : "string" ,
"in_memory_database" : true ,
"logging" : {
"human" : "string" ,
"json" : "string" ,
"stackdriver" : "string"
},
"max_session_expiry" : 0 ,
"max_token_lifetime" : 0 ,
"metrics_cache_refresh_interval" : 0 ,
"oauth2" : {
"github" : {
"allow_everyone" : true ,
"allow_signups" : true ,
"allowed_orgs" : ["string" ],
"allowed_teams" : ["string" ],
"client_id" : "string" ,
"client_secret" : "string" ,
"enterprise_base_url" : "string"
}
},
"oidc" : {
"allow_signups" : true ,
"auth_url_params" : {},
"client_id" : "string" ,
"client_secret" : "string" ,
"email_domain" : ["string" ],
"email_field" : "string" ,
"group_mapping" : {},
"groups_field" : "string" ,
"icon_url" : {
"forceQuery" : true ,
"fragment" : "string" ,
"host" : "string" ,
"omitHost" : true ,
"opaque" : "string" ,
"path" : "string" ,
"rawFragment" : "string" ,
"rawPath" : "string" ,
"rawQuery" : "string" ,
"scheme" : "string" ,
"user" : {}
},
"ignore_email_verified" : true ,
"ignore_user_info" : true ,
"issuer_url" : "string" ,
"scopes" : ["string" ],
"sign_in_text" : "string" ,
"username_field" : "string"
},
"pg_connection_url" : "string" ,
"pprof" : {
"address" : {
"host" : "string" ,
"port" : "string"
},
"enable" : true
},
"prometheus" : {
"address" : {
"host" : "string" ,
"port" : "string"
},
"collect_agent_stats" : true ,
"enable" : true
},
"provisioner" : {
"daemon_poll_interval" : 0 ,
"daemon_poll_jitter" : 0 ,
"daemons" : 0 ,
"force_cancel_interval" : 0
},
"proxy_trusted_headers" : ["string" ],
"proxy_trusted_origins" : ["string" ],
"rate_limit" : {
"api" : 0 ,
"disable_all" : true
},
"redirect_to_access_url" : true ,
"scim_api_key" : "string" ,
"secure_auth_cookie" : true ,
"ssh_keygen_algorithm" : "string" ,
"strict_transport_security" : 0 ,
"strict_transport_security_options" : ["string" ],
"support" : {
"links" : {
"value" : [
{
"icon" : "string" ,
"name" : "string" ,
"target" : "string"
}
]
}
},
"swagger" : {
"enable" : true
},
"telemetry" : {
"enable" : true ,
"trace" : true ,
"url" : {
"forceQuery" : true ,
"fragment" : "string" ,
"host" : "string" ,
"omitHost" : true ,
"opaque" : "string" ,
"path" : "string" ,
"rawFragment" : "string" ,
"rawPath" : "string" ,
"rawQuery" : "string" ,
"scheme" : "string" ,
"user" : {}
}
},
"tls" : {
"address" : {
"host" : "string" ,
"port" : "string"
},
"cert_file" : ["string" ],
"client_auth" : "string" ,
"client_ca_file" : "string" ,
"client_cert_file" : "string" ,
"client_key_file" : "string" ,
"enable" : true ,
"key_file" : ["string" ],
"min_version" : "string" ,
"redirect_http" : true
},
"trace" : {
"capture_logs" : true ,
"enable" : true ,
"honeycomb_api_key" : "string"
},
"update_check" : true ,
"verbose" : true ,
"wgtunnel_host" : "string" ,
"wildcard_access_url" : {
"forceQuery" : true ,
"fragment" : "string" ,
"host" : "string" ,
"omitHost" : true ,
"opaque" : "string" ,
"path" : "string" ,
"rawFragment" : "string" ,
"rawPath" : "string" ,
"rawQuery" : "string" ,
"scheme" : "string" ,
"user" : {}
},
"write_config" : true
}
Properties
codersdk.Entitlement
Properties
Enumerated Values
Value entitled
grace_period
not_entitled
codersdk.Entitlements
{
"errors" : ["string" ],
"features" : {
"property1" : {
"actual" : 0 ,
"enabled" : true ,
"entitlement" : "entitled" ,
"limit" : 0
},
"property2" : {
"actual" : 0 ,
"enabled" : true ,
"entitlement" : "entitled" ,
"limit" : 0
}
},
"has_license" : true ,
"require_telemetry" : true ,
"trial" : true ,
"warnings" : ["string" ]
}
Properties
Name Type Required Restrictions Description errors
array of string false features
object false » [any property]
codersdk.Feature false has_license
boolean false require_telemetry
boolean false trial
boolean false warnings
array of string false
codersdk.Experiment
Properties
Enumerated Values
Value moons
workspace_actions
workspace_filter
codersdk.Feature
{
"actual" : 0 ,
"enabled" : true ,
"entitlement" : "entitled" ,
"limit" : 0
}
Properties
Name Type Required Restrictions Description actual
integer false enabled
boolean false entitlement
codersdk.Entitlement false limit
integer false
codersdk.GenerateAPIKeyResponse
Properties
Name Type Required Restrictions Description key
string false
codersdk.GetUsersResponse
{
"count" : 0 ,
"users" : [
{
"avatar_url" : "http://example.com" ,
"created_at" : "2019-08-24T14:15:22Z" ,
"email" : "[email protected] " ,
"id" : "497f6eca-6276-4993-bfeb-53cbbbba6f08" ,
"last_seen_at" : "2019-08-24T14:15:22Z" ,
"organization_ids" : ["497f6eca-6276-4993-bfeb-53cbbbba6f08" ],
"roles" : [
{
"display_name" : "string" ,
"name" : "string"
}
],
"status" : "active" ,
"username" : "string"
}
]
}
Properties
Name Type Required Restrictions Description count
integer false users
array of codersdk.User false
codersdk.GitAuthConfig
{
"auth_url" : "string" ,
"client_id" : "string" ,
"id" : "string" ,
"no_refresh" : true ,
"regex" : "string" ,
"scopes" : ["string" ],
"token_url" : "string" ,
"type" : "string" ,
"validate_url" : "string"
}
Properties
Name Type Required Restrictions Description auth_url
string false client_id
string false id
string false no_refresh
boolean false regex
string false scopes
array of string false token_url
string false type
string false validate_url
string false
codersdk.GitProvider
Properties
Enumerated Values
Value azure-devops
github
gitlab
bitbucket
codersdk.GitSSHKey
{
"created_at" : "2019-08-24T14:15:22Z" ,
"public_key" : "string" ,
"updated_at" : "2019-08-24T14:15:22Z" ,
"user_id" : "a169451c-8525-4352-b8ca-070dd449a1a5"
}
Properties
Name Type Required Restrictions Description created_at
string false public_key
string false updated_at
string false user_id
string false
codersdk.Group
{
"avatar_url" : "string" ,
"id" : "497f6eca-6276-4993-bfeb-53cbbbba6f08" ,
"members" : [
{
"avatar_url" : "http://example.com" ,
"created_at" : "2019-08-24T14:15:22Z" ,
"email" : "[email protected] " ,
"id" : "497f6eca-6276-4993-bfeb-53cbbbba6f08" ,
"last_seen_at" : "2019-08-24T14:15:22Z" ,
"organization_ids" : ["497f6eca-6276-4993-bfeb-53cbbbba6f08" ],
"roles" : [
{
"display_name" : "string" ,
"name" : "string"
}
],
"status" : "active" ,
"username" : "string"
}
],
"name" : "string" ,
"organization_id" : "7c60d51f-b44e-4682-87d6-449835ea4de6" ,
"quota_allowance" : 0
}
Properties
Name Type Required Restrictions Description avatar_url
string false id
string false members
array of codersdk.User false name
string false organization_id
string false quota_allowance
integer false
codersdk.Healthcheck
{
"interval" : 0 ,
"threshold" : 0 ,
"url" : "string"
}
Properties
Name Type Required Restrictions Description interval
integer false Interval specifies the seconds between each health check. threshold
integer false Threshold specifies the number of consecutive failed health checks before returning "unhealthy". url
string false URL specifies the endpoint to check for the app health.
codersdk.IssueReconnectingPTYSignedTokenRequest
{
"agentID" : "bc282582-04f9-45ce-b904-3e3bfab66958" ,
"url" : "string"
}
Properties
Name Type Required Restrictions Description agentID
string true url
string true URL is the URL of the reconnecting-pty endpoint you are connecting to.
codersdk.IssueReconnectingPTYSignedTokenResponse
{
"signed_token" : "string"
}
Properties
Name Type Required Restrictions Description signed_token
string false
codersdk.JobErrorCode
"MISSING_TEMPLATE_PARAMETER"
Properties
Enumerated Values
Value MISSING_TEMPLATE_PARAMETER
REQUIRED_TEMPLATE_VARIABLES
codersdk.License
{
"claims" : {},
"id" : 0 ,
"uploaded_at" : "2019-08-24T14:15:22Z" ,
"uuid" : "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"
}
Properties
Name Type Required Restrictions Description claims
object false 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. id
integer false uploaded_at
string false uuid
string false
codersdk.LinkConfig
{
"icon" : "string" ,
"name" : "string" ,
"target" : "string"
}
Properties
Name Type Required Restrictions Description icon
string false name
string false target
string false
codersdk.LogLevel
Properties
Enumerated Values
Value trace
debug
info
warn
error
codersdk.LogSource
Properties
Enumerated Values
Value provisioner_daemon
provisioner
codersdk.LoggingConfig
{
"human" : "string" ,
"json" : "string" ,
"stackdriver" : "string"
}
Properties
Name Type Required Restrictions Description human
string false json
string false stackdriver
string false
codersdk.LoginType
Properties
Enumerated Values
Value password
github
oidc
token
codersdk.LoginWithPasswordRequest
Properties
Name Type Required Restrictions Description email
string true password
string true
codersdk.LoginWithPasswordResponse
{
"session_token" : "string"
}
Properties
Name Type Required Restrictions Description session_token
string true
codersdk.OAuth2Config
{
"github" : {
"allow_everyone" : true ,
"allow_signups" : true ,
"allowed_orgs" : ["string" ],
"allowed_teams" : ["string" ],
"client_id" : "string" ,
"client_secret" : "string" ,
"enterprise_base_url" : "string"
}
}
Properties
codersdk.OAuth2GithubConfig
{
"allow_everyone" : true ,
"allow_signups" : true ,
"allowed_orgs" : ["string" ],
"allowed_teams" : ["string" ],
"client_id" : "string" ,
"client_secret" : "string" ,
"enterprise_base_url" : "string"
}
Properties
Name Type Required Restrictions Description allow_everyone
boolean false allow_signups
boolean false allowed_orgs
array of string false allowed_teams
array of string false client_id
string false client_secret
string false enterprise_base_url
string false
codersdk.OIDCAuthMethod
{
"enabled" : true ,
"iconUrl" : "string" ,
"signInText" : "string"
}
Properties
Name Type Required Restrictions Description enabled
boolean false iconUrl
string false signInText
string false
codersdk.OIDCConfig
{
"allow_signups" : true ,
"auth_url_params" : {},
"client_id" : "string" ,
"client_secret" : "string" ,
"email_domain" : ["string" ],
"email_field" : "string" ,
"group_mapping" : {},
"groups_field" : "string" ,
"icon_url" : {
"forceQuery" : true ,
"fragment" : "string" ,
"host" : "string" ,
"omitHost" : true ,
"opaque" : "string" ,
"path" : "string" ,
"rawFragment" : "string" ,
"rawPath" : "string" ,
"rawQuery" : "string" ,
"scheme" : "string" ,
"user" : {}
},
"ignore_email_verified" : true ,
"ignore_user_info" : true ,
"issuer_url" : "string" ,
"scopes" : ["string" ],
"sign_in_text" : "string" ,
"username_field" : "string"
}
Properties
Name Type Required Restrictions Description allow_signups
boolean false auth_url_params
object false client_id
string false client_secret
string false email_domain
array of string false email_field
string false group_mapping
object false groups_field
string false icon_url
clibase.URL false ignore_email_verified
boolean false ignore_user_info
boolean false issuer_url
string false scopes
array of string false sign_in_text
string false username_field
string false
codersdk.Organization
{
"created_at" : "2019-08-24T14:15:22Z" ,
"id" : "497f6eca-6276-4993-bfeb-53cbbbba6f08" ,
"name" : "string" ,
"updated_at" : "2019-08-24T14:15:22Z"
}
Properties
Name Type Required Restrictions Description created_at
string true id
string true name
string true updated_at
string true
codersdk.OrganizationMember
{
"created_at" : "2019-08-24T14:15:22Z" ,
"organization_id" : "7c60d51f-b44e-4682-87d6-449835ea4de6" ,
"roles" : [
{
"display_name" : "string" ,
"name" : "string"
}
],
"updated_at" : "2019-08-24T14:15:22Z" ,
"user_id" : "a169451c-8525-4352-b8ca-070dd449a1a5"
}
Properties
Name Type Required Restrictions Description created_at
string false organization_id
string false roles
array of codersdk.Role false updated_at
string false user_id
string false
codersdk.PatchTemplateVersionRequest
Properties
Name Type Required Restrictions Description name
string false
codersdk.PatchWorkspaceProxy
{
"display_name" : "string" ,
"icon" : "string" ,
"id" : "497f6eca-6276-4993-bfeb-53cbbbba6f08" ,
"name" : "string" ,
"regenerate_token" : true
}
Properties
Name Type Required Restrictions Description display_name
string true icon
string true id
string true name
string true regenerate_token
boolean false
codersdk.PprofConfig
{
"address" : {
"host" : "string" ,
"port" : "string"
},
"enable" : true
}
Properties
Name Type Required Restrictions Description address
clibase.HostPort false enable
boolean false
codersdk.PrometheusConfig
{
"address" : {
"host" : "string" ,
"port" : "string"
},
"collect_agent_stats" : true ,
"enable" : true
}
Properties
Name Type Required Restrictions Description address
clibase.HostPort false collect_agent_stats
boolean false enable
boolean false
codersdk.ProvisionerConfig
{
"daemon_poll_interval" : 0 ,
"daemon_poll_jitter" : 0 ,
"daemons" : 0 ,
"force_cancel_interval" : 0
}
Properties
Name Type Required Restrictions Description daemon_poll_interval
integer false daemon_poll_jitter
integer false daemons
integer false force_cancel_interval
integer false
codersdk.ProvisionerDaemon
{
"created_at" : "2019-08-24T14:15:22Z" ,
"id" : "497f6eca-6276-4993-bfeb-53cbbbba6f08" ,
"name" : "string" ,
"provisioners" : ["string" ],
"tags" : {
"property1" : "string" ,
"property2" : "string"
},
"updated_at" : {
"time" : "string" ,
"valid" : true
}
}
Properties
Name Type Required Restrictions Description created_at
string false id
string false name
string false provisioners
array of string false tags
object false » [any property]
string false updated_at
sql.NullTime false
codersdk.ProvisionerJob
{
"canceled_at" : "2019-08-24T14:15:22Z" ,
"completed_at" : "2019-08-24T14:15:22Z" ,
"created_at" : "2019-08-24T14:15:22Z" ,
"error" : "string" ,
"error_code" : "MISSING_TEMPLATE_PARAMETER" ,
"file_id" : "8a0cfb4f-ddc9-436d-91bb-75133c583767" ,
"id" : "497f6eca-6276-4993-bfeb-53cbbbba6f08" ,
"started_at" : "2019-08-24T14:15:22Z" ,
"status" : "pending" ,
"tags" : {
"property1" : "string" ,
"property2" : "string"
},
"worker_id" : "ae5fa6f7-c55b-40c1-b40a-b36ac467652b"
}
Properties
Name Type Required Restrictions Description canceled_at
string false completed_at
string false created_at
string false error
string false error_code
codersdk.JobErrorCode false file_id
string false id
string false started_at
string false status
codersdk.ProvisionerJobStatus false tags
object false » [any property]
string false worker_id
string false
Enumerated Values
Property Value error_code
MISSING_TEMPLATE_PARAMETER
error_code
REQUIRED_TEMPLATE_VARIABLES
status
pending
status
running
status
succeeded
status
canceling
status
canceled
status
failed
codersdk.ProvisionerJobLog
{
"created_at" : "2019-08-24T14:15:22Z" ,
"id" : 0 ,
"log_level" : "trace" ,
"log_source" : "provisioner_daemon" ,
"output" : "string" ,
"stage" : "string"
}
Properties
Enumerated Values
Property Value log_level
trace
log_level
debug
log_level
info
log_level
warn
log_level
error
codersdk.ProvisionerJobStatus
Properties
Enumerated Values
Value pending
running
succeeded
canceling
canceled
failed
codersdk.ProvisionerLogLevel
Properties
Enumerated Values
codersdk.ProvisionerStorageMethod
Properties
Enumerated Values
codersdk.ProxyHealthReport
{
"errors" : ["string" ],
"warnings" : ["string" ]
}
Properties
Name Type Required Restrictions Description errors
array of string false Errors are problems that prevent the workspace proxy from being healthy warnings
array of string false Warnings do not prevent the workspace proxy from being healthy, but should be addressed.
codersdk.ProxyHealthStatus
Properties
Enumerated Values
Value ok
unreachable
unhealthy
unregistered
codersdk.PutExtendWorkspaceRequest
{
"deadline" : "2019-08-24T14:15:22Z"
}
Properties
Name Type Required Restrictions Description deadline
string true
codersdk.RBACResource
Properties
Enumerated Values
Value workspace
workspace_proxy
workspace_execution
application_connect
audit_log
template
group
file
provisioner_daemon
organization
assign_role
assign_org_role
api_key
user
user_data
organization_member
license
deployment_config
deployment_stats
replicas
debug_info
system
codersdk.RateLimitConfig
{
"api" : 0 ,
"disable_all" : true
}
Properties
Name Type Required Restrictions Description api
integer false disable_all
boolean false
codersdk.Region
{
"display_name" : "string" ,
"healthy" : true ,
"icon_url" : "string" ,
"id" : "497f6eca-6276-4993-bfeb-53cbbbba6f08" ,
"name" : "string" ,
"path_app_url" : "string" ,
"wildcard_hostname" : "string"
}
Properties
Name Type Required Restrictions Description display_name
string false healthy
boolean false icon_url
string false id
string false name
string false path_app_url
string false Path app URL is the URL to the base path for path apps. Optional unless wildcard_hostname is set. E.g. https://us.example.com wildcard_hostname
string false Wildcard hostname is the wildcard hostname for subdomain apps. E.g. _.us.example.com E.g. _--suffix.au.example.com Optional. Does not need to be on the same domain as PathAppURL.
codersdk.RegionsResponse
{
"regions" : [
{
"display_name" : "string" ,
"healthy" : true ,
"icon_url" : "string" ,
"id" : "497f6eca-6276-4993-bfeb-53cbbbba6f08" ,
"name" : "string" ,
"path_app_url" : "string" ,
"wildcard_hostname" : "string"
}
]
}
Properties
Name Type Required Restrictions Description regions
array of codersdk.Region false
codersdk.Replica
{
"created_at" : "2019-08-24T14:15:22Z" ,
"database_latency" : 0 ,
"error" : "string" ,
"hostname" : "string" ,
"id" : "497f6eca-6276-4993-bfeb-53cbbbba6f08" ,
"region_id" : 0 ,
"relay_address" : "string"
}
Properties
Name Type Required Restrictions Description created_at
string false Created at is the timestamp when the replica was first seen. database_latency
integer false Database latency is the latency in microseconds to the database. error
string false Error is the replica error. hostname
string false Hostname is the hostname of the replica. id
string false ID is the unique identifier for the replica. region_id
integer false Region ID is the region of the replica. relay_address
string false Relay address is the accessible address to relay DERP connections.
codersdk.ResourceType
Properties
Enumerated Values
Value template
template_version
user
workspace
workspace_build
git_ssh_key
api_key
group
license
codersdk.Response
{
"detail" : "string" ,
"message" : "string" ,
"validations" : [
{
"detail" : "string" ,
"field" : "string"
}
]
}
Properties
Name Type Required Restrictions Description detail
string false 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" message
string false 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." validations
array of codersdk.ValidationError false 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'.
codersdk.Role
{
"display_name" : "string" ,
"name" : "string"
}
Properties
Name Type Required Restrictions Description display_name
string false name
string false
codersdk.SSHConfig
{
"deploymentName" : "string" ,
"sshconfigOptions" : ["string" ]
}
Properties
Name Type Required Restrictions Description deploymentName
string false Deploymentname is the config-ssh Hostname prefix sshconfigOptions
array of string false Sshconfigoptions are additional options to add to the ssh config file. This will override defaults.
codersdk.SSHConfigResponse
{
"hostname_prefix" : "string" ,
"ssh_config_options" : {
"property1" : "string" ,
"property2" : "string"
}
}
Properties
Name Type Required Restrictions Description hostname_prefix
string false ssh_config_options
object false » [any property]
string false
codersdk.ServiceBannerConfig
{
"background_color" : "string" ,
"enabled" : true ,
"message" : "string"
}
Properties
Name Type Required Restrictions Description background_color
string false enabled
boolean false message
string false
codersdk.SessionCountDeploymentStats
{
"jetbrains" : 0 ,
"reconnecting_pty" : 0 ,
"ssh" : 0 ,
"vscode" : 0
}
Properties
Name Type Required Restrictions Description jetbrains
integer false reconnecting_pty
integer false ssh
integer false vscode
integer false
codersdk.SupportConfig
{
"links" : {
"value" : [
{
"icon" : "string" ,
"name" : "string" ,
"target" : "string"
}
]
}
}
Properties
codersdk.SwaggerConfig
Properties
Name Type Required Restrictions Description enable
boolean false
codersdk.TLSConfig
{
"address" : {
"host" : "string" ,
"port" : "string"
},
"cert_file" : ["string" ],
"client_auth" : "string" ,
"client_ca_file" : "string" ,
"client_cert_file" : "string" ,
"client_key_file" : "string" ,
"enable" : true ,
"key_file" : ["string" ],
"min_version" : "string" ,
"redirect_http" : true
}
Properties
Name Type Required Restrictions Description address
clibase.HostPort false cert_file
array of string false client_auth
string false client_ca_file
string false client_cert_file
string false client_key_file
string false enable
boolean false key_file
array of string false min_version
string false redirect_http
boolean false
codersdk.TelemetryConfig
{
"enable" : true ,
"trace" : true ,
"url" : {
"forceQuery" : true ,
"fragment" : "string" ,
"host" : "string" ,
"omitHost" : true ,
"opaque" : "string" ,
"path" : "string" ,
"rawFragment" : "string" ,
"rawPath" : "string" ,
"rawQuery" : "string" ,
"scheme" : "string" ,
"user" : {}
}
}
Properties
Name Type Required Restrictions Description enable
boolean false trace
boolean false url
clibase.URL false
codersdk.Template
{
"active_user_count" : 0 ,
"active_version_id" : "eae64611-bd53-4a80-bb77-df1e432c0fbc" ,
"allow_user_autostart" : true ,
"allow_user_autostop" : true ,
"allow_user_cancel_workspace_jobs" : true ,
"build_time_stats" : {
"property1" : {
"p50" : 123 ,
"p95" : 146
},
"property2" : {
"p50" : 123 ,
"p95" : 146
}
},
"created_at" : "2019-08-24T14:15:22Z" ,
"created_by_id" : "9377d689-01fb-4abf-8450-3368d2c1924f" ,
"created_by_name" : "string" ,
"default_ttl_ms" : 0 ,
"description" : "string" ,
"display_name" : "string" ,
"failure_ttl_ms" : 0 ,
"icon" : "string" ,
"id" : "497f6eca-6276-4993-bfeb-53cbbbba6f08" ,
"inactivity_ttl_ms" : 0 ,
"max_ttl_ms" : 0 ,
"name" : "string" ,
"organization_id" : "7c60d51f-b44e-4682-87d6-449835ea4de6" ,
"provisioner" : "terraform" ,
"updated_at" : "2019-08-24T14:15:22Z"
}
Properties
Name Type Required Restrictions Description active_user_count
integer false Active user count is set to -1 when loading. active_version_id
string false allow_user_autostart
boolean false Allow user autostart and AllowUserAutostop are enterprise-only. Their values are only used if your license is entitled to use the advanced template scheduling feature. allow_user_autostop
boolean false allow_user_cancel_workspace_jobs
boolean false build_time_stats
codersdk.TemplateBuildTimeStats false created_at
string false created_by_id
string false created_by_name
string false default_ttl_ms
integer false description
string false display_name
string false failure_ttl_ms
integer false Failure ttl ms and InactivityTTLMillis are enterprise-only. Their values are used if your license is entitled to use the advanced template scheduling feature. icon
string false id
string false inactivity_ttl_ms
integer false max_ttl_ms
integer false Max ttl ms is an enterprise feature. It's value is only used if your license is entitled to use the advanced template scheduling feature. name
string false organization_id
string false provisioner
string false updated_at
string false
Enumerated Values
Property Value provisioner
terraform
codersdk.TemplateBuildTimeStats
{
"property1" : {
"p50" : 123 ,
"p95" : 146
},
"property2" : {
"p50" : 123 ,
"p95" : 146
}
}
Properties
codersdk.TemplateExample
{
"description" : "string" ,
"icon" : "string" ,
"id" : "497f6eca-6276-4993-bfeb-53cbbbba6f08" ,
"markdown" : "string" ,
"name" : "string" ,
"tags" : ["string" ],
"url" : "string"
}
Properties
Name Type Required Restrictions Description description
string false icon
string false id
string false markdown
string false name
string false tags
array of string false url
string false
codersdk.TemplateRole
Properties
Enumerated Values
codersdk.TemplateUser
{
"avatar_url" : "http://example.com" ,
"created_at" : "2019-08-24T14:15:22Z" ,
"email" : "[email protected] " ,
"id" : "497f6eca-6276-4993-bfeb-53cbbbba6f08" ,
"last_seen_at" : "2019-08-24T14:15:22Z" ,
"organization_ids" : ["497f6eca-6276-4993-bfeb-53cbbbba6f08" ],
"role" : "admin" ,
"roles" : [
{
"display_name" : "string" ,
"name" : "string"
}
],
"status" : "active" ,
"username" : "string"
}
Properties
Name Type Required Restrictions Description avatar_url
string false created_at
string true email
string true id
string true last_seen_at
string false organization_ids
array of string false role
codersdk.TemplateRole false roles
array of codersdk.Role false status
codersdk.UserStatus false username
string true
Enumerated Values
Property Value role
admin
role
use
status
active
status
suspended
codersdk.TemplateVersion
{
"created_at" : "2019-08-24T14:15:22Z" ,
"created_by" : {
"avatar_url" : "http://example.com" ,
"created_at" : "2019-08-24T14:15:22Z" ,
"email" : "[email protected] " ,
"id" : "497f6eca-6276-4993-bfeb-53cbbbba6f08" ,
"last_seen_at" : "2019-08-24T14:15:22Z" ,
"organization_ids" : ["497f6eca-6276-4993-bfeb-53cbbbba6f08" ],
"roles" : [
{
"display_name" : "string" ,
"name" : "string"
}
],
"status" : "active" ,
"username" : "string"
},
"id" : "497f6eca-6276-4993-bfeb-53cbbbba6f08" ,
"job" : {
"canceled_at" : "2019-08-24T14:15:22Z" ,
"completed_at" : "2019-08-24T14:15:22Z" ,
"created_at" : "2019-08-24T14:15:22Z" ,
"error" : "string" ,
"error_code" : "MISSING_TEMPLATE_PARAMETER" ,
"file_id" : "8a0cfb4f-ddc9-436d-91bb-75133c583767" ,
"id" : "497f6eca-6276-4993-bfeb-53cbbbba6f08" ,
"started_at" : "2019-08-24T14:15:22Z" ,
"status" : "pending" ,
"tags" : {
"property1" : "string" ,
"property2" : "string"
},
"worker_id" : "ae5fa6f7-c55b-40c1-b40a-b36ac467652b"
},
"name" : "string" ,
"organization_id" : "7c60d51f-b44e-4682-87d6-449835ea4de6" ,
"readme" : "string" ,
"template_id" : "c6d67e98-83ea-49f0-8812-e4abae2b68bc" ,
"updated_at" : "2019-08-24T14:15:22Z" ,
"warnings" : ["UNSUPPORTED_WORKSPACES" ]
}
Properties
codersdk.TemplateVersionGitAuth
{
"authenticate_url" : "string" ,
"authenticated" : true ,
"id" : "string" ,
"type" : "azure-devops"
}
Properties
Name Type Required Restrictions Description authenticate_url
string false authenticated
boolean false id
string false type
codersdk.GitProvider false
codersdk.TemplateVersionParameter
{
"default_value" : "string" ,
"description" : "string" ,
"description_plaintext" : "string" ,
"display_name" : "string" ,
"icon" : "string" ,
"legacy_variable_name" : "string" ,
"mutable" : true ,
"name" : "string" ,
"options" : [
{
"description" : "string" ,
"icon" : "string" ,
"name" : "string" ,
"value" : "string"
}
],
"required" : true ,
"type" : "string" ,
"validation_error" : "string" ,
"validation_max" : 0 ,
"validation_min" : 0 ,
"validation_monotonic" : "increasing" ,
"validation_regex" : "string"
}
Properties
Name Type Required Restrictions Description default_value
string false description
string false description_plaintext
string false display_name
string false icon
string false legacy_variable_name
string false mutable
boolean false name
string false options
array of codersdk.TemplateVersionParameterOption false required
boolean false type
string false validation_error
string false validation_max
integer false validation_min
integer false validation_monotonic
codersdk.ValidationMonotonicOrder false validation_regex
string false
Enumerated Values
Property Value type
string
type
number
type
bool
type
list(string)
validation_monotonic
increasing
validation_monotonic
decreasing
codersdk.TemplateVersionParameterOption
{
"description" : "string" ,
"icon" : "string" ,
"name" : "string" ,
"value" : "string"
}
Properties
Name Type Required Restrictions Description description
string false icon
string false name
string false value
string false
codersdk.TemplateVersionVariable
{
"default_value" : "string" ,
"description" : "string" ,
"name" : "string" ,
"required" : true ,
"sensitive" : true ,
"type" : "string" ,
"value" : "string"
}
Properties
Name Type Required Restrictions Description default_value
string false description
string false name
string false required
boolean false sensitive
boolean false type
string false value
string false
Enumerated Values
Property Value type
string
type
number
type
bool
codersdk.TemplateVersionWarning
Properties
Enumerated Values
Value UNSUPPORTED_WORKSPACES
codersdk.TokenConfig
{
"max_token_lifetime" : 0
}
Properties
Name Type Required Restrictions Description max_token_lifetime
integer false
codersdk.TraceConfig
{
"capture_logs" : true ,
"enable" : true ,
"honeycomb_api_key" : "string"
}
Properties
Name Type Required Restrictions Description capture_logs
boolean false enable
boolean false honeycomb_api_key
string false
codersdk.TransitionStats
{
"p50" : 123 ,
"p95" : 146
}
Properties
Name Type Required Restrictions Description p50
integer false p95
integer false
codersdk.UpdateActiveTemplateVersion
{
"id" : "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
Properties
Name Type Required Restrictions Description id
string true
codersdk.UpdateAppearanceConfig
{
"logo_url" : "string" ,
"service_banner" : {
"background_color" : "string" ,
"enabled" : true ,
"message" : "string"
}
}
Properties
codersdk.UpdateCheckResponse
{
"current" : true ,
"url" : "string" ,
"version" : "string"
}
Properties
Name Type Required Restrictions Description current
boolean false Current indicates whether the server version is the same as the latest. url
string false URL to download the latest release of Coder. version
string false Version is the semantic version for the latest release of Coder.
codersdk.UpdateRoles
Properties
Name Type Required Restrictions Description roles
array of string false
codersdk.UpdateTemplateACL
{
"group_perms" : {
"property1" : "admin" ,
"property2" : "admin"
},
"user_perms" : {
"property1" : "admin" ,
"property2" : "admin"
}
}
Properties
codersdk.UpdateUserPasswordRequest
{
"old_password" : "string" ,
"password" : "string"
}
Properties
Name Type Required Restrictions Description old_password
string false password
string true
codersdk.UpdateUserProfileRequest
Properties
Name Type Required Restrictions Description username
string true
codersdk.UpdateWorkspaceAutostartRequest
Properties
Name Type Required Restrictions Description schedule
string false
codersdk.UpdateWorkspaceRequest
Properties
Name Type Required Restrictions Description name
string false
codersdk.UpdateWorkspaceTTLRequest
Properties
Name Type Required Restrictions Description ttl_ms
integer false
codersdk.UploadResponse
{
"hash" : "19686d84-b10d-4f90-b18e-84fd3fa038fd"
}
Properties
Name Type Required Restrictions Description hash
string false
codersdk.User
{
"avatar_url" : "http://example.com" ,
"created_at" : "2019-08-24T14:15:22Z" ,
"email" : "[email protected] " ,
"id" : "497f6eca-6276-4993-bfeb-53cbbbba6f08" ,
"last_seen_at" : "2019-08-24T14:15:22Z" ,
"organization_ids" : ["497f6eca-6276-4993-bfeb-53cbbbba6f08" ],
"roles" : [
{
"display_name" : "string" ,
"name" : "string"
}
],
"status" : "active" ,
"username" : "string"
}
Properties
Name Type Required Restrictions Description avatar_url
string false created_at
string true email
string true id
string true last_seen_at
string false organization_ids
array of string false roles
array of codersdk.Role false status
codersdk.UserStatus false username
string true
Enumerated Values
Property Value status
active
status
suspended
codersdk.UserStatus
Properties
Enumerated Values
codersdk.ValidationError
{
"detail" : "string" ,
"field" : "string"
}
Properties
Name Type Required Restrictions Description detail
string true field
string true
codersdk.ValidationMonotonicOrder
Properties
Enumerated Values
Value increasing
decreasing
codersdk.VariableValue
{
"name" : "string" ,
"value" : "string"
}
Properties
Name Type Required Restrictions Description name
string false value
string false
codersdk.Workspace
{
"autostart_schedule" : "string" ,
"created_at" : "2019-08-24T14:15:22Z" ,
"deleting_at" : "2019-08-24T14:15:22Z" ,
"id" : "497f6eca-6276-4993-bfeb-53cbbbba6f08" ,
"last_used_at" : "2019-08-24T14:15:22Z" ,
"latest_build" : {
"build_number" : 0 ,
"created_at" : "2019-08-24T14:15:22Z" ,
"daily_cost" : 0 ,
"deadline" : "2019-08-24T14:15:22Z" ,
"id" : "497f6eca-6276-4993-bfeb-53cbbbba6f08" ,
"initiator_id" : "06588898-9a84-4b35-ba8f-f9cbd64946f3" ,
"initiator_name" : "string" ,
"job" : {
"canceled_at" : "2019-08-24T14:15:22Z" ,
"completed_at" : "2019-08-24T14:15:22Z" ,
"created_at" : "2019-08-24T14:15:22Z" ,
"error" : "string" ,
"error_code" : "MISSING_TEMPLATE_PARAMETER" ,
"file_id" : "8a0cfb4f-ddc9-436d-91bb-75133c583767" ,
"id" : "497f6eca-6276-4993-bfeb-53cbbbba6f08" ,
"started_at" : "2019-08-24T14:15:22Z" ,
"status" : "pending" ,
"tags" : {
"property1" : "string" ,
"property2" : "string"
},
"worker_id" : "ae5fa6f7-c55b-40c1-b40a-b36ac467652b"
},
"max_deadline" : "2019-08-24T14:15:22Z" ,
"reason" : "initiator" ,
"resources" : [
{
"agents" : [
{
"apps" : [
{
"command" : "string" ,
"display_name" : "string" ,
"external" : true ,
"health" : "disabled" ,
"healthcheck" : {
"interval" : 0 ,
"threshold" : 0 ,
"url" : "string"
},
"icon" : "string" ,
"id" : "497f6eca-6276-4993-bfeb-53cbbbba6f08" ,
"sharing_level" : "owner" ,
"slug" : "string" ,
"subdomain" : true ,
"url" : "string"
}
],
"architecture" : "string" ,
"connection_timeout_seconds" : 0 ,
"created_at" : "2019-08-24T14:15:22Z" ,
"directory" : "string" ,
"disconnected_at" : "2019-08-24T14:15:22Z" ,
"environment_variables" : {
"property1" : "string" ,
"property2" : "string"
},
"expanded_directory" : "string" ,
"first_connected_at" : "2019-08-24T14:15:22Z" ,
"id" : "497f6eca-6276-4993-bfeb-53cbbbba6f08" ,
"instance_id" : "string" ,
"last_connected_at" : "2019-08-24T14:15:22Z" ,
"latency" : {
"property1" : {
"latency_ms" : 0 ,
"preferred" : true
},
"property2" : {
"latency_ms" : 0 ,
"preferred" : true
}
},
"lifecycle_state" : "created" ,
"login_before_ready" : true ,
"name" : "string" ,
"operating_system" : "string" ,
"resource_id" : "4d5215ed-38bb-48ed-879a-fdb9ca58522f" ,
"shutdown_script" : "string" ,
"shutdown_script_timeout_seconds" : 0 ,
"startup_logs_length" : 0 ,
"startup_logs_overflowed" : true ,
"startup_script" : "string" ,
"startup_script_timeout_seconds" : 0 ,
"status" : "connecting" ,
"subsystem" : "envbox" ,
"troubleshooting_url" : "string" ,
"updated_at" : "2019-08-24T14:15:22Z" ,
"version" : "string"
}
],
"created_at" : "2019-08-24T14:15:22Z" ,
"daily_cost" : 0 ,
"hide" : true ,
"icon" : "string" ,
"id" : "497f6eca-6276-4993-bfeb-53cbbbba6f08" ,
"job_id" : "453bd7d7-5355-4d6d-a38e-d9e7eb218c3f" ,
"metadata" : [
{
"key" : "string" ,
"sensitive" : true ,
"value" : "string"
}
],
"name" : "string" ,
"type" : "string" ,
"workspace_transition" : "start"
}
],
"status" : "pending" ,
"template_version_id" : "0ba39c92-1f1b-4c32-aa3e-9925d7713eb1" ,
"template_version_name" : "string" ,
"transition" : "start" ,
"updated_at" : "2019-08-24T14:15:22Z" ,
"workspace_id" : "0967198e-ec7b-4c6b-b4d3-f71244cadbe9" ,
"workspace_name" : "string" ,
"workspace_owner_id" : "e7078695-5279-4c86-8774-3ac2367a2fc7" ,
"workspace_owner_name" : "string"
},
"name" : "string" ,
"organization_id" : "7c60d51f-b44e-4682-87d6-449835ea4de6" ,
"outdated" : true ,
"owner_id" : "8826ee2e-7933-4665-aef2-2393f84a0d05" ,
"owner_name" : "string" ,
"template_allow_user_cancel_workspace_jobs" : true ,
"template_display_name" : "string" ,
"template_icon" : "string" ,
"template_id" : "c6d67e98-83ea-49f0-8812-e4abae2b68bc" ,
"template_name" : "string" ,
"ttl_ms" : 0 ,
"updated_at" : "2019-08-24T14:15:22Z"
}
Properties
Name Type Required Restrictions Description autostart_schedule
string false created_at
string false deleting_at
string false Deleting at indicates the time of the upcoming workspace deletion, if applicable; otherwise it is nil. Workspaces may have impending deletions if Template.InactivityTTL feature is turned on and the workspace is inactive. id
string false last_used_at
string false latest_build
codersdk.WorkspaceBuild false name
string false organization_id
string false outdated
boolean false owner_id
string false owner_name
string false template_allow_user_cancel_workspace_jobs
boolean false template_display_name
string false template_icon
string false template_id
string false template_name
string false ttl_ms
integer false updated_at
string false
codersdk.WorkspaceAgent
{
"apps" : [
{
"command" : "string" ,
"display_name" : "string" ,
"external" : true ,
"health" : "disabled" ,
"healthcheck" : {
"interval" : 0 ,
"threshold" : 0 ,
"url" : "string"
},
"icon" : "string" ,
"id" : "497f6eca-6276-4993-bfeb-53cbbbba6f08" ,
"sharing_level" : "owner" ,
"slug" : "string" ,
"subdomain" : true ,
"url" : "string"
}
],
"architecture" : "string" ,
"connection_timeout_seconds" : 0 ,
"created_at" : "2019-08-24T14:15:22Z" ,
"directory" : "string" ,
"disconnected_at" : "2019-08-24T14:15:22Z" ,
"environment_variables" : {
"property1" : "string" ,
"property2" : "string"
},
"expanded_directory" : "string" ,
"first_connected_at" : "2019-08-24T14:15:22Z" ,
"id" : "497f6eca-6276-4993-bfeb-53cbbbba6f08" ,
"instance_id" : "string" ,
"last_connected_at" : "2019-08-24T14:15:22Z" ,
"latency" : {
"property1" : {
"latency_ms" : 0 ,
"preferred" : true
},
"property2" : {
"latency_ms" : 0 ,
"preferred" : true
}
},
"lifecycle_state" : "created" ,
"login_before_ready" : true ,
"name" : "string" ,
"operating_system" : "string" ,
"resource_id" : "4d5215ed-38bb-48ed-879a-fdb9ca58522f" ,
"shutdown_script" : "string" ,
"shutdown_script_timeout_seconds" : 0 ,
"startup_logs_length" : 0 ,
"startup_logs_overflowed" : true ,
"startup_script" : "string" ,
"startup_script_timeout_seconds" : 0 ,
"status" : "connecting" ,
"subsystem" : "envbox" ,
"troubleshooting_url" : "string" ,
"updated_at" : "2019-08-24T14:15:22Z" ,
"version" : "string"
}
Properties
Name Type Required Restrictions Description apps
array of codersdk.WorkspaceApp false architecture
string false connection_timeout_seconds
integer false created_at
string false directory
string false disconnected_at
string false environment_variables
object false » [any property]
string false expanded_directory
string false first_connected_at
string false id
string false instance_id
string false last_connected_at
string false latency
object false Latency is mapped by region name (e.g. "New York City", "Seattle"). » [any property]
codersdk.DERPRegion false lifecycle_state
codersdk.WorkspaceAgentLifecycle false login_before_ready
boolean false Login before ready if true, the agent will delay logins until it is ready (e.g. executing startup script has ended). name
string false operating_system
string false resource_id
string false shutdown_script
string false shutdown_script_timeout_seconds
integer false startup_logs_length
integer false startup_logs_overflowed
boolean false startup_script
string false startup_script_timeout_seconds
integer false Startup script timeout seconds is the number of seconds to wait for the startup script to complete. If the script does not complete within this time, the agent lifecycle will be marked as start_timeout. status
codersdk.WorkspaceAgentStatus false subsystem
codersdk.AgentSubsystem false troubleshooting_url
string false updated_at
string false version
string false
codersdk.WorkspaceAgentConnectionInfo
{
"derp_map" : {
"omitDefaultRegions" : true ,
"regions" : {
"property1" : {
"avoid" : true ,
"embeddedRelay" : true ,
"nodes" : [
{
"certName" : "string" ,
"derpport" : 0 ,
"forceHTTP" : true ,
"hostName" : "string" ,
"insecureForTests" : true ,
"ipv4" : "string" ,
"ipv6" : "string" ,
"name" : "string" ,
"regionID" : 0 ,
"stunonly" : true ,
"stunport" : 0 ,
"stuntestIP" : "string"
}
],
"regionCode" : "string" ,
"regionID" : 0 ,
"regionName" : "string"
},
"property2" : {
"avoid" : true ,
"embeddedRelay" : true ,
"nodes" : [
{
"certName" : "string" ,
"derpport" : 0 ,
"forceHTTP" : true ,
"hostName" : "string" ,
"insecureForTests" : true ,
"ipv4" : "string" ,
"ipv6" : "string" ,
"name" : "string" ,
"regionID" : 0 ,
"stunonly" : true ,
"stunport" : 0 ,
"stuntestIP" : "string"
}
],
"regionCode" : "string" ,
"regionID" : 0 ,
"regionName" : "string"
}
}
}
}
Properties
codersdk.WorkspaceAgentLifecycle
Properties
Enumerated Values
Value created
starting
start_timeout
start_error
ready
shutting_down
shutdown_timeout
shutdown_error
off
codersdk.WorkspaceAgentListeningPort
{
"network" : "string" ,
"port" : 0 ,
"process_name" : "string"
}
Properties
Name Type Required Restrictions Description network
string false only "tcp" at the moment port
integer false process_name
string false may be empty
codersdk.WorkspaceAgentListeningPortsResponse
{
"ports" : [
{
"network" : "string" ,
"port" : 0 ,
"process_name" : "string"
}
]
}
Properties
Name Type Required Restrictions Description ports
array of codersdk.WorkspaceAgentListeningPort false 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.
{
"display_name" : "string" ,
"interval" : 0 ,
"key" : "string" ,
"script" : "string" ,
"timeout" : 0
}
Properties
Name Type Required Restrictions Description display_name
string false interval
integer false key
string false script
string false timeout
integer false
codersdk.WorkspaceAgentStartupLog
{
"created_at" : "2019-08-24T14:15:22Z" ,
"id" : 0 ,
"level" : "trace" ,
"output" : "string"
}
Properties
Name Type Required Restrictions Description created_at
string false id
integer false level
codersdk.LogLevel false output
string false
codersdk.WorkspaceAgentStatus
Properties
Enumerated Values
Value connecting
connected
disconnected
timeout
codersdk.WorkspaceApp
{
"command" : "string" ,
"display_name" : "string" ,
"external" : true ,
"health" : "disabled" ,
"healthcheck" : {
"interval" : 0 ,
"threshold" : 0 ,
"url" : "string"
},
"icon" : "string" ,
"id" : "497f6eca-6276-4993-bfeb-53cbbbba6f08" ,
"sharing_level" : "owner" ,
"slug" : "string" ,
"subdomain" : true ,
"url" : "string"
}
Properties
Name Type Required Restrictions Description command
string false display_name
string false Display name is a friendly name for the app. external
boolean false External specifies whether the URL should be opened externally on the client or not. health
codersdk.WorkspaceAppHealth false healthcheck
codersdk.Healthcheck false Healthcheck specifies the configuration for checking app health. icon
string false Icon is a relative path or external URL that specifies an icon to be displayed in the dashboard. id
string false sharing_level
codersdk.WorkspaceAppSharingLevel false slug
string false Slug is a unique identifier within the agent. subdomain
boolean false 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. url
string false URL is the address being proxied to inside the workspace. If external is specified, this will be opened on the client.
Enumerated Values
Property Value sharing_level
owner
sharing_level
authenticated
sharing_level
public
codersdk.WorkspaceAppHealth
Properties
Enumerated Values
Value disabled
initializing
healthy
unhealthy
codersdk.WorkspaceAppSharingLevel
Properties
Enumerated Values
Value owner
authenticated
public
codersdk.WorkspaceBuild
{
"build_number" : 0 ,
"created_at" : "2019-08-24T14:15:22Z" ,
"daily_cost" : 0 ,
"deadline" : "2019-08-24T14:15:22Z" ,
"id" : "497f6eca-6276-4993-bfeb-53cbbbba6f08" ,
"initiator_id" : "06588898-9a84-4b35-ba8f-f9cbd64946f3" ,
"initiator_name" : "string" ,
"job" : {
"canceled_at" : "2019-08-24T14:15:22Z" ,
"completed_at" : "2019-08-24T14:15:22Z" ,
"created_at" : "2019-08-24T14:15:22Z" ,
"error" : "string" ,
"error_code" : "MISSING_TEMPLATE_PARAMETER" ,
"file_id" : "8a0cfb4f-ddc9-436d-91bb-75133c583767" ,
"id" : "497f6eca-6276-4993-bfeb-53cbbbba6f08" ,
"started_at" : "2019-08-24T14:15:22Z" ,
"status" : "pending" ,
"tags" : {
"property1" : "string" ,
"property2" : "string"
},
"worker_id" : "ae5fa6f7-c55b-40c1-b40a-b36ac467652b"
},
"max_deadline" : "2019-08-24T14:15:22Z" ,
"reason" : "initiator" ,
"resources" : [
{
"agents" : [
{
"apps" : [
{
"command" : "string" ,
"display_name" : "string" ,
"external" : true ,
"health" : "disabled" ,
"healthcheck" : {
"interval" : 0 ,
"threshold" : 0 ,
"url" : "string"
},
"icon" : "string" ,
"id" : "497f6eca-6276-4993-bfeb-53cbbbba6f08" ,
"sharing_level" : "owner" ,
"slug" : "string" ,
"subdomain" : true ,
"url" : "string"
}
],
"architecture" : "string" ,
"connection_timeout_seconds" : 0 ,
"created_at" : "2019-08-24T14:15:22Z" ,
"directory" : "string" ,
"disconnected_at" : "2019-08-24T14:15:22Z" ,
"environment_variables" : {
"property1" : "string" ,
"property2" : "string"
},
"expanded_directory" : "string" ,
"first_connected_at" : "2019-08-24T14:15:22Z" ,
"id" : "497f6eca-6276-4993-bfeb-53cbbbba6f08" ,
"instance_id" : "string" ,
"last_connected_at" : "2019-08-24T14:15:22Z" ,
"latency" : {
"property1" : {
"latency_ms" : 0 ,
"preferred" : true
},
"property2" : {
"latency_ms" : 0 ,
"preferred" : true
}
},
"lifecycle_state" : "created" ,
"login_before_ready" : true ,
"name" : "string" ,
"operating_system" : "string" ,
"resource_id" : "4d5215ed-38bb-48ed-879a-fdb9ca58522f" ,
"shutdown_script" : "string" ,
"shutdown_script_timeout_seconds" : 0 ,
"startup_logs_length" : 0 ,
"startup_logs_overflowed" : true ,
"startup_script" : "string" ,
"startup_script_timeout_seconds" : 0 ,
"status" : "connecting" ,
"subsystem" : "envbox" ,
"troubleshooting_url" : "string" ,
"updated_at" : "2019-08-24T14:15:22Z" ,
"version" : "string"
}
],
"created_at" : "2019-08-24T14:15:22Z" ,
"daily_cost" : 0 ,
"hide" : true ,
"icon" : "string" ,
"id" : "497f6eca-6276-4993-bfeb-53cbbbba6f08" ,
"job_id" : "453bd7d7-5355-4d6d-a38e-d9e7eb218c3f" ,
"metadata" : [
{
"key" : "string" ,
"sensitive" : true ,
"value" : "string"
}
],
"name" : "string" ,
"type" : "string" ,
"workspace_transition" : "start"
}
],
"status" : "pending" ,
"template_version_id" : "0ba39c92-1f1b-4c32-aa3e-9925d7713eb1" ,
"template_version_name" : "string" ,
"transition" : "start" ,
"updated_at" : "2019-08-24T14:15:22Z" ,
"workspace_id" : "0967198e-ec7b-4c6b-b4d3-f71244cadbe9" ,
"workspace_name" : "string" ,
"workspace_owner_id" : "e7078695-5279-4c86-8774-3ac2367a2fc7" ,
"workspace_owner_name" : "string"
}
Properties
Enumerated Values
Property Value reason
initiator
reason
autostart
reason
autostop
status
pending
status
starting
status
running
status
stopping
status
stopped
status
failed
status
canceling
status
canceled
status
deleting
status
deleted
transition
start
transition
stop
transition
delete
codersdk.WorkspaceBuildParameter
{
"name" : "string" ,
"value" : "string"
}
Properties
Name Type Required Restrictions Description name
string false value
string false
codersdk.WorkspaceConnectionLatencyMS
Properties
Name Type Required Restrictions Description p50
number false p95
number false
codersdk.WorkspaceDeploymentStats
{
"building" : 0 ,
"connection_latency_ms" : {
"p50" : 0 ,
"p95" : 0
},
"failed" : 0 ,
"pending" : 0 ,
"running" : 0 ,
"rx_bytes" : 0 ,
"stopped" : 0 ,
"tx_bytes" : 0
}
Properties
Name Type Required Restrictions Description building
integer false connection_latency_ms
codersdk.WorkspaceConnectionLatencyMS false failed
integer false pending
integer false running
integer false rx_bytes
integer false stopped
integer false tx_bytes
integer false
codersdk.WorkspaceProxy
{
"created_at" : "2019-08-24T14:15:22Z" ,
"deleted" : true ,
"display_name" : "string" ,
"icon" : "string" ,
"id" : "497f6eca-6276-4993-bfeb-53cbbbba6f08" ,
"name" : "string" ,
"status" : {
"checked_at" : "2019-08-24T14:15:22Z" ,
"report" : {
"errors" : ["string" ],
"warnings" : ["string" ]
},
"status" : "ok"
},
"updated_at" : "2019-08-24T14:15:22Z" ,
"url" : "string" ,
"wildcard_hostname" : "string"
}
Properties
Name Type Required Restrictions Description created_at
string false deleted
boolean false display_name
string false icon
string false id
string false name
string false status
codersdk.WorkspaceProxyStatus false Status is the latest status check of the proxy. This will be empty for deleted proxies. This value can be used to determine if a workspace proxy is healthy and ready to use. updated_at
string false url
string false Full URL including scheme of the proxy api url: https://us.example.com wildcard_hostname
string false Wildcard hostname with the wildcard for subdomain based app hosting: *.us.example.com
codersdk.WorkspaceProxyStatus
{
"checked_at" : "2019-08-24T14:15:22Z" ,
"report" : {
"errors" : ["string" ],
"warnings" : ["string" ]
},
"status" : "ok"
}
Properties
codersdk.WorkspaceQuota
{
"budget" : 0 ,
"credits_consumed" : 0
}
Properties
Name Type Required Restrictions Description budget
integer false credits_consumed
integer false
codersdk.WorkspaceResource
{
"agents" : [
{
"apps" : [
{
"command" : "string" ,
"display_name" : "string" ,
"external" : true ,
"health" : "disabled" ,
"healthcheck" : {
"interval" : 0 ,
"threshold" : 0 ,
"url" : "string"
},
"icon" : "string" ,
"id" : "497f6eca-6276-4993-bfeb-53cbbbba6f08" ,
"sharing_level" : "owner" ,
"slug" : "string" ,
"subdomain" : true ,
"url" : "string"
}
],
"architecture" : "string" ,
"connection_timeout_seconds" : 0 ,
"created_at" : "2019-08-24T14:15:22Z" ,
"directory" : "string" ,
"disconnected_at" : "2019-08-24T14:15:22Z" ,
"environment_variables" : {
"property1" : "string" ,
"property2" : "string"
},
"expanded_directory" : "string" ,
"first_connected_at" : "2019-08-24T14:15:22Z" ,
"id" : "497f6eca-6276-4993-bfeb-53cbbbba6f08" ,
"instance_id" : "string" ,
"last_connected_at" : "2019-08-24T14:15:22Z" ,
"latency" : {
"property1" : {
"latency_ms" : 0 ,
"preferred" : true
},
"property2" : {
"latency_ms" : 0 ,
"preferred" : true
}
},
"lifecycle_state" : "created" ,
"login_before_ready" : true ,
"name" : "string" ,
"operating_system" : "string" ,
"resource_id" : "4d5215ed-38bb-48ed-879a-fdb9ca58522f" ,
"shutdown_script" : "string" ,
"shutdown_script_timeout_seconds" : 0 ,
"startup_logs_length" : 0 ,
"startup_logs_overflowed" : true ,
"startup_script" : "string" ,
"startup_script_timeout_seconds" : 0 ,
"status" : "connecting" ,
"subsystem" : "envbox" ,
"troubleshooting_url" : "string" ,
"updated_at" : "2019-08-24T14:15:22Z" ,
"version" : "string"
}
],
"created_at" : "2019-08-24T14:15:22Z" ,
"daily_cost" : 0 ,
"hide" : true ,
"icon" : "string" ,
"id" : "497f6eca-6276-4993-bfeb-53cbbbba6f08" ,
"job_id" : "453b