{
"document" : "string" ,
"signature" : "string"
}
Name Type Required Restrictions Description documentstring true signaturestring true
{
"labels" : [
{
"name" : "string" ,
"value" : "string"
}
],
"name" : "string" ,
"type" : "counter" ,
"value" : 0
}
Property Value typecountertypegauge
{
"name" : "string" ,
"value" : "string"
}
Name Type Required Restrictions Description namestring true valuestring true
{
"session_token" : "string"
}
Name Type Required Restrictions Description session_tokenstring false
{
"encoding" : "string" ,
"signature" : "string"
}
Name Type Required Restrictions Description encodingstring true signaturestring true
{
"access_token" : "string" ,
"password" : "string" ,
"token_extra" : {},
"type" : "string" ,
"url" : "string" ,
"username" : "string"
}
Name Type Required Restrictions Description access_tokenstring false passwordstring false token_extraobject false typestring false urlstring false usernamestring false Deprecated: Only supported on /workspaceagents/me/gitauth for backwards compatibility.
{
"private_key" : "string" ,
"public_key" : "string"
}
Name Type Required Restrictions Description private_keystring false public_keystring false
{
"json_web_token" : "string"
}
Name Type Required Restrictions Description json_web_tokenstring true
{
"created_at" : "string" ,
"level" : "trace" ,
"output" : "string"
}
Name Type Required Restrictions Description created_atstring false levelcodersdk.LogLevel false outputstring false
{
"agent_id" : "string" ,
"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 ,
"subdomain_name" : "string" ,
"url" : "string"
}
],
"derp_force_websockets" : true ,
"derpmap" : {
"homeParams" : {
"regionScore" : {
"property1" : 0 ,
"property2" : 0
}
},
"omitDefaultRegions" : true ,
"regions" : {
"property1" : {
"avoid" : true ,
"embeddedRelay" : true ,
"nodes" : [
{
"canPort80" : true ,
"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" : [
{
"canPort80" : true ,
"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" ,
"disable_direct_connections" : true ,
"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" ,
"owner_name" : "string" ,
"scripts" : [
{
"cron" : "string" ,
"log_path" : "string" ,
"log_source_id" : "4197ab25-95cf-4b91-9c78-f7f2af5d353a" ,
"run_on_start" : true ,
"run_on_stop" : true ,
"script" : "string" ,
"start_blocks_login" : true ,
"timeout" : 0
}
],
"vscode_port_proxy_uri" : "string" ,
"workspace_id" : "string"
}
Name Type Required Restrictions Description agent_idstring false appsarray of codersdk.WorkspaceApp false derp_force_websocketsboolean false derpmaptailcfg.DERPMap false directorystring false disable_direct_connectionsboolean false environment_variablesobject false » [any property] string false git_auth_configsinteger 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. metadataarray of codersdk.WorkspaceAgentMetadataDescription false motd_filestring false owner_namestring false Owner name and WorkspaceID are used by an open-source user to identify the workspace. We do not provide insurance that this will not be removed in the future, but if it's easy to persist lets keep it around. scriptsarray of codersdk.WorkspaceAgentScript false vscode_port_proxy_uristring false workspace_idstring false
{
"age" : 0 ,
"collected_at" : "2019-08-24T14:15:22Z" ,
"error" : "string" ,
"key" : "string" ,
"value" : "string"
}
Name Type Required Restrictions Description ageinteger 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_atstring false errorstring false keystring false valuestring false
{
"log_source_id" : "string" ,
"logs" : [
{
"created_at" : "string" ,
"level" : "trace" ,
"output" : "string"
}
]
}
Name Type Required Restrictions Description log_source_idstring false logsarray of agentsdk.Log false
{
"healths" : {
"property1" : "disabled" ,
"property2" : "disabled"
}
}
Name Type Required Restrictions Description healthsobject false Healths is a map of the workspace app name and the health of the app. » [any property] codersdk.WorkspaceAppHealth false
{
"changed_at" : "string" ,
"state" : "created"
}
{
"metadata" : [
{
"age" : 0 ,
"collected_at" : "2019-08-24T14:15:22Z" ,
"error" : "string" ,
"key" : "string" ,
"value" : "string"
}
]
}
{
"age" : 0 ,
"collected_at" : "2019-08-24T14:15:22Z" ,
"error" : "string" ,
"value" : "string"
}
Name Type Required Restrictions Description ageinteger 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_atstring false errorstring false valuestring false
{
"expanded_directory" : "string" ,
"subsystems" : ["envbox" ],
"version" : "string"
}
Name Type Required Restrictions Description expanded_directorystring false subsystemsarray of codersdk.AgentSubsystem false versionstring false
{
"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
}
Name Type Required Restrictions Description connection_countinteger false Connection count is the number of connections received by an agent. connection_median_latency_msnumber false Connection median latency ms is the median latency of all connections in milliseconds. connections_by_protoobject false Connections by proto is a count of connections by protocol. » [any property] integer false metricsarray of agentsdk.AgentMetric false Metrics collected by the agent rx_bytesinteger false Rx bytes is the number of received bytes. rx_packetsinteger false Rx packets is the number of received packets. session_count_jetbrainsinteger false Session count jetbrains is the number of connections received by an agent that are from our JetBrains extension. session_count_reconnecting_ptyinteger false Session count reconnecting pty is the number of connections received by an agent that are from the reconnecting web terminal. session_count_sshinteger false Session count ssh is the number of connections received by an agent that are normal, non-tagged SSH sessions. session_count_vscodeinteger false Session count vscode is the number of connections received by an agent that are from our VS Code extension. tx_bytesinteger false Tx bytes is the number of transmitted bytes. tx_packetsinteger false Tx packets is the number of transmitted bytes.
Name Type Required Restrictions Description report_intervalinteger false Report interval is the duration after which the agent should send stats again.
{
"property1" : "string" ,
"property2" : "string"
}
Name Type Required Restrictions Description [any property]string false
{
"description" : "string" ,
"name" : "string" ,
"parent" : {
"description" : "string" ,
"name" : "string" ,
"parent" : {},
"yaml" : "string"
},
"yaml" : "string"
}
Name Type Required Restrictions Description descriptionstring false namestring false parentclibase.Group false yamlstring false
{
"host" : "string" ,
"port" : "string"
}
Name Type Required Restrictions Description hoststring false portstring false
{
"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" ,
"required" : true ,
"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" ,
"required" : true ,
"use_instead" : [],
"value" : null ,
"value_source" : "" ,
"yaml" : "string"
}
],
"value" : null ,
"value_source" : "" ,
"yaml" : "string"
}
Name Type Required Restrictions Description annotationsclibase.Annotations false Annotations enable extensions to clibase higher up in the stack. It's useful for help formatting and documentation generation. defaultstring false Default is parsed into Value if set. descriptionstring false envstring false Env is the environment variable used to configure this option. If unset, environment configuring is disabled. flagstring false Flag is the long name of the flag used to configure this option. If unset, flag configuring is disabled. flag_shorthandstring false Flag shorthand is the one-character shorthand for the flag. If unset, no shorthand is used. groupclibase.Group false Group is a group hierarchy that helps organize this option in help, configs and other documentation. hiddenboolean false namestring false requiredboolean false Required means this value must be set by some means. It requires ValueSource != ValueSourceNone If Default is set, then Required is ignored. use_insteadarray 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. valueany false Value includes the types listed in values.go. value_sourceclibase.ValueSource false yamlstring false Yaml is the YAML key used to configure this option. If unset, YAML configuring is disabled.
None
{
"value" : [
{
"app_install_url" : "string" ,
"app_installations_url" : "string" ,
"auth_url" : "string" ,
"client_id" : "string" ,
"device_code_url" : "string" ,
"device_flow" : true ,
"display_icon" : "string" ,
"display_name" : "string" ,
"extra_token_keys" : ["string" ],
"id" : "string" ,
"no_refresh" : true ,
"regex" : "string" ,
"scopes" : ["string" ],
"token_url" : "string" ,
"type" : "string" ,
"validate_url" : "string"
}
]
}
{
"value" : [
{
"icon" : "string" ,
"name" : "string" ,
"target" : "string"
}
]
}
{
"forceQuery" : true ,
"fragment" : "string" ,
"host" : "string" ,
"omitHost" : true ,
"opaque" : "string" ,
"path" : "string" ,
"rawFragment" : "string" ,
"rawPath" : "string" ,
"rawQuery" : "string" ,
"scheme" : "string" ,
"user" : {}
}
Name Type Required Restrictions Description forceQueryboolean false append a query ('?') even if RawQuery is empty fragmentstring false fragment for references, without '#' hoststring false host or host:port omitHostboolean false do not emit empty host (authority) opaquestring false encoded opaque data pathstring false path (relative paths may omit leading slash) rawFragmentstring false encoded fragment hint (see EscapedFragment method) rawPathstring false encoded path hint (see EscapedPath method) rawQuerystring false encoded query values, without '?' schemestring false userurl.Userinfo false username and password information
Value `` flagenvyamldefault
{
"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"
}
Name Type Required Restrictions Description activeboolean false emailsarray of object false » displaystring false » primaryboolean false » typestring false » valuestring false groupsarray of undefined false idstring false metaobject false » resourceTypestring false nameobject false » familyNamestring false » givenNamestring false schemasarray of string false userNamestring false
Name Type Required Restrictions Description csp-reportobject false
{
"groups" : [
{
"avatar_url" : "string" ,
"display_name" : "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" ,
"login_type" : "" ,
"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 ,
"source" : "user"
}
],
"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" ,
"login_type" : "" ,
"organization_ids" : ["497f6eca-6276-4993-bfeb-53cbbbba6f08" ],
"roles" : [
{
"display_name" : "string" ,
"name" : "string"
}
],
"status" : "active" ,
"username" : "string"
}
]
}
{
"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"
}
Name Type Required Restrictions Description created_atstring true expires_atstring true idstring true last_usedstring true lifetime_secondsinteger true login_typecodersdk.LoginType true scopecodersdk.APIKeyScope true token_namestring true updated_atstring true user_idstring true
Property Value login_typepasswordlogin_typegithublogin_typeoidclogin_typetokenscopeallscopeapplication_connect
Value allapplication_connect
Name Type Required Restrictions Description licensestring true
Value envboxenvbuilderexectrace
Name Type Required Restrictions Description hoststring false Host is the externally accessible URL for the Coder instance.
{
"application_name" : "string" ,
"logo_url" : "string" ,
"service_banner" : {
"background_color" : "string" ,
"enabled" : true ,
"message" : "string"
},
"support_links" : [
{
"icon" : "string" ,
"name" : "string" ,
"target" : "string"
}
]
}
Name Type Required Restrictions Description allboolean false By default, only failed versions are archived. Set this to true to archive all unused versions regardless of job status.
{
"assignable" : true ,
"display_name" : "string" ,
"name" : "string"
}
Name Type Required Restrictions Description assignableboolean false display_namestring false namestring false
Value createwritedeletestartstoploginlogoutregister
{
"property1" : {
"new" : null ,
"old" : null ,
"secret" : true
},
"property2" : {
"new" : null ,
"old" : null ,
"secret" : true
}
}
{
"new" : null ,
"old" : null ,
"secret" : true
}
Name Type Required Restrictions Description newany false oldany false secretboolean false
{
"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" ,
"login_type" : "" ,
"organization_ids" : ["497f6eca-6276-4993-bfeb-53cbbbba6f08" ],
"roles" : [
{
"display_name" : "string" ,
"name" : "string"
}
],
"status" : "active" ,
"username" : "string"
},
"user_agent" : "string"
}
Name Type Required Restrictions Description actioncodersdk.AuditAction false additional_fieldsarray of integer false descriptionstring false diffcodersdk.AuditDiff false idstring false ipstring false is_deletedboolean false organization_idstring false request_idstring false resource_iconstring false resource_idstring false resource_linkstring false resource_targetstring false Resource target is the name of the resource. resource_typecodersdk.ResourceType false status_codeinteger false timestring false usercodersdk.User false user_agentstring false
{
"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" ,
"login_type" : "" ,
"organization_ids" : ["497f6eca-6276-4993-bfeb-53cbbbba6f08" ],
"roles" : [
{
"display_name" : "string" ,
"name" : "string"
}
],
"status" : "active" ,
"username" : "string"
},
"user_agent" : "string"
}
],
"count" : 0
}
Name Type Required Restrictions Description audit_logsarray of codersdk.AuditLog false countinteger false
Name Type Required Restrictions Description enabledboolean false
{
"github" : {
"enabled" : true
},
"oidc" : {
"enabled" : true ,
"iconUrl" : "string" ,
"signInText" : "string"
},
"password" : {
"enabled" : true
}
}
{
"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.
Name Type Required Restrictions Description actionstring false objectcodersdk.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.
Property Value actioncreateactionreadactionupdateactiondelete
{
"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.
Name Type Required Restrictions Description organization_idstring false Organization ID (optional) adds the set constraint to all resources owned by a given organization. owner_idstring false Owner ID (optional) adds the set constraint to all resources owned by a given user. resource_idstring 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_typecodersdk.RBACResource false Resource type is the name of the resource. ./coderd/rbac/object.go has the list of valid resource types.
{
"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"
}
}
}
}
Name Type Required Restrictions Description checksobject 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.
{
"property1" : true ,
"property2" : true
}
Name Type Required Restrictions Description [any property]boolean false
{
"agent_api_version" : "string" ,
"dashboard_url" : "string" ,
"external_url" : "string" ,
"version" : "string" ,
"workspace_proxy" : true
}
Name Type Required Restrictions Description agent_api_versionstring false Agent api version is the current version of the Agent API (back versions MAY still be supported). dashboard_urlstring 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_urlstring 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. versionstring false Version returns the semantic version of the build. workspace_proxyboolean false
Value initiatorautostartautostop
{
"p50" : 31.312 ,
"p95" : 119.832
}
Name Type Required Restrictions Description p50number false p95number false
{
"password" : "string" ,
"to_type" : ""
}
Name Type Required Restrictions Description passwordstring true to_typecodersdk.LoginType true To type is the login type to convert to.
{
"email" : "string" ,
"password" : "string" ,
"trial" : true ,
"username" : "string"
}
Name Type Required Restrictions Description emailstring true passwordstring true trialboolean false usernamestring true
{
"organization_id" : "7c60d51f-b44e-4682-87d6-449835ea4de6" ,
"user_id" : "a169451c-8525-4352-b8ca-070dd449a1a5"
}
Name Type Required Restrictions Description organization_idstring false user_idstring false
{
"avatar_url" : "string" ,
"display_name" : "string" ,
"name" : "string" ,
"quota_allowance" : 0
}
Name Type Required Restrictions Description avatar_urlstring false display_namestring false namestring false quota_allowanceinteger false
Name Type Required Restrictions Description namestring true
{
"allow_user_autostart" : true ,
"allow_user_autostop" : true ,
"allow_user_cancel_workspace_jobs" : true ,
"autostart_requirement" : {
"days_of_week" : ["monday" ]
},
"autostop_requirement" : {
"days_of_week" : ["monday" ],
"weeks" : 0
},
"default_ttl_ms" : 0 ,
"delete_ttl_ms" : 0 ,
"description" : "string" ,
"disable_everyone_group_access" : true ,
"display_name" : "string" ,
"dormant_ttl_ms" : 0 ,
"failure_ttl_ms" : 0 ,
"icon" : "string" ,
"max_ttl_ms" : 0 ,
"name" : "string" ,
"require_active_version" : true ,
"template_version_id" : "0ba39c92-1f1b-4c32-aa3e-9925d7713eb1"
}
Name Type Required Restrictions Description allow_user_autostartboolean 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_autostopboolean 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_jobsboolean false Allow users to cancel in-progress workspace jobs. *bool as the default value is "true". autostart_requirementcodersdk.TemplateAutostartRequirement false Autostart requirement allows optionally specifying the autostart allowed days for workspaces created from this template. This is an enterprise feature. autostop_requirementcodersdk.TemplateAutostopRequirement false Autostop requirement allows optionally specifying the autostop requirement for workspaces created from this template. This is an enterprise feature. default_ttl_msinteger false Default ttl ms allows optionally specifying the default TTL for all workspaces created from this template. delete_ttl_msinteger false Delete ttl ms allows optionally specifying the max lifetime before Coder permanently deletes dormant workspaces created from this template. descriptionstring false Description is a description of what the template contains. It must be less than 128 bytes. disable_everyone_group_accessboolean false Disable everyone group access allows optionally disabling the default behavior of granting the 'everyone' group access to use the template. If this is set to true, the template will not be available to all users, and must be explicitly granted to users or groups in the permissions settings of the template. display_namestring false Display name is the displayed name of the template. dormant_ttl_msinteger false Dormant ttl ms allows optionally specifying the max lifetime before Coder locks inactive workspaces created from this template. failure_ttl_msinteger false Failure ttl ms allows optionally specifying the max lifetime before Coder stops all resources for failed workspaces created from this template. iconstring false Icon is a relative path or external URL that specifies an icon to be displayed in the dashboard. max_ttl_msinteger false Max ttl ms remove max_ttl once autostop_requirement is matured namestring true Name is the name of the template. require_active_versionboolean false Require active version mandates that workspaces are built with the active template version. template_version_idstring 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.
{
"rich_parameter_values" : [
{
"name" : "string" ,
"value" : "string"
}
],
"user_variable_values" : [
{
"name" : "string" ,
"value" : "string"
}
],
"workspace_name" : "string"
}
{
"example_id" : "string" ,
"file_id" : "8a0cfb4f-ddc9-436d-91bb-75133c583767" ,
"message" : "string" ,
"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"
}
]
}
Name Type Required Restrictions Description example_idstring false file_idstring false messagestring false namestring false provisionerstring true storage_methodcodersdk.ProvisionerStorageMethod true tagsobject false » [any property] string false template_idstring false Template ID optionally associates a version with a template. user_variable_valuesarray of codersdk.VariableValue false
Property Value provisionerterraformprovisionerechostorage_methodfile
{
"action" : "create" ,
"additional_fields" : [0 ],
"build_reason" : "autostart" ,
"resource_id" : "4d5215ed-38bb-48ed-879a-fdb9ca58522f" ,
"resource_type" : "template" ,
"time" : "2019-08-24T14:15:22Z"
}
Property Value actioncreateactionwriteactiondeleteactionstartactionstopbuild_reasonautostartbuild_reasonautostopbuild_reasoninitiatorresource_typetemplateresource_typetemplate_versionresource_typeuserresource_typeworkspaceresource_typeworkspace_buildresource_typegit_ssh_keyresource_typeauditable_group
{
"lifetime" : 0 ,
"scope" : "all" ,
"token_name" : "string"
}
Name Type Required Restrictions Description lifetimeinteger false scopecodersdk.APIKeyScope false token_namestring false
Property Value scopeallscopeapplication_connect
{
"disable_login" : true ,
"email" : "[email protected] " ,
"login_type" : "" ,
"organization_id" : "7c60d51f-b44e-4682-87d6-449835ea4de6" ,
"password" : "string" ,
"username" : "string"
}
Name Type Required Restrictions Description disable_loginboolean false Disable login sets the user's login type to 'none'. This prevents the user from being able to use a password or any other authentication method to login. Deprecated: Set UserLoginType=LoginTypeDisabled instead. emailstring true login_typecodersdk.LoginType false Login type defaults to LoginTypePassword. organization_idstring false passwordstring false usernamestring true
{
"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"
}
Name Type Required Restrictions Description dry_runboolean false log_levelcodersdk.ProvisionerLogLevel false Log level changes the default logging verbosity of a provider ("info" if empty). orphanboolean false Orphan may be set for the Destroy transition. rich_parameter_valuesarray 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. statearray of integer false template_version_idstring false transitioncodersdk.WorkspaceTransition true
Property Value log_leveldebugtransitioncreatetransitionstarttransitionstoptransitiondelete
{
"display_name" : "string" ,
"icon" : "string" ,
"name" : "string"
}
Name Type Required Restrictions Description display_namestring false iconstring false namestring true
{
"automatic_updates" : "always" ,
"autostart_schedule" : "string" ,
"name" : "string" ,
"rich_parameter_values" : [
{
"name" : "string" ,
"value" : "string"
}
],
"template_id" : "c6d67e98-83ea-49f0-8812-e4abae2b68bc" ,
"template_version_id" : "0ba39c92-1f1b-4c32-aa3e-9925d7713eb1" ,
"ttl_ms" : 0
}
Name Type Required Restrictions Description automatic_updatescodersdk.AutomaticUpdates false autostart_schedulestring false namestring true rich_parameter_valuesarray of codersdk.WorkspaceBuildParameter false Rich parameter values allows for additional parameters to be provided during the initial provision. template_idstring false Template ID specifies which template should be used for creating the workspace. template_version_idstring false Template version ID can be used to specify a specific version of a template for creating the workspace. ttl_msinteger false
{
"amount" : 0 ,
"date" : "2019-08-24T14:15:22Z"
}
Name Type Required Restrictions Description amountinteger false datestring false
{
"entries" : [
{
"amount" : 0 ,
"date" : "2019-08-24T14:15:22Z"
}
],
"tz_hour_offset" : 0
}
Name Type Required Restrictions Description entriesarray of codersdk.DAUEntry false tz_hour_offsetinteger false
{
"config" : {
"block_direct" : true ,
"force_websockets" : true ,
"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" ]
}
}
{
"block_direct" : true ,
"force_websockets" : true ,
"path" : "string" ,
"url" : "string"
}
Name Type Required Restrictions Description block_directboolean false force_websocketsboolean false pathstring false urlstring false
{
"latency_ms" : 0 ,
"preferred" : true
}
Name Type Required Restrictions Description latency_msnumber false preferredboolean false
{
"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" ]
}
Name Type Required Restrictions Description enableboolean false region_codestring false region_idinteger false region_namestring false relay_urlclibase.URL false stun_addressesarray of string false
{
"allow_all_cors" : true ,
"allow_path_app_sharing" : true ,
"allow_path_app_site_owner_access" : true
}
Name Type Required Restrictions Description allow_all_corsboolean false allow_path_app_sharingboolean false allow_path_app_site_owner_accessboolean false
{
"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" : {
"block_direct" : true ,
"force_websockets" : true ,
"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 ,
"docs_url" : {
"forceQuery" : true ,
"fragment" : "string" ,
"host" : "string" ,
"omitHost" : true ,
"opaque" : "string" ,
"path" : "string" ,
"rawFragment" : "string" ,
"rawPath" : "string" ,
"rawQuery" : "string" ,
"scheme" : "string" ,
"user" : {}
},
"enable_terraform_debug_mode" : true ,
"experiments" : ["string" ],
"external_auth" : {
"value" : [
{
"app_install_url" : "string" ,
"app_installations_url" : "string" ,
"auth_url" : "string" ,
"client_id" : "string" ,
"device_code_url" : "string" ,
"device_flow" : true ,
"display_icon" : "string" ,
"display_name" : "string" ,
"extra_token_keys" : ["string" ],
"id" : "string" ,
"no_refresh" : true ,
"regex" : "string" ,
"scopes" : ["string" ],
"token_url" : "string" ,
"type" : "string" ,
"validate_url" : "string"
}
]
},
"external_token_encryption_keys" : ["string" ],
"healthcheck" : {
"refresh" : 0 ,
"threshold_database" : 0
},
"http_address" : "string" ,
"in_memory_database" : true ,
"job_hang_detector_interval" : 0 ,
"logging" : {
"human" : "string" ,
"json" : "string" ,
"log_filter" : ["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_cert_file" : "string" ,
"client_id" : "string" ,
"client_key_file" : "string" ,
"client_secret" : "string" ,
"email_domain" : ["string" ],
"email_field" : "string" ,
"group_allow_list" : ["string" ],
"group_auto_create" : true ,
"group_mapping" : {},
"group_regex_filter" : {},
"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" ,
"user_role_field" : "string" ,
"user_role_mapping" : {},
"user_roles_default" : ["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 ,
"collect_db_metrics" : true ,
"enable" : true
},
"provisioner" : {
"daemon_poll_interval" : 0 ,
"daemon_poll_jitter" : 0 ,
"daemon_psk" : "string" ,
"daemons" : 0 ,
"daemons_echo" : true ,
"force_cancel_interval" : 0
},
"proxy_health_status_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"
},
"allow_insecure_ciphers" : true ,
"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 ,
"supported_ciphers" : ["string" ]
},
"trace" : {
"capture_logs" : true ,
"data_dog" : true ,
"enable" : true ,
"honeycomb_api_key" : "string"
},
"update_check" : true ,
"user_quiet_hours_schedule" : {
"default_schedule" : "string"
},
"verbose" : true ,
"web_terminal_renderer" : "string" ,
"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" ,
"required" : true ,
"use_instead" : [{}],
"value" : null ,
"value_source" : "" ,
"yaml" : "string"
}
]
}
{
"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
}
}
Name Type Required Restrictions Description aggregated_fromstring false Aggregated from is the time in which stats are aggregated from. This might be back in time a specific duration or interval. collected_atstring false Collected at is the time in which stats are collected at. next_update_atstring false Next update at is the time when the next batch of stats will be updated. session_countcodersdk.SessionCountDeploymentStats false workspacescodersdk.WorkspaceDeploymentStats false
{
"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" : {
"block_direct" : true ,
"force_websockets" : true ,
"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 ,
"docs_url" : {
"forceQuery" : true ,
"fragment" : "string" ,
"host" : "string" ,
"omitHost" : true ,
"opaque" : "string" ,
"path" : "string" ,
"rawFragment" : "string" ,
"rawPath" : "string" ,
"rawQuery" : "string" ,
"scheme" : "string" ,
"user" : {}
},
"enable_terraform_debug_mode" : true ,
"experiments" : ["string" ],
"external_auth" : {
"value" : [
{
"app_install_url" : "string" ,
"app_installations_url" : "string" ,
"auth_url" : "string" ,
"client_id" : "string" ,
"device_code_url" : "string" ,
"device_flow" : true ,
"display_icon" : "string" ,
"display_name" : "string" ,
"extra_token_keys" : ["string" ],
"id" : "string" ,
"no_refresh" : true ,
"regex" : "string" ,
"scopes" : ["string" ],
"token_url" : "string" ,
"type" : "string" ,
"validate_url" : "string"
}
]
},
"external_token_encryption_keys" : ["string" ],
"healthcheck" : {
"refresh" : 0 ,
"threshold_database" : 0
},
"http_address" : "string" ,
"in_memory_database" : true ,
"job_hang_detector_interval" : 0 ,
"logging" : {
"human" : "string" ,
"json" : "string" ,
"log_filter" : ["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_cert_file" : "string" ,
"client_id" : "string" ,
"client_key_file" : "string" ,
"client_secret" : "string" ,
"email_domain" : ["string" ],
"email_field" : "string" ,
"group_allow_list" : ["string" ],
"group_auto_create" : true ,
"group_mapping" : {},
"group_regex_filter" : {},
"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" ,
"user_role_field" : "string" ,
"user_role_mapping" : {},
"user_roles_default" : ["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 ,
"collect_db_metrics" : true ,
"enable" : true
},
"provisioner" : {
"daemon_poll_interval" : 0 ,
"daemon_poll_jitter" : 0 ,
"daemon_psk" : "string" ,
"daemons" : 0 ,
"daemons_echo" : true ,
"force_cancel_interval" : 0
},
"proxy_health_status_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"
},
"allow_insecure_ciphers" : true ,
"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 ,
"supported_ciphers" : ["string" ]
},
"trace" : {
"capture_logs" : true ,
"data_dog" : true ,
"enable" : true ,
"honeycomb_api_key" : "string"
},
"update_check" : true ,
"user_quiet_hours_schedule" : {
"default_schedule" : "string"
},
"verbose" : true ,
"web_terminal_renderer" : "string" ,
"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
}
Value vscodevscode_insidersweb_terminalport_forwarding_helperssh_helper
Value entitledgrace_periodnot_entitled
{
"errors" : ["string" ],
"features" : {
"property1" : {
"actual" : 0 ,
"enabled" : true ,
"entitlement" : "entitled" ,
"limit" : 0
},
"property2" : {
"actual" : 0 ,
"enabled" : true ,
"entitlement" : "entitled" ,
"limit" : 0
}
},
"has_license" : true ,
"refreshed_at" : "2019-08-24T14:15:22Z" ,
"require_telemetry" : true ,
"trial" : true ,
"warnings" : ["string" ]
}
Name Type Required Restrictions Description errorsarray of string false featuresobject false » [any property] codersdk.Feature false has_licenseboolean false refreshed_atstring false require_telemetryboolean false trialboolean false warningsarray of string false
Value moonsworkspace_actionstailnet_pg_coordinatorsingle_tailnettemplate_autostop_requirementdeployment_health_pagetemplate_update_policies
{
"app_install_url" : "string" ,
"app_installable" : true ,
"authenticated" : true ,
"device" : true ,
"display_name" : "string" ,
"installations" : [
{
"account" : {
"avatar_url" : "string" ,
"login" : "string" ,
"name" : "string" ,
"profile_url" : "string"
},
"configure_url" : "string" ,
"id" : 0
}
],
"user" : {
"avatar_url" : "string" ,
"login" : "string" ,
"name" : "string" ,
"profile_url" : "string"
}
}
Name Type Required Restrictions Description app_install_urlstring false App install URL is the URL to install the app. app_installableboolean false App installable is true if the request for app installs was successful. authenticatedboolean false deviceboolean false display_namestring false installationsarray of codersdk.ExternalAuthAppInstallation false Installations are the installations that the user has access to. usercodersdk.ExternalAuthUser false User is the user that authenticated with the provider.
{
"account" : {
"avatar_url" : "string" ,
"login" : "string" ,
"name" : "string" ,
"profile_url" : "string"
},
"configure_url" : "string" ,
"id" : 0
}
{
"app_install_url" : "string" ,
"app_installations_url" : "string" ,
"auth_url" : "string" ,
"client_id" : "string" ,
"device_code_url" : "string" ,
"device_flow" : true ,
"display_icon" : "string" ,
"display_name" : "string" ,
"extra_token_keys" : ["string" ],
"id" : "string" ,
"no_refresh" : true ,
"regex" : "string" ,
"scopes" : ["string" ],
"token_url" : "string" ,
"type" : "string" ,
"validate_url" : "string"
}
Name Type Required Restrictions Description app_install_urlstring false app_installations_urlstring false auth_urlstring false client_idstring false device_code_urlstring false device_flowboolean false display_iconstring false Display icon is a URL to an icon to display in the UI. display_namestring false Display name is shown in the UI to identify the auth config. extra_token_keysarray of string false idstring false ID is a unique identifier for the auth config. It defaults to type when not provided. no_refreshboolean false regexstring false Regex allows API requesters to match an auth config by a string (e.g. coder.com) instead of by it's type. Git clone makes use of this by parsing the URL from: 'Username for "https://github.com ":' And sending it to the Coder server to match against the Regex. scopesarray of string false token_urlstring false typestring false Type is the type of external auth config. validate_urlstring false
{
"device_code" : "string" ,
"expires_in" : 0 ,
"interval" : 0 ,
"user_code" : "string" ,
"verification_uri" : "string"
}
Name Type Required Restrictions Description device_codestring false expires_ininteger false intervalinteger false user_codestring false verification_uristring false
{
"authenticated" : true ,
"created_at" : "2019-08-24T14:15:22Z" ,
"expires" : "2019-08-24T14:15:22Z" ,
"has_refresh_token" : true ,
"provider_id" : "string" ,
"updated_at" : "2019-08-24T14:15:22Z" ,
"validate_error" : "string"
}
Name Type Required Restrictions Description authenticatedboolean false created_atstring false expiresstring false has_refresh_tokenboolean false provider_idstring false updated_atstring false validate_errorstring false
{
"avatar_url" : "string" ,
"login" : "string" ,
"name" : "string" ,
"profile_url" : "string"
}
Name Type Required Restrictions Description avatar_urlstring false loginstring false namestring false profile_urlstring false
{
"actual" : 0 ,
"enabled" : true ,
"entitlement" : "entitled" ,
"limit" : 0
}
Name Type Required Restrictions Description actualinteger false enabledboolean false entitlementcodersdk.Entitlement false limitinteger false
Name Type Required Restrictions Description keystring false
{
"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" ,
"login_type" : "" ,
"organization_ids" : ["497f6eca-6276-4993-bfeb-53cbbbba6f08" ],
"roles" : [
{
"display_name" : "string" ,
"name" : "string"
}
],
"status" : "active" ,
"username" : "string"
}
]
}
Name Type Required Restrictions Description countinteger false usersarray of codersdk.User false
{
"created_at" : "2019-08-24T14:15:22Z" ,
"public_key" : "string" ,
"updated_at" : "2019-08-24T14:15:22Z" ,
"user_id" : "a169451c-8525-4352-b8ca-070dd449a1a5"
}
Name Type Required Restrictions Description created_atstring false public_keystring false updated_atstring false user_idstring false
{
"avatar_url" : "string" ,
"display_name" : "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" ,
"login_type" : "" ,
"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 ,
"source" : "user"
}
Name Type Required Restrictions Description avatar_urlstring false display_namestring false idstring false membersarray of codersdk.User false namestring false organization_idstring false quota_allowanceinteger false sourcecodersdk.GroupSource false
Value DERPAccessURLWebsocketDatabaseWorkspaceProxy
{
"dismissed_healthchecks" : ["DERP" ]
}
{
"interval" : 0 ,
"threshold" : 0 ,
"url" : "string"
}
Name Type Required Restrictions Description intervalinteger false Interval specifies the seconds between each health check. thresholdinteger false Threshold specifies the number of consecutive failed health checks before returning "unhealthy". urlstring false URL specifies the endpoint to check for the app health.
{
"refresh" : 0 ,
"threshold_database" : 0
}
Name Type Required Restrictions Description refreshinteger false threshold_databaseinteger false
{
"agentID" : "bc282582-04f9-45ce-b904-3e3bfab66958" ,
"url" : "string"
}
Name Type Required Restrictions Description agentIDstring true urlstring true URL is the URL of the reconnecting-pty endpoint you are connecting to.
{
"signed_token" : "string"
}
Name Type Required Restrictions Description signed_tokenstring false
"REQUIRED_TEMPLATE_VARIABLES"
Value REQUIRED_TEMPLATE_VARIABLES
{
"claims" : {},
"id" : 0 ,
"uploaded_at" : "2019-08-24T14:15:22Z" ,
"uuid" : "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"
}
Name Type Required Restrictions Description claimsobject 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. idinteger false uploaded_atstring false uuidstring false
{
"icon" : "string" ,
"name" : "string" ,
"target" : "string"
}
Name Type Required Restrictions Description iconstring false namestring false targetstring false
Value tracedebuginfowarnerror
Value provisioner_daemonprovisioner
{
"human" : "string" ,
"json" : "string" ,
"log_filter" : ["string" ],
"stackdriver" : "string"
}
Name Type Required Restrictions Description humanstring false jsonstring false log_filterarray of string false stackdriverstring false
Value `` passwordgithuboidctokennone
Name Type Required Restrictions Description emailstring true passwordstring true
{
"session_token" : "string"
}
Name Type Required Restrictions Description session_tokenstring true
{
"avatar_url" : "http://example.com" ,
"id" : "497f6eca-6276-4993-bfeb-53cbbbba6f08" ,
"username" : "string"
}
Name Type Required Restrictions Description avatar_urlstring false idstring true usernamestring true
{
"github" : {
"allow_everyone" : true ,
"allow_signups" : true ,
"allowed_orgs" : ["string" ],
"allowed_teams" : ["string" ],
"client_id" : "string" ,
"client_secret" : "string" ,
"enterprise_base_url" : "string"
}
}
{
"allow_everyone" : true ,
"allow_signups" : true ,
"allowed_orgs" : ["string" ],
"allowed_teams" : ["string" ],
"client_id" : "string" ,
"client_secret" : "string" ,
"enterprise_base_url" : "string"
}
Name Type Required Restrictions Description allow_everyoneboolean false allow_signupsboolean false allowed_orgsarray of string false allowed_teamsarray of string false client_idstring false client_secretstring false enterprise_base_urlstring false
{
"expires_at" : "2019-08-24T14:15:22Z" ,
"state_string" : "string" ,
"to_type" : "" ,
"user_id" : "a169451c-8525-4352-b8ca-070dd449a1a5"
}
Name Type Required Restrictions Description expires_atstring false state_stringstring false to_typecodersdk.LoginType false user_idstring false
{
"enabled" : true ,
"iconUrl" : "string" ,
"signInText" : "string"
}
Name Type Required Restrictions Description enabledboolean false iconUrlstring false signInTextstring false
{
"allow_signups" : true ,
"auth_url_params" : {},
"client_cert_file" : "string" ,
"client_id" : "string" ,
"client_key_file" : "string" ,
"client_secret" : "string" ,
"email_domain" : ["string" ],
"email_field" : "string" ,
"group_allow_list" : ["string" ],
"group_auto_create" : true ,
"group_mapping" : {},
"group_regex_filter" : {},
"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" ,
"user_role_field" : "string" ,
"user_role_mapping" : {},
"user_roles_default" : ["string" ],
"username_field" : "string"
}
Name Type Required Restrictions Description allow_signupsboolean false auth_url_paramsobject false client_cert_filestring false client_idstring false client_key_filestring false Client key file & ClientCertFile are used in place of ClientSecret for PKI auth. client_secretstring false email_domainarray of string false email_fieldstring false group_allow_listarray of string false group_auto_createboolean false group_mappingobject false group_regex_filterclibase.Regexp false groups_fieldstring false icon_urlclibase.URL false ignore_email_verifiedboolean false ignore_user_infoboolean false issuer_urlstring false scopesarray of string false sign_in_textstring false user_role_fieldstring false user_role_mappingobject false user_roles_defaultarray of string false username_fieldstring false
{
"created_at" : "2019-08-24T14:15:22Z" ,
"id" : "497f6eca-6276-4993-bfeb-53cbbbba6f08" ,
"name" : "string" ,
"updated_at" : "2019-08-24T14:15:22Z"
}
Name Type Required Restrictions Description created_atstring true idstring true namestring true updated_atstring true
{
"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"
}
Name Type Required Restrictions Description created_atstring false organization_idstring false rolesarray of codersdk.Role false updated_atstring false user_idstring false
{
"add_users" : ["string" ],
"avatar_url" : "string" ,
"display_name" : "string" ,
"name" : "string" ,
"quota_allowance" : 0 ,
"remove_users" : ["string" ]
}
