{
"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" ,
"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 updated_atstring true user_idstring true
Property Value login_typepasswordlogin_typegithublogin_typeoidclogin_typetokenscopeallscopeapplication_connect
Value allapplication_connect
{
"document" : "string" ,
"signature" : "string"
}
Name Type Required Restrictions Description documentstring true signaturestring true
Name Type Required Restrictions Description licensestring true
{
"private_key" : "string" ,
"public_key" : "string"
}
Name Type Required Restrictions Description private_keystring false public_keystring false
{
"conns_by_proto" : {
"property1" : 0 ,
"property2" : 0
},
"num_comms" : 0 ,
"rx_bytes" : 0 ,
"rx_packets" : 0 ,
"tx_bytes" : 0 ,
"tx_packets" : 0
}
Name Type Required Restrictions Description conns_by_protoobject false Conns by proto is a count of connections by protocol. ยป [any property] integer false num_commsinteger false Num comms is the number of connections received by an agent. rx_bytesinteger false Rx bytes is the number of received bytes. rx_packetsinteger false Rx packets is the number of received packets. 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.
{
"logo_url" : "string" ,
"service_banner" : {
"background_color" : "string" ,
"enabled" : true ,
"message" : "string"
}
}
{
"assignable" : true ,
"display_name" : "string" ,
"name" : "string"
}
Name Type Required Restrictions Description assignableboolean false display_namestring false namestring false
Value createwritedeletestartstop
{
"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" : "organization" ,
"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" : "organization" ,
"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
{
"github" : true ,
"oidc" : true ,
"password" : true
}
Name Type Required Restrictions Description githubboolean false oidcboolean false passwordboolean false
{
"action" : "create" ,
"object" : {
"organization_id" : "string" ,
"owner_id" : "string" ,
"resource_id" : "string" ,
"resource_type" : "string"
}
}
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" : "string"
}
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_typestring 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" : "string"
}
},
"property2" : {
"action" : "create" ,
"object" : {
"organization_id" : "string" ,
"owner_id" : "string" ,
"resource_id" : "string" ,
"resource_type" : "string"
}
}
}
}
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
{
"encoding" : "string" ,
"signature" : "string"
}
Name Type Required Restrictions Description encodingstring true signaturestring true
{
"external_url" : "string" ,
"version" : "string"
}
Name Type Required Restrictions Description 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.
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
{
"copy_from_parameter" : "000e07d6-021d-446c-be14-48a9c20bca0b" ,
"destination_scheme" : "none" ,
"name" : "string" ,
"source_scheme" : "none" ,
"source_value" : "string"
}
CreateParameterRequest is a structure used to create a new parameter value for a scope.
Name Type Required Restrictions Description copy_from_parameterstring false Copy from parameter allows copying the value of another parameter. The other param must be related to the same template_id for this to succeed. No other fields are required if using this, as all fields will be copied from the other parameter. destination_schemecodersdk.ParameterDestinationScheme true namestring true source_schemecodersdk.ParameterSourceScheme true source_valuestring true
Property Value destination_schemenonedestination_schemeenvironment_variabledestination_schemeprovisioner_variablesource_schemenonesource_schemedata
{
"allow_user_cancel_workspace_jobs" : true ,
"default_ttl_ms" : 0 ,
"description" : "string" ,
"display_name" : "string" ,
"icon" : "string" ,
"name" : "string" ,
"parameter_values" : [
{
"copy_from_parameter" : "000e07d6-021d-446c-be14-48a9c20bca0b" ,
"destination_scheme" : "none" ,
"name" : "string" ,
"source_scheme" : "none" ,
"source_value" : "string"
}
],
"template_version_id" : "0ba39c92-1f1b-4c32-aa3e-9925d7713eb1"
}
Name Type Required Restrictions Description 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. iconstring false Icon is a relative path or external URL that specifies an icon to be displayed in the dashboard. namestring true Name is the name of the template. parameter_valuesarray of codersdk.CreateParameterRequest false Parameter values is a structure used to create a new parameter value for a scope.] 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.
{
"parameter_values" : [
{
"copy_from_parameter" : "000e07d6-021d-446c-be14-48a9c20bca0b" ,
"destination_scheme" : "none" ,
"name" : "string" ,
"source_scheme" : "none" ,
"source_value" : "string"
}
],
"workspace_name" : "string"
}
Name Type Required Restrictions Description parameter_valuesarray of codersdk.CreateParameterRequest false Parameter values is a structure used to create a new parameter value for a scope.] workspace_namestring false
{
"action" : "create" ,
"resource_id" : "4d5215ed-38bb-48ed-879a-fdb9ca58522f" ,
"resource_type" : "organization" ,
"time" : "2019-08-24T14:15:22Z"
}
Property Value actioncreateactionwriteactiondeleteactionstartactionstopresource_typeorganizationresource_typetemplateresource_typetemplate_versionresource_typeuserresource_typeworkspaceresource_typeworkspace_buildresource_typegit_ssh_keyresource_typeapi_keyresource_typegroup
{
"lifetime" : 0 ,
"scope" : "all"
}
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 true passwordstring true usernamestring true
{
"dry_run" : true ,
"orphan" : true ,
"parameter_values" : [
{
"copy_from_parameter" : "000e07d6-021d-446c-be14-48a9c20bca0b" ,
"destination_scheme" : "none" ,
"name" : "string" ,
"source_scheme" : "none" ,
"source_value" : "string"
}
],
"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 orphanboolean false Orphan may be set for the Destroy transition. parameter_valuesarray of codersdk.CreateParameterRequest false 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. rich_parameter_valuesarray of codersdk.WorkspaceBuildParameter false statearray of integer false template_version_idstring false transitioncodersdk.WorkspaceTransition true
Property Value transitioncreatetransitionstarttransitionstoptransitiondelete
{
"amount" : 0 ,
"date" : "2019-08-24T14:15:22Z"
}
Name Type Required Restrictions Description amountinteger false datestring false
{
"config" : {
"path" : {
"default" : "string" ,
"enterprise" : true ,
"flag" : "string" ,
"hidden" : true ,
"name" : "string" ,
"secret" : true ,
"shorthand" : "string" ,
"usage" : "string" ,
"value" : "string"
},
"url" : {
"default" : "string" ,
"enterprise" : true ,
"flag" : "string" ,
"hidden" : true ,
"name" : "string" ,
"secret" : true ,
"shorthand" : "string" ,
"usage" : "string" ,
"value" : "string"
}
},
"server" : {
"enable" : {
"default" : true ,
"enterprise" : true ,
"flag" : "string" ,
"hidden" : true ,
"name" : "string" ,
"secret" : true ,
"shorthand" : "string" ,
"usage" : "string" ,
"value" : true
},
"region_code" : {
"default" : "string" ,
"enterprise" : true ,
"flag" : "string" ,
"hidden" : true ,
"name" : "string" ,
"secret" : true ,
"shorthand" : "string" ,
"usage" : "string" ,
"value" : "string"
},
"region_id" : {
"default" : 0 ,
"enterprise" : true ,
"flag" : "string" ,
"hidden" : true ,
"name" : "string" ,
"secret" : true ,
"shorthand" : "string" ,
"usage" : "string" ,
"value" : 0
},
"region_name" : {
"default" : "string" ,
"enterprise" : true ,
"flag" : "string" ,
"hidden" : true ,
"name" : "string" ,
"secret" : true ,
"shorthand" : "string" ,
"usage" : "string" ,
"value" : "string"
},
"relay_url" : {
"default" : "string" ,
"enterprise" : true ,
"flag" : "string" ,
"hidden" : true ,
"name" : "string" ,
"secret" : true ,
"shorthand" : "string" ,
"usage" : "string" ,
"value" : "string"
},
"stun_addresses" : {
"default" : ["string" ],
"enterprise" : true ,
"flag" : "string" ,
"hidden" : true ,
"name" : "string" ,
"secret" : true ,
"shorthand" : "string" ,
"usage" : "string" ,
"value" : ["string" ]
}
}
}
{
"path" : {
"default" : "string" ,
"enterprise" : true ,
"flag" : "string" ,
"hidden" : true ,
"name" : "string" ,
"secret" : true ,
"shorthand" : "string" ,
"usage" : "string" ,
"value" : "string"
},
"url" : {
"default" : "string" ,
"enterprise" : true ,
"flag" : "string" ,
"hidden" : true ,
"name" : "string" ,
"secret" : true ,
"shorthand" : "string" ,
"usage" : "string" ,
"value" : "string"
}
}
{
"latency_ms" : 0 ,
"preferred" : true
}
Name Type Required Restrictions Description latency_msnumber false preferredboolean false
{
"enable" : {
"default" : true ,
"enterprise" : true ,
"flag" : "string" ,
"hidden" : true ,
"name" : "string" ,
"secret" : true ,
"shorthand" : "string" ,
"usage" : "string" ,
"value" : true
},
"region_code" : {
"default" : "string" ,
"enterprise" : true ,
"flag" : "string" ,
"hidden" : true ,
"name" : "string" ,
"secret" : true ,
"shorthand" : "string" ,
"usage" : "string" ,
"value" : "string"
},
"region_id" : {
"default" : 0 ,
"enterprise" : true ,
"flag" : "string" ,
"hidden" : true ,
"name" : "string" ,
"secret" : true ,
"shorthand" : "string" ,
"usage" : "string" ,
"value" : 0
},
"region_name" : {
"default" : "string" ,
"enterprise" : true ,
"flag" : "string" ,
"hidden" : true ,
"name" : "string" ,
"secret" : true ,
"shorthand" : "string" ,
"usage" : "string" ,
"value" : "string"
},
"relay_url" : {
"default" : "string" ,
"enterprise" : true ,
"flag" : "string" ,
"hidden" : true ,
"name" : "string" ,
"secret" : true ,
"shorthand" : "string" ,
"usage" : "string" ,
"value" : "string"
},
"stun_addresses" : {
"default" : ["string" ],
"enterprise" : true ,
"flag" : "string" ,
"hidden" : true ,
"name" : "string" ,
"secret" : true ,
"shorthand" : "string" ,
"usage" : "string" ,
"value" : ["string" ]
}
}
{
"access_url" : {
"default" : "string" ,
"enterprise" : true ,
"flag" : "string" ,
"hidden" : true ,
"name" : "string" ,
"secret" : true ,
"shorthand" : "string" ,
"usage" : "string" ,
"value" : "string"
},
"address" : {
"default" : "string" ,
"enterprise" : true ,
"flag" : "string" ,
"hidden" : true ,
"name" : "string" ,
"secret" : true ,
"shorthand" : "string" ,
"usage" : "string" ,
"value" : "string"
},
"agent_fallback_troubleshooting_url" : {
"default" : "string" ,
"enterprise" : true ,
"flag" : "string" ,
"hidden" : true ,
"name" : "string" ,
"secret" : true ,
"shorthand" : "string" ,
"usage" : "string" ,
"value" : "string"
},
"agent_stat_refresh_interval" : {
"default" : 0 ,
"enterprise" : true ,
"flag" : "string" ,
"hidden" : true ,
"name" : "string" ,
"secret" : true ,
"shorthand" : "string" ,
"usage" : "string" ,
"value" : 0
},
"audit_logging" : {
"default" : true ,
"enterprise" : true ,
"flag" : "string" ,
"hidden" : true ,
"name" : "string" ,
"secret" : true ,
"shorthand" : "string" ,
"usage" : "string" ,
"value" : true
},
"autobuild_poll_interval" : {
"default" : 0 ,
"enterprise" : true ,
"flag" : "string" ,
"hidden" : true ,
"name" : "string" ,
"secret" : true ,
"shorthand" : "string" ,
"usage" : "string" ,
"value" : 0
},
"browser_only" : {
"default" : true ,
"enterprise" : true ,
"flag" : "string" ,
"hidden" : true ,
"name" : "string" ,
"secret" : true ,
"shorthand" : "string" ,
"usage" : "string" ,
"value" : true
},
"cache_directory" : {
"default" : "string" ,
"enterprise" : true ,
"flag" : "string" ,
"hidden" : true ,
"name" : "string" ,
"secret" : true ,
"shorthand" : "string" ,
"usage" : "string" ,
"value" : "string"
},
"derp" : {
"config" : {
"path" : {
"default" : "string" ,
"enterprise" : true ,
"flag" : "string" ,
"hidden" : true ,
"name" : "string" ,
"secret" : true ,
"shorthand" : "string" ,
"usage" : "string" ,
"value" : "string"
},
"url" : {
"default" : "string" ,
"enterprise" : true ,
"flag" : "string" ,
"hidden" : true ,
"name" : "string" ,
"secret" : true ,
"shorthand" : "string" ,
"usage" : "string" ,
"value" : "string"
}
},
"server" : {
"enable" : {
"default" : true ,
"enterprise" : true ,
"flag" : "string" ,
"hidden" : true ,
"name" : "string" ,
"secret" : true ,
"shorthand" : "string" ,
"usage" : "string" ,
"value" : true
},
"region_code" : {
"default" : "string" ,
"enterprise" : true ,
"flag" : "string" ,
"hidden" : true ,
"name" : "string" ,
"secret" : true ,
"shorthand" : "string" ,
"usage" : "string" ,
"value" : "string"
},
"region_id" : {
"default" : 0 ,
"enterprise" : true ,
"flag" : "string" ,
"hidden" : true ,
"name" : "string" ,
"secret" : true ,
"shorthand" : "string" ,
"usage" : "string" ,
"value" : 0
},
"region_name" : {
"default" : "string" ,
"enterprise" : true ,
"flag" : "string" ,
"hidden" : true ,
"name" : "string" ,
"secret" : true ,
"shorthand" : "string" ,
"usage" : "string" ,
"value" : "string"
},
"relay_url" : {
"default" : "string" ,
"enterprise" : true ,
"flag" : "string" ,
"hidden" : true ,
"name" : "string" ,
"secret" : true ,
"shorthand" : "string" ,
"usage" : "string" ,
"value" : "string"
},
"stun_addresses" : {
"default" : ["string" ],
"enterprise" : true ,
"flag" : "string" ,
"hidden" : true ,
"name" : "string" ,
"secret" : true ,
"shorthand" : "string" ,
"usage" : "string" ,
"value" : ["string" ]
}
}
},
"experimental" : {
"default" : true ,
"enterprise" : true ,
"flag" : "string" ,
"hidden" : true ,
"name" : "string" ,
"secret" : true ,
"shorthand" : "string" ,
"usage" : "string" ,
"value" : true
},
"gitauth" : {
"default" : [
{
"auth_url" : "string" ,
"client_id" : "string" ,
"id" : "string" ,
"no_refresh" : true ,
"regex" : "string" ,
"scopes" : ["string" ],
"token_url" : "string" ,
"type" : "string" ,
"validate_url" : "string"
}
],
"enterprise" : true ,
"flag" : "string" ,
"hidden" : true ,
"name" : "string" ,
"secret" : true ,
"shorthand" : "string" ,
"usage" : "string" ,
"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" : {
"default" : "string" ,
"enterprise" : true ,
"flag" : "string" ,
"hidden" : true ,
"name" : "string" ,
"secret" : true ,
"shorthand" : "string" ,
"usage" : "string" ,
"value" : "string"
},
"in_memory_database" : {
"default" : true ,
"enterprise" : true ,
"flag" : "string" ,
"hidden" : true ,
"name" : "string" ,
"secret" : true ,
"shorthand" : "string" ,
"usage" : "string" ,
"value" : true
},
"logging" : {
"human" : {
"default" : "string" ,
"enterprise" : true ,
"flag" : "string" ,
"hidden" : true ,
"name" : "string" ,
"secret" : true ,
"shorthand" : "string" ,
"usage" : "string" ,
"value" : "string"
},
"json" : {
"default" : "string" ,
"enterprise" : true ,
"flag" : "string" ,
"hidden" : true ,
"name" : "string" ,
"secret" : true ,
"shorthand" : "string" ,
"usage" : "string" ,
"value" : "string"
},
"stackdriver" : {
"default" : "string" ,
"enterprise" : true ,
"flag" : "string" ,
"hidden" : true ,
"name" : "string" ,
"secret" : true ,
"shorthand" : "string" ,
"usage" : "string" ,
"value" : "string"
}
},
"max_token_lifetime" : {
"default" : 0 ,
"enterprise" : true ,
"flag" : "string" ,
"hidden" : true ,
"name" : "string" ,
"secret" : true ,
"shorthand" : "string" ,
"usage" : "string" ,
"value" : 0
},
"metrics_cache_refresh_interval" : {
"default" : 0 ,
"enterprise" : true ,
"flag" : "string" ,
"hidden" : true ,
"name" : "string" ,
"secret" : true ,
"shorthand" : "string" ,
"usage" : "string" ,
"value" : 0
},
"oauth2" : {
"github" : {
"allow_everyone" : {
"default" : true ,
"enterprise" : true ,
"flag" : "string" ,
"hidden" : true ,
"name" : "string" ,
"secret" : true ,
"shorthand" : "string" ,
"usage" : "string" ,
"value" : true
},
"allow_signups" : {
"default" : true ,
"enterprise" : true ,
"flag" : "string" ,
"hidden" : true ,
"name" : "string" ,
"secret" : true ,
"shorthand" : "string" ,
"usage" : "string" ,
"value" : true
},
"allowed_orgs" : {
"default" : ["string" ],
"enterprise" : true ,
"flag" : "string" ,
"hidden" : true ,
"name" : "string" ,
"secret" : true ,
"shorthand" : "string" ,
"usage" : "string" ,
"value" : ["string" ]
},
"allowed_teams" : {
"default" : ["string" ],
"enterprise" : true ,
"flag" : "string" ,
"hidden" : true ,
"name" : "string" ,
"secret" : true ,
"shorthand" : "string" ,
"usage" : "string" ,
"value" : ["string" ]
},
"client_id" : {
"default" : "string" ,
"enterprise" : true ,
"flag" : "string" ,
"hidden" : true ,
"name" : "string" ,
"secret" : true ,
"shorthand" : "string" ,
"usage" : "string" ,
"value" : "string"
},
"client_secret" : {
"default" : "string" ,
"enterprise" : true ,
"flag" : "string" ,
"hidden" : true ,
"name" : "string" ,
"secret" : true ,
"shorthand" : "string" ,
"usage" : "string" ,
"value" : "string"
},
"enterprise_base_url" : {
"default" : "string" ,
"enterprise" : true ,
"flag" : "string" ,
"hidden" : true ,
"name" : "string" ,
"secret" : true ,
"shorthand" : "string" ,
"usage" : "string" ,
"value" : "string"
}
}
},
"oidc" : {
"allow_signups" : {
"default" : true ,
"enterprise" : true ,
"flag" : "string" ,
"hidden" : true ,
"name" : "string" ,
"secret" : true ,
"shorthand" : "string" ,
"usage" : "string" ,
"value" : true
},
"client_id" : {
"default" : "string" ,
"enterprise" : true ,
"flag" : "string" ,
"hidden" : true ,
"name" : "string" ,
"secret" : true ,
"shorthand" : "string" ,
"usage" : "string" ,
"value" : "string"
},
"client_secret" : {
"default" : "string" ,
"enterprise" : true ,
"flag" : "string" ,
"hidden" : true ,
"name" : "string" ,
"secret" : true ,
"shorthand" : "string" ,
"usage" : "string" ,
"value" : "string"
},
"email_domain" : {
"default" : ["string" ],
"enterprise" : true ,
"flag" : "string" ,
"hidden" : true ,
"name" : "string" ,
"secret" : true ,
"shorthand" : "string" ,
"usage" : "string" ,
"value" : ["string" ]
},
"ignore_email_verified" : {
"default" : true ,
"enterprise" : true ,
"flag" : "string" ,
"hidden" : true ,
"name" : "string" ,
"secret" : true ,
"shorthand" : "string" ,
"usage" : "string" ,
"value" : true
},
"issuer_url" : {
"default" : "string" ,
"enterprise" : true ,
"flag" : "string" ,
"hidden" : true ,
"name" : "string" ,
"secret" : true ,
"shorthand" : "string" ,
"usage" : "string" ,
"value" : "string"
},
"scopes" : {
"default" : ["string" ],
"enterprise" : true ,
"flag" : "string" ,
"hidden" : true ,
"name" : "string" ,
"secret" : true ,
"shorthand" : "string" ,
"usage" : "string" ,
"value" : ["string" ]
},
"username_field" : {
"default" : "string" ,
"enterprise" : true ,
"flag" : "string" ,
"hidden" : true ,
"name" : "string" ,
"secret" : true ,
"shorthand" : "string" ,
"usage" : "string" ,
"value" : "string"
}
},
"pg_connection_url" : {
"default" : "string" ,
"enterprise" : true ,
"flag" : "string" ,
"hidden" : true ,
"name" : "string" ,
"secret" : true ,
"shorthand" : "string" ,
"usage" : "string" ,
"value" : "string"
},
"pprof" : {
"address" : {
"default" : "string" ,
"enterprise" : true ,
"flag" : "string" ,
"hidden" : true ,
"name" : "string" ,
"secret" : true ,
"shorthand" : "string" ,
"usage" : "string" ,
"value" : "string"
},
"enable" : {
"default" : true ,
"enterprise" : true ,
"flag" : "string" ,
"hidden" : true ,
"name" : "string" ,
"secret" : true ,
"shorthand" : "string" ,
"usage" : "string" ,
"value" : true
}
},
"prometheus" : {
"address" : {
"default" : "string" ,
"enterprise" : true ,
"flag" : "string" ,
"hidden" : true ,
"name" : "string" ,
"secret" : true ,
"shorthand" : "string" ,
"usage" : "string" ,
"value" : "string"
},
"enable" : {
"default" : true ,
"enterprise" : true ,
"flag" : "string" ,
"hidden" : true ,
"name" : "string" ,
"secret" : true ,
"shorthand" : "string" ,
"usage" : "string" ,
"value" : true
}
},
"provisioner" : {
"daemon_poll_interval" : {
"default" : 0 ,
"enterprise" : true ,
"flag" : "string" ,
"hidden" : true ,
"name" : "string" ,
"secret" : true ,
"shorthand" : "string" ,
"usage" : "string" ,
"value" : 0
},
"daemon_poll_jitter" : {
"default" : 0 ,
"enterprise" : true ,
"flag" : "string" ,
"hidden" : true ,
"name" : "string" ,
"secret" : true ,
"shorthand" : "string" ,
"usage" : "string" ,
"value" : 0
},
"daemons" : {
"default" : 0 ,
"enterprise" : true ,
"flag" : "string" ,
"hidden" : true ,
"name" : "string" ,
"secret" : true ,
"shorthand" : "string" ,
"usage" : "string" ,
"value" : 0
},
"force_cancel_interval" : {
"default" : 0 ,
"enterprise" : true ,
"flag" : "string" ,
"hidden" : true ,
"name" : "string" ,
"secret" : true ,
"shorthand" : "string" ,
"usage" : "string" ,
"value" : 0
}
},
"proxy_trusted_headers" : {
"default" : ["string" ],
"enterprise" : true ,
"flag" : "string" ,
"hidden" : true ,
"name" : "string" ,
"secret" : true ,
"shorthand" : "string" ,
"usage" : "string" ,
"value" : ["string" ]
},
"proxy_trusted_origins" : {
"default" : ["string" ],
"enterprise" : true ,
"flag" : "string" ,
"hidden" : true ,
"name" : "string" ,
"secret" : true ,
"shorthand" : "string" ,
"usage" : "string" ,
"value" : ["string" ]
},
"rate_limit" : {
"api" : {
"default" : 0 ,
"enterprise" : true ,
"flag" : "string" ,
"hidden" : true ,
"name" : "string" ,
"secret" : true ,
"shorthand" : "string" ,
"usage" : "string" ,
"value" : 0
},
"disable_all" : {
"default" : true ,
"enterprise" : true ,
"flag" : "string" ,
"hidden" : true ,
"name" : "string" ,
"secret" : true ,
"shorthand" : "string" ,
"usage" : "string" ,
"value" : true
}
},
"scim_api_key" : {
"default" : "string" ,
"enterprise" : true ,
"flag" : "string" ,
"hidden" : true ,
"name" : "string" ,
"secret" : true ,
"shorthand" : "string" ,
"usage" : "string" ,
"value" : "string"
},
"secure_auth_cookie" : {
"default" : true ,
"enterprise" : true ,
"flag" : "string" ,
"hidden" : true ,
"name" : "string" ,
"secret" : true ,
"shorthand" : "string" ,
"usage" : "string" ,
"value" : true
},
"ssh_keygen_algorithm" : {
"default" : "string" ,
"enterprise" : true ,
"flag" : "string" ,
"hidden" : true ,
"name" : "string" ,
"secret" : true ,
"shorthand" : "string" ,
"usage" : "string" ,
"value" : "string"
},
"swagger" : {
"enable" : {
"default" : true ,
"enterprise" : true ,
"flag" : "string" ,
"hidden" : true ,
"name" : "string" ,
"secret" : true ,
"shorthand" : "string" ,
"usage" : "string" ,
"value" : true
}
},
"telemetry" : {
"enable" : {
"default" : true ,
"enterprise" : true ,
"flag" : "string" ,
"hidden" : true ,
"name" : "string" ,
"secret" : true ,
"shorthand" : "string" ,
"usage" : "string" ,
"value" : true
},
"trace" : {
"default" : true ,
"enterprise" : true ,
"flag" : "string" ,
"hidden" : true ,
"name" : "string" ,
"secret" : true ,
"shorthand" : "string" ,
"usage" : "string" ,
"value" : true
},
"url" : {
"default" : "string" ,
"enterprise" : true ,
"flag" : "string" ,
"hidden" : true ,
"name" : "string" ,
"secret" : true ,
"shorthand" : "string" ,
"usage" : "string" ,
"value" : "string"
}
},
"tls" : {
"address" : {
"default" : "string" ,
"enterprise" : true ,
"flag" : "string" ,
"hidden" : true ,
"name" : "string" ,
"secret" : true ,
"shorthand" : "string" ,
"usage" : "string" ,
"value" : "string"
},
"cert_file" : {
"default" : ["string" ],
"enterprise" : true ,
"flag" : "string" ,
"hidden" : true ,
"name" : "string" ,
"secret" : true ,
"shorthand" : "string" ,
"usage" : "string" ,
"value" : ["string" ]
},
"client_auth" : {
"default" : "string" ,
"enterprise" : true ,
"flag" : "string" ,
"hidden" : true ,
"name" : "string" ,
"secret" : true ,
"shorthand" : "string" ,
"usage" : "string" ,
"value" : "string"
},
"client_ca_file" : {
"default" : "string" ,
"enterprise" : true ,
"flag" : "string" ,
"hidden" : true ,
"name" : "string" ,
"secret" : true ,
"shorthand" : "string" ,
"usage" : "string" ,
"value" : "string"
},
"client_cert_file" : {
"default" : "string" ,
"enterprise" : true ,
"flag" : "string" ,
"hidden" : true ,
"name" : "string" ,
"secret" : true ,
"shorthand" : "string" ,
"usage" : "string" ,
"value" : "string"
},
"client_key_file" : {
"default" : "string" ,
"enterprise" : true ,
"flag" : "string" ,
"hidden" : true ,
"name" : "string" ,
"secret" : true ,
"shorthand" : "string" ,
"usage" : "string" ,
"value" : "string"
},
"enable" : {
"default" : true ,
"enterprise" : true ,
"flag" : "string" ,
"hidden" : true ,
"name" : "string" ,
"secret" : true ,
"shorthand" : "string" ,
"usage" : "string" ,
"value" : true
},
"key_file" : {
"default" : ["string" ],
"enterprise" : true ,
"flag" : "string" ,
"hidden" : true ,
"name" : "string" ,
"secret" : true ,
"shorthand" : "string" ,
"usage" : "string" ,
"value" : ["string" ]
},
"min_version" : {
"default" : "string" ,
"enterprise" : true ,
"flag" : "string" ,
"hidden" : true ,
"name" : "string" ,
"secret" : true ,
"shorthand" : "string" ,
"usage" : "string" ,
"value" : "string"
},
"redirect_http" : {
"default" : true ,
"enterprise" : true ,
"flag" : "string" ,
"hidden" : true ,
"name" : "string" ,
"secret" : true ,
"shorthand" : "string" ,
"usage" : "string" ,
"value" : true
}
},
"trace" : {
"capture_logs" : {
"default" : true ,
"enterprise" : true ,
"flag" : "string" ,
"hidden" : true ,
"name" : "string" ,
"secret" : true ,
"shorthand" : "string" ,
"usage" : "string" ,
"value" : true
},
"enable" : {
"default" : true ,
"enterprise" : true ,
"flag" : "string" ,
"hidden" : true ,
"name" : "string" ,
"secret" : true ,
"shorthand" : "string" ,
"usage" : "string" ,
"value" : true
},
"honeycomb_api_key" : {
"default" : "string" ,
"enterprise" : true ,
"flag" : "string" ,
"hidden" : true ,
"name" : "string" ,
"secret" : true ,
"shorthand" : "string" ,
"usage" : "string" ,
"value" : "string"
}
},
"update_check" : {
"default" : true ,
"enterprise" : true ,
"flag" : "string" ,
"hidden" : true ,
"name" : "string" ,
"secret" : true ,
"shorthand" : "string" ,
"usage" : "string" ,
"value" : true
},
"wildcard_access_url" : {
"default" : "string" ,
"enterprise" : true ,
"flag" : "string" ,
"hidden" : true ,
"name" : "string" ,
"secret" : true ,
"shorthand" : "string" ,
"usage" : "string" ,
"value" : "string"
}
}
{
"default" : [
{
"auth_url" : "string" ,
"client_id" : "string" ,
"id" : "string" ,
"no_refresh" : true ,
"regex" : "string" ,
"scopes" : ["string" ],
"token_url" : "string" ,
"type" : "string" ,
"validate_url" : "string"
}
],
"enterprise" : true ,
"flag" : "string" ,
"hidden" : true ,
"name" : "string" ,
"secret" : true ,
"shorthand" : "string" ,
"usage" : "string" ,
"value" : [
{
"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 defaultarray of codersdk.GitAuthConfig false enterpriseboolean false flagstring false hiddenboolean false namestring false secretboolean false shorthandstring false usagestring false valuearray of codersdk.GitAuthConfig false
{
"default" : ["string" ],
"enterprise" : true ,
"flag" : "string" ,
"hidden" : true ,
"name" : "string" ,
"secret" : true ,
"shorthand" : "string" ,
"usage" : "string" ,
"value" : ["string" ]
}
Name Type Required Restrictions Description defaultarray of string false enterpriseboolean false flagstring false hiddenboolean false namestring false secretboolean false shorthandstring false usagestring false valuearray of string false
{
"default" : true ,
"enterprise" : true ,
"flag" : "string" ,
"hidden" : true ,
"name" : "string" ,
"secret" : true ,
"shorthand" : "string" ,
"usage" : "string" ,
"value" : true
}
Name Type Required Restrictions Description defaultboolean false enterpriseboolean false flagstring false hiddenboolean false namestring false secretboolean false shorthandstring false usagestring false valueboolean false
{
"default" : 0 ,
"enterprise" : true ,
"flag" : "string" ,
"hidden" : true ,
"name" : "string" ,
"secret" : true ,
"shorthand" : "string" ,
"usage" : "string" ,
"value" : 0
}
Name Type Required Restrictions Description defaultinteger false enterpriseboolean false flagstring false hiddenboolean false namestring false secretboolean false shorthandstring false usagestring false valueinteger false
{
"default" : "string" ,
"enterprise" : true ,
"flag" : "string" ,
"hidden" : true ,
"name" : "string" ,
"secret" : true ,
"shorthand" : "string" ,
"usage" : "string" ,
"value" : "string"
}
Name Type Required Restrictions Description defaultstring false enterpriseboolean false flagstring false hiddenboolean false namestring false secretboolean false shorthandstring false usagestring false valuestring false
{
"default" : 0 ,
"enterprise" : true ,
"flag" : "string" ,
"hidden" : true ,
"name" : "string" ,
"secret" : true ,
"shorthand" : "string" ,
"usage" : "string" ,
"value" : 0
}
Name Type Required Restrictions Description defaultinteger false enterpriseboolean false flagstring false hiddenboolean false namestring false secretboolean false shorthandstring false usagestring false valueinteger false
Value entitledgrace_periodnot_entitled
{
"errors" : ["string" ],
"experimental" : true ,
"features" : {
"property1" : {
"actual" : 0 ,
"enabled" : true ,
"entitlement" : "entitled" ,
"limit" : 0
},
"property2" : {
"actual" : 0 ,
"enabled" : true ,
"entitlement" : "entitled" ,
"limit" : 0
}
},
"has_license" : true ,
"trial" : true ,
"warnings" : ["string" ]
}
Name Type Required Restrictions Description errorsarray of string false experimentalboolean false featuresobject false ยป [any property] codersdk.Feature false has_licenseboolean false trialboolean false warningsarray of string 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
Name Type Required Restrictions Description hoststring false Host is the externally accessible URL for the Coder instance.
{
"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
{
"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
{
"json_web_token" : "string"
}
Name Type Required Restrictions Description json_web_tokenstring true
{
"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.
{
"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
{
"network" : "tcp" ,
"port" : 0 ,
"process_name" : "string"
}
Name Type Required Restrictions Description networkcodersdk.ListeningPortNetwork false only "tcp" at the moment portinteger false process_namestring false may be empty
{
"ports" : [
{
"network" : "tcp" ,
"port" : 0 ,
"process_name" : "string"
}
]
}
Name Type Required Restrictions Description portsarray of codersdk.ListeningPort 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.
Value tracedebuginfowarnerror
Value provisioner_daemonprovisioner
{
"human" : {
"default" : "string" ,
"enterprise" : true ,
"flag" : "string" ,
"hidden" : true ,
"name" : "string" ,
"secret" : true ,
"shorthand" : "string" ,
"usage" : "string" ,
"value" : "string"
},
"json" : {
"default" : "string" ,
"enterprise" : true ,
"flag" : "string" ,
"hidden" : true ,
"name" : "string" ,
"secret" : true ,
"shorthand" : "string" ,
"usage" : "string" ,
"value" : "string"
},
"stackdriver" : {
"default" : "string" ,
"enterprise" : true ,
"flag" : "string" ,
"hidden" : true ,
"name" : "string" ,
"secret" : true ,
"shorthand" : "string" ,
"usage" : "string" ,
"value" : "string"
}
}
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" : {
"default" : true ,
"enterprise" : true ,
"flag" : "string" ,
"hidden" : true ,
"name" : "string" ,
"secret" : true ,
"shorthand" : "string" ,
"usage" : "string" ,
"value" : true
},
"allow_signups" : {
"default" : true ,
"enterprise" : true ,
"flag" : "string" ,
"hidden" : true ,
"name" : "string" ,
"secret" : true ,
"shorthand" : "string" ,
"usage" : "string" ,
"value" : true
},
"allowed_orgs" : {
"default" : ["string" ],
"enterprise" : true ,
"flag" : "string" ,
"hidden" : true ,
"name" : "string" ,
"secret" : true ,
"shorthand" : "string" ,
"usage" : "string" ,
"value" : ["string" ]
},
"allowed_teams" : {
"default" : ["string" ],
"enterprise" : true ,
"flag" : "string" ,
"hidden" : true ,
"name" : "string" ,
"secret" : true ,
"shorthand" : "string" ,
"usage" : "string" ,
"value" : ["string" ]
},
"client_id" : {
"default" : "string" ,
"enterprise" : true ,
"flag" : "string" ,
"hidden" : true ,
"name" : "string" ,
"secret" : true ,
"shorthand" : "string" ,
"usage" : "string" ,
"value" : "string"
},
"client_secret" : {
"default" : "string" ,
"enterprise" : true ,
"flag" : "string" ,
"hidden" : true ,
"name" : "string" ,
"secret" : true ,
"shorthand" : "string" ,
"usage" : "string" ,
"value" : "string"
},
"enterprise_base_url" : {
"default" : "string" ,
"enterprise" : true ,
"flag" : "string" ,
"hidden" : true ,
"name" : "string" ,
"secret" : true ,
"shorthand" : "string" ,
"usage" : "string" ,
"value" : "string"
}
}
}
{
"allow_everyone" : {
"default" : true ,
"enterprise" : true ,
"flag" : "string" ,
"hidden" : true ,
"name" : "string" ,
"secret" : true ,
"shorthand" : "string" ,
"usage" : "string" ,
"value" : true
},
"allow_signups" : {
"default" : true ,
"enterprise" : true ,
"flag" : "string" ,
"hidden" : true ,
"name" : "string" ,
"secret" : true ,
"shorthand" : "string" ,
"usage" : "string" ,
"value" : true
},
"allowed_orgs" : {
"default" : ["string" ],
"enterprise" : true ,
"flag" : "string" ,
"hidden" : true ,
"name" : "string" ,
"secret" : true ,
"shorthand" : "string" ,
"usage" : "string" ,
"value" : ["string" ]
},
"allowed_teams" : {
"default" : ["string" ],
"enterprise" : true ,
"flag" : "string" ,
"hidden" : true ,
"name" : "string" ,
"secret" : true ,
"shorthand" : "string" ,
"usage" : "string" ,
"value" : ["string" ]
},
"client_id" : {
"default" : "string" ,
"enterprise" : true ,
"flag" : "string" ,
"hidden" : true ,
"name" : "string" ,
"secret" : true ,
"shorthand" : "string" ,
"usage" : "string" ,
"value" : "string"
},
"client_secret" : {
"default" : "string" ,
"enterprise" : true ,
"flag" : "string" ,
"hidden" : true ,
"name" : "string" ,
"secret" : true ,
"shorthand" : "string" ,
"usage" : "string" ,
"value" : "string"
},
"enterprise_base_url" : {
"default" : "string" ,
"enterprise" : true ,
"flag" : "string" ,
"hidden" : true ,
"name" : "string" ,
"secret" : true ,
"shorthand" : "string" ,
"usage" : "string" ,
"value" : "string"
}
}
{
"allow_signups" : {
"default" : true ,
"enterprise" : true ,
"flag" : "string" ,
"hidden" : true ,
"name" : "string" ,
"secret" : true ,
"shorthand" : "string" ,
"usage" : "string" ,
"value" : true
},
"client_id" : {
"default" : "string" ,
"enterprise" : true ,
"flag" : "string" ,
"hidden" : true ,
"name" : "string" ,
"secret" : true ,
"shorthand" : "string" ,
"usage" : "string" ,
"value" : "string"
},
"client_secret" : {
"default" : "string" ,
"enterprise" : true ,
"flag" : "string" ,
"hidden" : true ,
"name" : "string" ,
"secret" : true ,
"shorthand" : "string" ,
"usage" : "string" ,
"value" : "string"
},
"email_domain" : {
"default" : ["string" ],
"enterprise" : true ,
"flag" : "string" ,
"hidden" : true ,
"name" : "string" ,
"secret" : true ,
"shorthand" : "string" ,
"usage" : "string" ,
"value" : ["string" ]
},
"ignore_email_verified" : {
"default" : true ,
"enterprise" : true ,
"flag" : "string" ,
"hidden" : true ,
"name" : "string" ,
"secret" : true ,
"shorthand" : "string" ,
"usage" : "string" ,
"value" : true
},
"issuer_url" : {
"default" : "string" ,
"enterprise" : true ,
"flag" : "string" ,
"hidden" : true ,
"name" : "string" ,
"secret" : true ,
"shorthand" : "string" ,
"usage" : "string" ,
"value" : "string"
},
"scopes" : {
"default" : ["string" ],
"enterprise" : true ,
"flag" : "string" ,
"hidden" : true ,
"name" : "string" ,
"secret" : true ,
"shorthand" : "string" ,
"usage" : "string" ,
"value" : ["string" ]
},
"username_field" : {
"default" : "string" ,
"enterprise" : true ,
"flag" : "string" ,
"hidden" : true ,
"name" : "string" ,
"secret" : true ,
"shorthand" : "string" ,
"usage" : "string" ,
"value" : "string"
}
}
{
"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
{
"created_at" : "2019-08-24T14:15:22Z" ,
"destination_scheme" : "none" ,
"id" : "497f6eca-6276-4993-bfeb-53cbbbba6f08" ,
"name" : "string" ,
"scope" : "template" ,
"scope_id" : "5d3fe357-12dd-4f62-b004-6d1fb3b8454f" ,
"source_scheme" : "none" ,
"updated_at" : "2019-08-24T14:15:22Z"
}
Parameter represents a set value for the scope.
Property Value destination_schemenonedestination_schemeenvironment_variabledestination_schemeprovisioner_variablescopetemplatescopeworkspacescopeimport_jobsource_schemenonesource_schemedata
Value noneenvironment_variableprovisioner_variable
{
"allow_override_destination" : true ,
"allow_override_source" : true ,
"created_at" : "2019-08-24T14:15:22Z" ,
"default_destination_scheme" : "none" ,
"default_refresh" : "string" ,
"default_source_scheme" : "none" ,
"default_source_value" : "string" ,
"description" : "string" ,
"id" : "497f6eca-6276-4993-bfeb-53cbbbba6f08" ,
"job_id" : "453bd7d7-5355-4d6d-a38e-d9e7eb218c3f" ,
"name" : "string" ,
"redisplay_value" : true ,
"validation_condition" : "string" ,
"validation_contains" : ["string" ],
"validation_error" : "string" ,
"validation_type_system" : "string" ,
"validation_value_type" : "string"
}
Name Type Required Restrictions Description allow_override_destinationboolean false allow_override_sourceboolean false created_atstring false default_destination_schemecodersdk.ParameterDestinationScheme false default_refreshstring false default_source_schemecodersdk.ParameterSourceScheme false default_source_valuestring false descriptionstring false idstring false job_idstring false namestring false redisplay_valueboolean false validation_conditionstring false validation_containsarray of string false This is a special array of items provided if the validation condition explicitly states the value must be one of a set. validation_errorstring false validation_type_systemstring false validation_value_typestring false
Property Value default_destination_schemenonedefault_destination_schemeenvironment_variabledefault_destination_schemeprovisioner_variabledefault_source_schemenonedefault_source_schemedata
Value templateworkspaceimport_job
{
"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
{
"address" : {
"default" : "string" ,
"enterprise" : true ,
"flag" : "string" ,
"hidden" : true ,
"name" : "string" ,
"secret" : true ,
"shorthand" : "string" ,
"usage" : "string" ,
"value" : "string"
},
"enable" : {
"default" : true ,
"enterprise" : true ,
"flag" : "string" ,
"hidden" : true ,
"name" : "string" ,
"secret" : true ,
"shorthand" : "string" ,
"usage" : "string" ,
"value" : true
}
}
{
"address" : {
"default" : "string" ,
"enterprise" : true ,
"flag" : "string" ,
"hidden" : true ,
"name" : "string" ,
"secret" : true ,
"shorthand" : "string" ,
"usage" : "string" ,
"value" : "string"
},
"enable" : {
"default" : true ,
"enterprise" : true ,
"flag" : "string" ,
"hidden" : true ,
"name" : "string" ,
"secret" : true ,
"shorthand" : "string" ,
"usage" : "string" ,
"value" : true
}
}
{
"daemon_poll_interval" : {
"default" : 0 ,
"enterprise" : true ,
"flag" : "string" ,
"hidden" : true ,
"name" : "string" ,
"secret" : true ,
"shorthand" : "string" ,
"usage" : "string" ,
"value" : 0
},
"daemon_poll_jitter" : {
"default" : 0 ,
"enterprise" : true ,
"flag" : "string" ,
"hidden" : true ,
"name" : "string" ,
"secret" : true ,
"shorthand" : "string" ,
"usage" : "string" ,
"value" : 0
},
"daemons" : {
"default" : 0 ,
"enterprise" : true ,
"flag" : "string" ,
"hidden" : true ,
"name" : "string" ,
"secret" : true ,
"shorthand" : "string" ,
"usage" : "string" ,
"value" : 0
},
"force_cancel_interval" : {
"default" : 0 ,
"enterprise" : true ,
"flag" : "string" ,
"hidden" : true ,
"name" : "string" ,
"secret" : true ,
"shorthand" : "string" ,
"usage" : "string" ,
"value" : 0
}
}
{
"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" ,
"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 file_idstring false idstring false started_atstring false statuscodersdk.ProvisionerJobStatus false tagsobject false ยป [any property] string false worker_idstring false
Property Value statuspendingstatusrunningstatussucceededstatuscancelingstatuscanceledstatusfailed
{
"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
{
"deadline" : "2019-08-24T14:15:22Z"
}
Name Type Required Restrictions Description deadlinestring true
{
"api" : {
"default" : 0 ,
"enterprise" : true ,
"flag" : "string" ,
"hidden" : true ,
"name" : "string" ,
"secret" : true ,
"shorthand" : "string" ,
"usage" : "string" ,
"value" : 0
},
"disable_all" : {
"default" : true ,
"enterprise" : true ,
"flag" : "string" ,
"hidden" : true ,
"name" : "string" ,
"secret" : true ,
"shorthand" : "string" ,
"usage" : "string" ,
"value" : true
}
}
{
"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 organizationtemplatetemplate_versionuserworkspaceworkspace_buildgit_ssh_keyapi_keygroup
{
"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
{
"background_color" : "string" ,
"enabled" : true ,
"message" : "string"
}
Name Type Required Restrictions Description background_colorstring false enabledboolean false messagestring false
{
"enable" : {
"default" : true ,
"enterprise" : true ,
"flag" : "string" ,
"hidden" : true ,
"name" : "string" ,
"secret" : true ,
"shorthand" : "string" ,
"usage" : "string" ,
"value" : true
}
}
{
"address" : {
"default" : "string" ,
"enterprise" : true ,
"flag" : "string" ,
"hidden" : true ,
"name" : "string" ,
"secret" : true ,
"shorthand" : "string" ,
"usage" : "string" ,
"value" : "string"
},
"cert_file" : {
"default" : ["string" ],
"enterprise" : true ,
"flag" : "string" ,
"hidden" : true ,
"name" : "string" ,
"secret" : true ,
"shorthand" : "string" ,
"usage" : "string" ,
"value" : ["string" ]
},
"client_auth" : {
"default" : "string" ,
"enterprise" : true ,
"flag" : "string" ,
"hidden" : true ,
"name" : "string" ,
"secret" : true ,
"shorthand" : "string" ,
"usage" : "string" ,
"value" : "string"
},
"client_ca_file" : {
"default" : "string" ,
"enterprise" : true ,
"flag" : "string" ,
"hidden" : true ,
"name" : "string" ,
"secret" : true ,
"shorthand" : "string" ,
"usage" : "string" ,
"value" : "string"
},
"client_cert_file" : {
"default" : "string" ,
"enterprise" : true ,
"flag" : "string" ,
"hidden" : true ,
"name" : "string" ,
"secret" : true ,
"shorthand" : "string" ,
"usage" : "string" ,
"value" : "string"
},
"client_key_file" : {
"default" : "string" ,
"enterprise" : true ,
"flag" : "string" ,
"hidden" : true ,
"name" : "string" ,
"secret" : true ,
"shorthand" : "string" ,
"usage" : "string" ,
"value" : "string"
},
"enable" : {
"default" : true ,
"enterprise" : true ,
"flag" : "string" ,
"hidden" : true ,
"name" : "string" ,
"secret" : true ,
"shorthand" : "string" ,
"usage" : "string" ,
"value" : true
},
"key_file" : {
"default" : ["string" ],
"enterprise" : true ,
"flag" : "string" ,
"hidden" : true ,
"name" : "string" ,
"secret" : true ,
"shorthand" : "string" ,
"usage" : "string" ,
"value" : ["string" ]
},
"min_version" : {
"default" : "string" ,
"enterprise" : true ,
"flag" : "string" ,
"hidden" : true ,
"name" : "string" ,
"secret" : true ,
"shorthand" : "string" ,
"usage" : "string" ,
"value" : "string"
},
"redirect_http" : {
"default" : true ,
"enterprise" : true ,
"flag" : "string" ,
"hidden" : true ,
"name" : "string" ,
"secret" : true ,
"shorthand" : "string" ,
"usage" : "string" ,
"value" : true
}
}
{
"enable" : {
"default" : true ,
"enterprise" : true ,
"flag" : "string" ,
"hidden" : true ,
"name" : "string" ,
"secret" : true ,
"shorthand" : "string" ,
"usage" : "string" ,
"value" : true
},
"trace" : {
"default" : true ,
"enterprise" : true ,
"flag" : "string" ,
"hidden" : true ,
"name" : "string" ,
"secret" : true ,
"shorthand" : "string" ,
"usage" : "string" ,
"value" : true
},
"url" : {
"default" : "string" ,
"enterprise" : true ,
"flag" : "string" ,
"hidden" : true ,
"name" : "string" ,
"secret" : true ,
"shorthand" : "string" ,
"usage" : "string" ,
"value" : "string"
}
}
{
"active_user_count" : 0 ,
"active_version_id" : "eae64611-bd53-4a80-bb77-df1e432c0fbc" ,
"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" ,
"icon" : "string" ,
"id" : "497f6eca-6276-4993-bfeb-53cbbbba6f08" ,
"name" : "string" ,
"organization_id" : "7c60d51f-b44e-4682-87d6-449835ea4de6" ,
"provisioner" : "terraform" ,
"updated_at" : "2019-08-24T14:15:22Z" ,
"workspace_owner_count" : 0
}
Name Type Required Restrictions Description active_user_countinteger false Active user count is set to -1 when loading. active_version_idstring 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 iconstring false idstring false namestring false organization_idstring false provisionerstring false updated_atstring false workspace_owner_countinteger false
Property Value provisionerterraform
{
"property1" : {
"p50" : 123 ,
"p95" : 146
},
"property2" : {
"p50" : 123 ,
"p95" : 146
}
}
{
"entries" : [
{
"amount" : 0 ,
"date" : "2019-08-24T14:15:22Z"
}
]
}
{
"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" ,
"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"
}
Name Type Required Restrictions Description created_atstring false created_bycodersdk.User false idstring false jobcodersdk.ProvisionerJob false namestring false organization_idstring false readmestring false template_idstring false updated_atstring false
{
"capture_logs" : {
"default" : true ,
"enterprise" : true ,
"flag" : "string" ,
"hidden" : true ,
"name" : "string" ,
"secret" : true ,
"shorthand" : "string" ,
"usage" : "string" ,
"value" : true
},
"enable" : {
"default" : true ,
"enterprise" : true ,
"flag" : "string" ,
"hidden" : true ,
"name" : "string" ,
"secret" : true ,
"shorthand" : "string" ,
"usage" : "string" ,
"value" : true
},
"honeycomb_api_key" : {
"default" : "string" ,
"enterprise" : true ,
"flag" : "string" ,
"hidden" : true ,
"name" : "string" ,
"secret" : true ,
"shorthand" : "string" ,
"usage" : "string" ,
"value" : "string"
}
}
{
"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
{
"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
{
"autostart_schedule" : "string" ,
"created_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" ,
"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"
},
"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"
},
"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
}
},
"name" : "string" ,
"operating_system" : "string" ,
"resource_id" : "4d5215ed-38bb-48ed-879a-fdb9ca58522f" ,
"startup_script" : "string" ,
"status" : "connecting" ,
"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" ,
"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 idstring false last_used_atstring false latest_buildcodersdk.WorkspaceBuild false namestring 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"
},
"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
}
},
"name" : "string" ,
"operating_system" : "string" ,
"resource_id" : "4d5215ed-38bb-48ed-879a-fdb9ca58522f" ,
"startup_script" : "string" ,
"status" : "connecting" ,
"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 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 namestring false operating_systemstring false resource_idstring false startup_scriptstring false statuscodersdk.WorkspaceAgentStatus false troubleshooting_urlstring false updated_atstring false versionstring false
Property Value statusconnectingstatusconnectedstatusdisconnectedstatustimeout
{
"session_token" : "string"
}
Name Type Required Restrictions Description session_tokenstring 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"
}
}
}
}
{
"password" : "string" ,
"url" : "string" ,
"username" : "string"
}
Name Type Required Restrictions Description passwordstring false urlstring false usernamestring 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"
}
],
"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 ,
"motd_file" : "string" ,
"startup_script" : "string" ,
"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. motd_filestring false startup_scriptstring false vscode_port_proxy_uristring 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" ,
"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"
},
"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"
},
"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
}
},
"name" : "string" ,
"operating_system" : "string" ,
"resource_id" : "4d5215ed-38bb-48ed-879a-fdb9ca58522f" ,
"startup_script" : "string" ,
"status" : "connecting" ,
"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
{
"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"
},
"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
}
},
"name" : "string" ,
"operating_system" : "string" ,
"resource_id" : "4d5215ed-38bb-48ed-879a-fdb9ca58522f" ,
"startup_script" : "string" ,
"status" : "connecting" ,
"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"
}
Property Value workspace_transitionstartworkspace_transitionstopworkspace_transitiondelete
{
"key" : "string" ,
"sensitive" : true ,
"value" : "string"
}
Name Type Required Restrictions Description keystring false sensitiveboolean false valuestring false
Value pendingstartingrunningstoppingstoppedfailedcancelingcanceleddeletingdeleted
{
"count" : 0 ,
"workspaces" : [
{
"autostart_schedule" : "string" ,
"created_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" ,
"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"
},
"reason" : "initiator" ,
"resources" : [
{
"agents" : [
{
"apps" : [
{
"command" : "string" ,
"display_name" : "string" ,
"external" : true ,
"health" : "disabled" ,
"healthcheck" : {},
"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"
},
"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
}
},
"name" : "string" ,
"operating_system" : "string" ,
"resource_id" : "4d5215ed-38bb-48ed-879a-fdb9ca58522f" ,
"startup_script" : "string" ,
"status" : "connecting" ,
"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" ,
"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 countinteger false workspacesarray of codersdk.Workspace false
Value noneenvironment_variableprovisioner_variable
Value templateimport_jobworkspace
{
"created_at" : "string" ,
"default_source_value" : true ,
"destination_scheme" : "none" ,
"id" : "string" ,
"name" : "string" ,
"schema_id" : "string" ,
"scope" : "template" ,
"scope_id" : "string" ,
"source_scheme" : "none" ,
"source_value" : "string" ,
"updated_at" : "string"
}
{
"time" : "string" ,
"valid" : true
}
Name Type Required Restrictions Description timestring false validboolean false Valid is true if Time is not NULL
{
"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"
}
}
}
Name Type Required Restrictions Description omitDefaultRegionsboolean false Omitdefaultregions specifies to not use Tailscale's DERP servers, and only use those specified in this DERPMap. If there are none set outside of the defaults, this is a noop. regionsobject false Regions is the set of geographic regions running DERP node(s).
It's keyed by the DERPRegion.RegionID.
The numbers are not necessarily contiguous.|
|ยป [any property]|tailcfg.DERPRegion |false|||
{
"certName" : "string" ,
"derpport" : 0 ,
"forceHTTP" : true ,
"hostName" : "string" ,
"insecureForTests" : true ,
"ipv4" : "string" ,
"ipv6" : "string" ,
"name" : "string" ,
"regionID" : 0 ,
"stunonly" : true ,
"stunport" : 0 ,
"stuntestIP" : "string"
}
Name Type Required Restrictions Description certNamestring false Certname optionally specifies the expected TLS cert common name. If empty, HostName is used. If CertName is non-empty, HostName is only used for the TCP dial (if IPv4/IPv6 are not present) + TLS ClientHello. derpportinteger false Derpport optionally provides an alternate TLS port number for the DERP HTTPS server. If zero, 443 is used. forceHTTPboolean false Forcehttp is used by unit tests to force HTTP. It should not be set by users. hostNamestring false Hostname is the DERP node's hostname. It is required but need not be unique; multiple nodes may have the same HostName but vary in configuration otherwise. insecureForTestsboolean false Insecurefortests is used by unit tests to disable TLS verification. It should not be set by users. ipv4string false Ipv4 optionally forces an IPv4 address to use, instead of using DNS. If empty, A record(s) from DNS lookups of HostName are used. If the string is not an IPv4 address, IPv4 is not used; the conventional string to disable IPv4 (and not use DNS) is "none". ipv6string false Ipv6 optionally forces an IPv6 address to use, instead of using DNS. If empty, AAAA record(s) from DNS lookups of HostName are used. If the string is not an IPv6 address, IPv6 is not used; the conventional string to disable IPv6 (and not use DNS) is "none". namestring false Name is a unique node name (across all regions). It is not a host name. It's typically of the form "1b", "2a", "3b", etc. (region ID + suffix within that region) regionIDinteger false Regionid is the RegionID of the DERPRegion that this node is running in. stunonlyboolean false Stunonly marks a node as only a STUN server and not a DERP server. stunportinteger false Port optionally specifies a STUN port to use. Zero means 3478. To disable STUN on this node, use -1. stuntestIPstring false Stuntestip is used in tests to override the STUN server's IP. If empty, it's assumed to be the same as the DERP server.
{
"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"
}
Name Type Required Restrictions Description avoidboolean false Avoid is whether the client should avoid picking this as its home region. The region should only be used if a peer is there. Clients already using this region as their home should migrate away to a new region without Avoid set. embeddedRelayboolean false Embeddedrelay is true when the region is bundled with the Coder control plane. nodesarray of tailcfg.DERPNode false Nodes are the DERP nodes running in this region, in priority order for the current client. Client TLS connections should ideally only go to the first entry (falling back to the second if necessary). STUN packets should go to the first 1 or 2. If nodes within a region route packets amongst themselves, but not to other regions. That said, each user/domain should get a the same preferred node order, so if all nodes for a user/network pick the first one (as they should, when things are healthy), the inter-cluster routing is minimal to zero. regionCodestring false Regioncode is a short name for the region. It's usually a popular city or airport code in the region: "nyc", "sf", "sin", "fra", etc. regionIDinteger false Regionid is a unique integer for a geographic region.
It corresponds to the legacy derpN.tailscale.com hostnames used by older clients. (Older clients will continue to resolve derpN.tailscale.com when contacting peers, rather than use the server-provided DERPMap)
RegionIDs must be non-zero, positive, and guaranteed to fit in a JavaScript number.
RegionIDs in range 900-999 are reserved for end users to run their own DERP nodes.|
|regionName|string|false||Regionname is a long English name for the region: "New York City", "San Francisco", "Singapore", "Frankfurt", etc.|