COcoder
Templates

Get template settings by ID

Changed on
get/api/v2/templates/{template}

Request

  • Base URL
    / (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /api/v2/templates/{template}
  • Auth
    API key in header Coder-Session-Token

Path parameters

templatestring uuid required

Template ID

Response

OK

active_user_countinteger

ActiveUserCount is set to -1 when loading.

active_version_idstring uuid
activity_bump_msinteger
agents_allowedboolean
allow_user_autostartboolean

AllowUserAutostart and AllowUserAutostop are Premium features. Their values are only used if your license is entitled to use the advanced template scheduling feature.

allow_user_autostopboolean
allow_user_cancel_workspace_jobsboolean
allow_workspace_renamesboolean

AllowWorkspaceRenames permits users to rename workspaces built from this template. Renaming can be destructive for templates whose Terraform references the workspace name.

build_time_statsCodersdkTemplateBuildTimeStats
cors_behavior'simple' | 'passthru'
created_atstring date-time
created_by_idstring uuid
created_by_namestring
default_ttl_msinteger
deletedboolean
deprecatedboolean
deprecation_messagestring
descriptionstring
disable_module_cacheboolean

DisableModuleCache disables the use of cached Terraform modules during provisioning for this template. It is read-only while ModuleCacheDisabledByDeployment is true.

display_namestring
failure_ttl_msinteger

FailureTTLMillis, TimeTilDormantMillis, and TimeTilDormantAutoDeleteMillis are Premium features. Their values are used if your license is entitled to use the advanced template scheduling feature.

iconstring
idstring uuid
max_port_share_level'owner' | 'authenticated' | 'organization' | 'public'
module_cache_disabled_by_deploymentboolean

ModuleCacheDisabledByDeployment reports that the deployment disables the Terraform module cache for every template. Templates cannot opt back in, so the effective state is disabled regardless of DisableModuleCache.

namestring
organization_display_namestring
organization_iconstring
organization_idstring uuid
organization_namestring url
provisioner'terraform'
require_active_versionboolean

RequireActiveVersion mandates that workspaces are built with the active template version.

time_til_autostop_notify_msinteger

TimeTilAutostopNotifyMillis is the duration before the workspace's autostop deadline at which a reminder notification is sent. 0 disables the notification.

time_til_dormant_autodelete_msinteger
time_til_dormant_msinteger
updated_atstring date-time
use_classic_parameter_flowboolean

Changes