v54

latestSwagger 2.0AGPL-3.0raw.githubusercontent.com2026-08-03397565628.8 KB

Templates

Get templates by organization and template name

get/api/v2/organizations/{organization}/templates/{templatename}

Path parameters

organizationstring uuid required

Organization ID

templatenamestring required

Template name

Response

active_user_countinteger

ActiveUserCount is set to -1 when loading.

active_version_idstring uuid

activity_bump_msinteger

allow_user_autostartboolean

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

allow_user_autostopboolean

allow_user_cancel_workspace_jobsboolean

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.

display_namestring

failure_ttl_msinteger

FailureTTLMillis, TimeTilDormantMillis, and TimeTilDormantAutoDeleteMillis are enterprise-only. 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'

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