{
"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
{
"password" : "string" ,
"url" : "string" ,
"username" : "string"
}
Name Type Required Restrictions Description passwordstring false urlstring false usernamestring false
{
"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
{
"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"
}
Name Type Required Restrictions Description appsarray of codersdk.WorkspaceApp false derpmaptailcfg.DERPMap false directorystring 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 shutdown_scriptstring false shutdown_script_timeoutinteger false startup_scriptstring false startup_script_timeoutinteger false vscode_port_proxy_uristring false
{
"logs" : [
{
"created_at" : "string" ,
"level" : "trace" ,
"output" : "string"
}
]
}
{
"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
{
"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" ,
"subsystem" : "envbox" ,
"version" : "string"
}
Name Type Required Restrictions Description expanded_directorystring false subsystemcodersdk.AgentSubsystem false versionstring false
{
"created_at" : "string" ,
"level" : "trace" ,
"output" : "string"
}
Name Type Required Restrictions Description created_atstring false levelcodersdk.LogLevel false outputstring 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" ,
"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"
}
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 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.
{
"value" : [
{
"auth_url" : "string" ,
"client_id" : "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
{
"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
Name Type Required Restrictions Description hoststring false Host is the externally accessible URL for the Coder instance.
{
"logo_url" : "string" ,
"service_banner" : {
"background_color" : "string" ,
"enabled" : true ,
"message" : "string"
},
"support_links" : [
{
"icon" : "string" ,
"name" : "string" ,
"target" : "string"
}
]
}
{
"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" ,
"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" ,
"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
{
"dashboard_url" : "string" ,
"external_url" : "string" ,
"version" : "string" ,
"workspace_proxy" : true
}
Name Type Required Restrictions Description 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
{
"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" ,
"name" : "string" ,
"quota_allowance" : 0
}
Name Type Required Restrictions Description avatar_urlstring 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 ,
"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"
}
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". default_ttl_msinteger false Default ttl ms allows optionally specifying the default TTL for all workspaces created from this template. descriptionstring false Description is a description of what the template contains. It must be less than 128 bytes. display_namestring false Display name is the displayed name of the 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. inactivity_ttl_msinteger false Inactivity ttl ms allows optionally specifying the max lifetime before Coder deletes inactive workspaces created from this template. max_ttl_msinteger false Max ttl ms allows optionally specifying the max lifetime for workspaces created from this template. namestring true Name is the name of the template. 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" ,
"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 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
{
"email" : "[email protected] " ,
"organization_id" : "7c60d51f-b44e-4682-87d6-449835ea4de6" ,
"password" : "string" ,
"username" : "string"
}
Name Type Required Restrictions Description emailstring true organization_idstring false passwordstring true 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
{
"autostart_schedule" : "string" ,
"name" : "string" ,
"rich_parameter_values" : [
{
"name" : "string" ,
"value" : "string"
}
],
"template_id" : "c6d67e98-83ea-49f0-8812-e4abae2b68bc" ,
"ttl_ms" : 0
}
Name Type Required Restrictions Description 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 true 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" : {
"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" ]
}
}
{
"path" : "string" ,
"url" : "string"
}
Name Type Required Restrictions Description 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" : {
"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"
}
]
}
{
"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" : {
"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
}
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 ,
"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 require_telemetryboolean false trialboolean false warningsarray of string false
Value moonsworkspace_actionsworkspace_filter
{
"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" ,
"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
{
"auth_url" : "string" ,
"client_id" : "string" ,
"id" : "string" ,
"no_refresh" : true ,
"regex" : "string" ,
"scopes" : ["string" ],
"token_url" : "string" ,
"type" : "string" ,
"validate_url" : "string"
}
Name Type Required Restrictions Description auth_urlstring false client_idstring false idstring false no_refreshboolean false regexstring false scopesarray of string false token_urlstring false typestring false validate_urlstring false
Value azure-devopsgithubgitlabbitbucket
{
"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" ,
"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
}
Name Type Required Restrictions Description avatar_urlstring false idstring false membersarray of codersdk.User false namestring false organization_idstring false quota_allowanceinteger false
{
"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.
{
"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
"MISSING_TEMPLATE_PARAMETER"
Value MISSING_TEMPLATE_PARAMETERREQUIRED_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" ,
"stackdriver" : "string"
}
Name Type Required Restrictions Description humanstring false jsonstring false stackdriverstring false
Value passwordgithuboidctoken
Name Type Required Restrictions Description emailstring true passwordstring true
{
"session_token" : "string"
}
Name Type Required Restrictions Description session_tokenstring 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
{
"enabled" : true ,
"iconUrl" : "string" ,
"signInText" : "string"
}
Name Type Required Restrictions Description enabledboolean false iconUrlstring false signInTextstring false
{
"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"
}
Name Type Required Restrictions Description allow_signupsboolean false auth_url_paramsobject false client_idstring false client_secretstring false email_domainarray of string false email_fieldstring false group_mappingobject 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 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
Name Type Required Restrictions Description namestring false
{
"display_name" : "string" ,
"icon" : "string" ,
"id" : "497f6eca-6276-4993-bfeb-53cbbbba6f08" ,
"name" : "string" ,
"regenerate_token" : true
}
Name Type Required Restrictions Description display_namestring true iconstring true idstring true namestring true regenerate_tokenboolean false
{
"address" : {
"host" : "string" ,
"port" : "string"
},
"enable" : true
}
Name Type Required Restrictions Description addressclibase.HostPort false enableboolean false
{
"address" : {
"host" : "string" ,
"port" : "string"
},
"collect_agent_stats" : true ,
"enable" : true
}
Name Type Required Restrictions Description addressclibase.HostPort false collect_agent_statsboolean false enableboolean false
{
"daemon_poll_interval" : 0 ,
"daemon_poll_jitter" : 0 ,
"daemons" : 0 ,
"force_cancel_interval" : 0
}
Name Type Required Restrictions Description daemon_poll_intervalinteger false daemon_poll_jitterinteger false daemonsinteger false force_cancel_intervalinteger false
{
"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
}
}
Name Type Required Restrictions Description created_atstring false idstring false namestring false provisionersarray of string false tagsobject false » [any property] string false updated_atsql.NullTime false
{
"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 Type Required Restrictions Description canceled_atstring false completed_atstring false created_atstring false errorstring false error_codecodersdk.JobErrorCode false file_idstring false idstring false started_atstring false statuscodersdk.ProvisionerJobStatus false tagsobject false » [any property] string false worker_idstring false
Property Value error_codeMISSING_TEMPLATE_PARAMETERerror_codeREQUIRED_TEMPLATE_VARIABLESstatuspendingstatusrunningstatussucceededstatuscancelingstatuscanceledstatusfailed
{
"created_at" : "2019-08-24T14:15:22Z" ,
"id" : 0 ,
"log_level" : "trace" ,
"log_source" : "provisioner_daemon" ,
"output" : "string" ,
"stage" : "string"
}
Property Value log_leveltracelog_leveldebuglog_levelinfolog_levelwarnlog_levelerror
Value pendingrunningsucceededcancelingcanceledfailed
{
"errors" : ["string" ],
"warnings" : ["string" ]
}
Name Type Required Restrictions Description errorsarray of string false Errors are problems that prevent the workspace proxy from being healthy warningsarray of string false Warnings do not prevent the workspace proxy from being healthy, but should be addressed.
Value okunreachableunhealthyunregistered
{
"deadline" : "2019-08-24T14:15:22Z"
}
Name Type Required Restrictions Description deadlinestring true
Value workspaceworkspace_proxyworkspace_executionapplication_connectaudit_logtemplategroupfileprovisioner_daemonorganizationassign_roleassign_org_roleapi_keyuseruser_dataorganization_memberlicensedeployment_configdeployment_statsreplicasdebug_infosystem
{
"api" : 0 ,
"disable_all" : true
}
Name Type Required Restrictions Description apiinteger false disable_allboolean false
{
"display_name" : "string" ,
"healthy" : true ,
"icon_url" : "string" ,
"id" : "497f6eca-6276-4993-bfeb-53cbbbba6f08" ,
"name" : "string" ,
"path_app_url" : "string" ,
"wildcard_hostname" : "string"
}
Name Type Required Restrictions Description display_namestring false healthyboolean false icon_urlstring false idstring false namestring false path_app_urlstring 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_hostnamestring 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.
{
"regions" : [
{
"display_name" : "string" ,
"healthy" : true ,
"icon_url" : "string" ,
"id" : "497f6eca-6276-4993-bfeb-53cbbbba6f08" ,
"name" : "string" ,
"path_app_url" : "string" ,
"wildcard_hostname" : "string"
}
]
}
Name Type Required Restrictions Description regionsarray of codersdk.Region false
{
"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"
}
Name Type Required Restrictions Description created_atstring false Created at is the timestamp when the replica was first seen. database_latencyinteger false Database latency is the latency in microseconds to the database. errorstring false Error is the replica error. hostnamestring false Hostname is the hostname of the replica. idstring false ID is the unique identifier for the replica. region_idinteger false Region ID is the region of the replica. relay_addressstring false Relay address is the accessible address to relay DERP connections.
Value templatetemplate_versionuserworkspaceworkspace_buildgit_ssh_keyapi_keygrouplicense
{
"detail" : "string" ,
"message" : "string" ,
"validations" : [
{
"detail" : "string" ,
"field" : "string"
}
]
}
Name Type Required Restrictions Description detailstring 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" messagestring 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." validationsarray 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'.
{
"display_name" : "string" ,
"name" : "string"
}
Name Type Required Restrictions Description display_namestring false namestring false
{
"deploymentName" : "string" ,
"sshconfigOptions" : ["string" ]
}
Name Type Required Restrictions Description deploymentNamestring false Deploymentname is the config-ssh Hostname prefix sshconfigOptionsarray of string false Sshconfigoptions are additional options to add to the ssh config file. This will override defaults.
{
"hostname_prefix" : "string" ,
"ssh_config_options" : {
"property1" : "string" ,
"property2" : "string"
}
}
Name Type Required Restrictions Description hostname_prefixstring false ssh_config_optionsobject false » [any property] string false
{
"background_color" : "string" ,
"enabled" : true ,
"message" : "string"
}
Name Type Required Restrictions Description background_colorstring false enabledboolean false messagestring false
{
"jetbrains" : 0 ,
"reconnecting_pty" : 0 ,
"ssh" : 0 ,
"vscode" : 0
}
Name Type Required Restrictions Description jetbrainsinteger false reconnecting_ptyinteger false sshinteger false vscodeinteger false
{
"links" : {
"value" : [
{
"icon" : "string" ,
"name" : "string" ,
"target" : "string"
}
]
}
}
Name Type Required Restrictions Description enableboolean false
{
"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
}
Name Type Required Restrictions Description addressclibase.HostPort false cert_filearray of string false client_authstring false client_ca_filestring false client_cert_filestring false client_key_filestring false enableboolean false key_filearray of string false min_versionstring false redirect_httpboolean false
{
"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" : {}
}
}
Name Type Required Restrictions Description enableboolean false traceboolean false urlclibase.URL false
{
"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"
}
Name Type Required Restrictions Description active_user_countinteger false Active user count is set to -1 when loading. active_version_idstring false allow_user_autostartboolean 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_autostopboolean false allow_user_cancel_workspace_jobsboolean false build_time_statscodersdk.TemplateBuildTimeStats false created_atstring false created_by_idstring false created_by_namestring false default_ttl_msinteger false descriptionstring false display_namestring false failure_ttl_msinteger 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. iconstring false idstring false inactivity_ttl_msinteger false max_ttl_msinteger 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. namestring false organization_idstring false provisionerstring false updated_atstring false
Property Value provisionerterraform
{
"property1" : {
"p50" : 123 ,
"p95" : 146
},
"property2" : {
"p50" : 123 ,
"p95" : 146
}
}
{
"description" : "string" ,
"icon" : "string" ,
"id" : "497f6eca-6276-4993-bfeb-53cbbbba6f08" ,
"markdown" : "string" ,
"name" : "string" ,
"tags" : ["string" ],
"url" : "string"
}
Name Type Required Restrictions Description descriptionstring false iconstring false idstring false markdownstring false namestring false tagsarray of string false urlstring false
{
"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"
}
Name Type Required Restrictions Description avatar_urlstring false created_atstring true emailstring true idstring true last_seen_atstring false organization_idsarray of string false rolecodersdk.TemplateRole false rolesarray of codersdk.Role false statuscodersdk.UserStatus false usernamestring true
Property Value roleadminroleusestatusactivestatussuspended
{
"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" ]
}
{
"authenticate_url" : "string" ,
"authenticated" : true ,
"id" : "string" ,
"type" : "azure-devops"
}
Name Type Required Restrictions Description authenticate_urlstring false authenticatedboolean false idstring false typecodersdk.GitProvider false
{
"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"
}
Name Type Required Restrictions Description default_valuestring false descriptionstring false description_plaintextstring false display_namestring false iconstring false legacy_variable_namestring false mutableboolean false namestring false optionsarray of codersdk.TemplateVersionParameterOption false requiredboolean false typestring false validation_errorstring false validation_maxinteger false validation_mininteger false validation_monotoniccodersdk.ValidationMonotonicOrder false validation_regexstring false
Property Value typestringtypenumbertypebooltypelist(string)validation_monotonicincreasingvalidation_monotonicdecreasing
{
"description" : "string" ,
"icon" : "string" ,
"name" : "string" ,
"value" : "string"
}
Name Type Required Restrictions Description descriptionstring false iconstring false namestring false valuestring false
{
"default_value" : "string" ,
"description" : "string" ,
"name" : "string" ,
"required" : true ,
"sensitive" : true ,
"type" : "string" ,
"value" : "string"
}
Name Type Required Restrictions Description default_valuestring false descriptionstring false namestring false requiredboolean false sensitiveboolean false typestring false valuestring false
Property Value typestringtypenumbertypebool
Value UNSUPPORTED_WORKSPACES
{
"max_token_lifetime" : 0
}
Name Type Required Restrictions Description max_token_lifetimeinteger false
{
"capture_logs" : true ,
"enable" : true ,
"honeycomb_api_key" : "string"
}
Name Type Required Restrictions Description capture_logsboolean false enableboolean false honeycomb_api_keystring false
{
"p50" : 123 ,
"p95" : 146
}
Name Type Required Restrictions Description p50integer false p95integer false
{
"id" : "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
Name Type Required Restrictions Description idstring true
{
"logo_url" : "string" ,
"service_banner" : {
"background_color" : "string" ,
"enabled" : true ,
"message" : "string"
}
}
{
"current" : true ,
"url" : "string" ,
"version" : "string"
}
Name Type Required Restrictions Description currentboolean false Current indicates whether the server version is the same as the latest. urlstring false URL to download the latest release of Coder. versionstring false Version is the semantic version for the latest release of Coder.
Name Type Required Restrictions Description rolesarray of string false
{
"group_perms" : {
"property1" : "admin" ,
"property2" : "admin"
},
"user_perms" : {
"property1" : "admin" ,
"property2" : "admin"
}
}
{
"old_password" : "string" ,
"password" : "string"
}
Name Type Required Restrictions Description old_passwordstring false passwordstring true
Name Type Required Restrictions Description usernamestring true
Name Type Required Restrictions Description schedulestring false
Name Type Required Restrictions Description namestring false
Name Type Required Restrictions Description ttl_msinteger false
{
"hash" : "19686d84-b10d-4f90-b18e-84fd3fa038fd"
}
Name Type Required Restrictions Description hashstring false
{
"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 Type Required Restrictions Description avatar_urlstring false created_atstring true emailstring true idstring true last_seen_atstring false organization_idsarray of string false rolesarray of codersdk.Role false statuscodersdk.UserStatus false usernamestring true
Property Value statusactivestatussuspended
{
"detail" : "string" ,
"field" : "string"
}
Name Type Required Restrictions Description detailstring true fieldstring true
Value increasingdecreasing
{
"name" : "string" ,
"value" : "string"
}
Name Type Required Restrictions Description namestring false valuestring false
{
"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"
}
Name Type Required Restrictions Description autostart_schedulestring false created_atstring false deleting_atstring 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. idstring false last_used_atstring false latest_buildcodersdk.WorkspaceBuild false namestring false organization_idstring false outdatedboolean false owner_idstring false owner_namestring false template_allow_user_cancel_workspace_jobsboolean false template_display_namestring false template_iconstring false template_idstring false template_namestring false ttl_msinteger false updated_atstring false
{
"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"
}
Name Type Required Restrictions Description appsarray of codersdk.WorkspaceApp false architecturestring false connection_timeout_secondsinteger false created_atstring false directorystring false disconnected_atstring false environment_variablesobject false » [any property] string false expanded_directorystring false first_connected_atstring false idstring false instance_idstring false last_connected_atstring false latencyobject false Latency is mapped by region name (e.g. "New York City", "Seattle"). » [any property] codersdk.DERPRegion false lifecycle_statecodersdk.WorkspaceAgentLifecycle false login_before_readyboolean false Login before ready if true, the agent will delay logins until it is ready (e.g. executing startup script has ended). namestring false operating_systemstring false resource_idstring false shutdown_scriptstring false shutdown_script_timeout_secondsinteger false startup_logs_lengthinteger false startup_logs_overflowedboolean false startup_scriptstring false startup_script_timeout_secondsinteger 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. statuscodersdk.WorkspaceAgentStatus false subsystemcodersdk.AgentSubsystem false troubleshooting_urlstring false updated_atstring false versionstring false
{
"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"
}
}
}
}
Value createdstartingstart_timeoutstart_errorreadyshutting_downshutdown_timeoutshutdown_erroroff
{
"network" : "string" ,
"port" : 0 ,
"process_name" : "string"
}
Name Type Required Restrictions Description networkstring false only "tcp" at the moment portinteger false process_namestring false may be empty
{
"ports" : [
{
"network" : "string" ,
"port" : 0 ,
"process_name" : "string"
}
]
}
Name Type Required Restrictions Description portsarray 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
}
Name Type Required Restrictions Description display_namestring false intervalinteger false keystring false scriptstring false timeoutinteger false
{
"created_at" : "2019-08-24T14:15:22Z" ,
"id" : 0 ,
"level" : "trace" ,
"output" : "string"
}
Name Type Required Restrictions Description created_atstring false idinteger false levelcodersdk.LogLevel false outputstring false
Value connectingconnecteddisconnectedtimeout
{
"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"
}
Name Type Required Restrictions Description commandstring false display_namestring false Display name is a friendly name for the app. externalboolean false External specifies whether the URL should be opened externally on the client or not. healthcodersdk.WorkspaceAppHealth false healthcheckcodersdk.Healthcheck false Healthcheck specifies the configuration for checking app health. iconstring false Icon is a relative path or external URL that specifies an icon to be displayed in the dashboard. idstring false sharing_levelcodersdk.WorkspaceAppSharingLevel false slugstring false Slug is a unique identifier within the agent. subdomainboolean 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. urlstring false URL is the address being proxied to inside the workspace. If external is specified, this will be opened on the client.
Property Value sharing_levelownersharing_levelauthenticatedsharing_levelpublic
Value disabledinitializinghealthyunhealthy
Value ownerauthenticatedpublic
{
"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"
}
Property Value reasoninitiatorreasonautostartreasonautostopstatuspendingstatusstartingstatusrunningstatusstoppingstatusstoppedstatusfailedstatuscancelingstatuscanceledstatusdeletingstatusdeletedtransitionstarttransitionstoptransitiondelete
{
"name" : "string" ,
"value" : "string"
}
Name Type Required Restrictions Description namestring false valuestring false
Name Type Required Restrictions Description p50number false p95number false
{
"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 buildinginteger false connection_latency_mscodersdk.WorkspaceConnectionLatencyMS false failedinteger false pendinginteger false runninginteger false rx_bytesinteger false stoppedinteger false tx_bytesinteger false
{
"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"
}
Name Type Required Restrictions Description created_atstring false deletedboolean false display_namestring false iconstring false idstring false namestring false statuscodersdk.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_atstring false urlstring false Full URL including scheme of the proxy api url: https://us.example.com wildcard_hostnamestring false Wildcard hostname with the wildcard for subdomain based app hosting: *.us.example.com
{
"checked_at" : "2019-08-24T14:15:22Z" ,
"report" : {
"errors" : ["string" ],
"warnings" : ["string" ]
},
"status" : "ok"
}
{
"budget" : 0 ,
"credits_consumed" : 0
}
Name Type Required Restrictions Description budgetinteger false credits_consumedinteger false
{
"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 