GET
/
organizations
/
{organization}
/
templates
/
{templatename}
curl --request GET \
  --url https://cloud.local.wirtual.dev/api/v2/organizations/{organization}/templates/{templatename} \
  --header 'Wirtual-Session-Token: <api-key>'
{
  "active_user_count": 123,
  "active_version_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "activity_bump_ms": 123,
  "allow_user_autostart": true,
  "allow_user_autostop": true,
  "allow_user_cancel_workspace_jobs": true,
  "autostart_requirement": {
    "days_of_week": [
      "monday"
    ]
  },
  "autostop_requirement": {
    "days_of_week": [
      "monday"
    ],
    "weeks": 123
  },
  "build_time_stats": {},
  "created_at": "2023-11-07T05:31:56Z",
  "created_by_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created_by_name": "<string>",
  "default_ttl_ms": 123,
  "deprecated": true,
  "deprecation_message": "<string>",
  "description": "<string>",
  "display_name": "<string>",
  "failure_ttl_ms": 123,
  "icon": "<string>",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "max_port_share_level": "owner",
  "name": "<string>",
  "organization_display_name": "<string>",
  "organization_icon": "<string>",
  "organization_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "organization_name": "<string>",
  "provisioner": "terraform",
  "require_active_version": true,
  "time_til_dormant_autodelete_ms": 123,
  "time_til_dormant_ms": 123,
  "updated_at": "2023-11-07T05:31:56Z"
}

Authorizations

​
Wirtual-Session-Token
string
header
required

Path Parameters

​
organization
string
required

Organization ID

​
templatename
string
required

Template name

Response

200 - application/json
OK
​
active_user_count
integer

ActiveUserCount is set to -1 when loading.

​
active_version_id
string
​
activity_bump_ms
integer
​
allow_user_autostart
boolean

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_autostop
boolean
​
allow_user_cancel_workspace_jobs
boolean
​
autostart_requirement
object
​
autostop_requirement
object

AutostopRequirement and AutostartRequirement are enterprise features. Its value is only used if your license is entitled to use the advanced template scheduling feature.

​
build_time_stats
object
​
created_at
string
​
created_by_id
string
​
created_by_name
string
​
default_ttl_ms
integer
​
deprecated
boolean
​
deprecation_message
string
​
description
string
​
display_name
string
​
failure_ttl_ms
integer

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

​
icon
string
​
id
string
​
max_port_share_level
enum<string>
Available options:
owner,
authenticated,
public
​
name
string
​
organization_display_name
string
​
organization_icon
string
​
organization_id
string
​
organization_name
string
​
provisioner
enum<string>
Available options:
terraform
​
require_active_version
boolean

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

​
time_til_dormant_autodelete_ms
integer
​
time_til_dormant_ms
integer
​
updated_at
string