POST
/
organizations
/
{organization}
/
templates
curl --request POST \
  --url https://cloud.local.wirtual.dev/api/v2/organizations/{organization}/templates \
  --header 'Content-Type: application/json' \
  --header 'Wirtual-Session-Token: <api-key>' \
  --data '{
  "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
  },
  "default_ttl_ms": 123,
  "delete_ttl_ms": 123,
  "description": "<string>",
  "disable_everyone_group_access": true,
  "display_name": "<string>",
  "dormant_ttl_ms": 123,
  "failure_ttl_ms": 123,
  "icon": "<string>",
  "max_port_share_level": "<any>",
  "name": "<string>",
  "require_active_version": true,
  "template_version_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}'
{
  "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

Body

application/json
Request body
​
name
string
required

Name is the name of the template.

​
template_version_id
string
required

VersionID 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.

​
activity_bump_ms
integer

ActivityBumpMillis allows optionally specifying the activity bump duration for all workspaces created from this template. Defaults to 1h but can be set to 0 to disable activity bumping.

​
allow_user_autostart
boolean

AllowUserAutostart allows users to set a schedule for autostarting their workspace. By default this is true. This can only be disabled when using an enterprise license.

​
allow_user_autostop
boolean

AllowUserAutostop allows users to set a custom workspace TTL to use in place of the template's DefaultTTL field. By default this is true. If false, the DefaultTTL will always be used. This can only be disabled when using an enterprise license.

​
allow_user_cancel_workspace_jobs
boolean

Allow users to cancel in-progress workspace jobs. *bool as the default value is "true".

​
autostart_requirement
object

AutostartRequirement allows optionally specifying the autostart allowed days for workspaces created from this template. This is an enterprise feature.

​
autostop_requirement
object

AutostopRequirement allows optionally specifying the autostop requirement for workspaces created from this template. This is an enterprise feature.

​
default_ttl_ms
integer

DefaultTTLMillis allows optionally specifying the default TTL for all workspaces created from this template.

​
delete_ttl_ms
integer

TimeTilDormantAutoDeleteMillis allows optionally specifying the max lifetime before Wirtual permanently deletes dormant workspaces created from this template.

​
description
string

Description is a description of what the template contains. It must be less than 128 bytes.

​
disable_everyone_group_access
boolean

DisableEveryoneGroupAccess allows optionally disabling the default behavior of granting the 'everyone' group access to use the template. If this is set to true, the template will not be available to all users, and must be explicitly granted to users or groups in the permissions settings of the template.

​
display_name
string

DisplayName is the displayed name of the template.

​
dormant_ttl_ms
integer

TimeTilDormantMillis allows optionally specifying the max lifetime before Wirtual locks inactive workspaces created from this template.

​
failure_ttl_ms
integer

FailureTTLMillis allows optionally specifying the max lifetime before Wirtual stops all resources for failed workspaces created from this template.

​
icon
string

Icon is a relative path or external URL that specifies an icon to be displayed in the dashboard.

​
max_port_share_level
any
​
require_active_version
boolean

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

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