Templates
Get template version by ID
API Documentation
General
Enterprise
- GETGet appearance
- PUTUpdate appearance
- POSTIssue signed app token for reconnecting PTY
- GETGet entitlements
- GETGet groups
- GETGet group by ID
- DELDelete group by name
- PATCHUpdate group by name
- GETGet JFrog XRay scan by workspace agent ID.
- POSTPost JFrog XRay scan by workspace agent ID.
- GETGet licenses
- DELDelete license
- PUTUpdate notification template dispatch method
- GETGet OAuth2 applications.
- POSTCreate OAuth2 application.
- GETGet OAuth2 application.
- PUTUpdate OAuth2 application.
- DELDelete OAuth2 application.
- GETGet OAuth2 application secrets.
- POSTCreate OAuth2 application secret.
- DELDelete OAuth2 application secret.
- POSTOAuth2 authorization request.
- POSTOAuth2 token exchange.
- DELDelete OAuth2 application tokens.
- GETGet groups by organization
- POSTCreate group for organization
- GETGet group by organization and group name
- GETGet workspace quota by user
- GETGet provisioner daemons
- GETServe provisioner daemon
- GETList provisioner key
- POSTCreate provisioner key
- GETList provisioner key daemons
- DELDelete provisioner key
- GETGet the available organization idp sync claim fields
- GETGet group IdP Sync settings by organization
- PATCHUpdate group IdP Sync settings by organization
- GETGet role IdP Sync settings by organization
- PATCHUpdate role IdP Sync settings by organization
- GETGet active replicas
- GETSCIM 2.0: Service Provider Config
- GETSCIM 2.0: Get users
- POSTSCIM 2.0: Create new user
- GETSCIM 2.0: Get user by ID
- PATCHSCIM 2.0: Update user account
- GETGet organization IdP Sync settings
- PATCHUpdate organization IdP Sync settings
- GETGet template ACLs
- PATCHUpdate template ACL
- GETGet template available acl users/groups
- GETGet user quiet hours schedule
- PUTUpdate user quiet hours schedule
- GETGet workspace quota by user deprecated
- GETGet workspace proxies
- POSTCreate workspace proxy
- POSTReport workspace app stats
- GETWorkspace Proxy Coordinate
- GETGet workspace proxy crypto keys
- POSTDeregister workspace proxy
- POSTIssue signed workspace app token
- POSTRegister workspace proxy
- GETGet workspace proxy
- DELDelete workspace proxy
- PATCHUpdate workspace proxy
Authorization
Debug
Agents
- GETDebug OIDC context for a user
- GETGet DERP map updates
- GETUser-scoped tailnet RPC connection
- POSTAuthenticate agent on AWS instance
- POSTAuthenticate agent on Azure instance
- GETGet connection info for workspace agent generic
- POSTAuthenticate agent on Google Cloud instance
- GETGet workspace agent external auth
- GETRemoved: Get workspace agent git auth
- GETGet workspace agent Git SSH key
- POSTPost workspace agent log source
- PATCHPatch workspace agent logs
- GETWorkspace agent RPC API
- GETGet workspace agent by ID
- GETGet connection info for workspace agent
- GETCoordinate workspace agent
- GETGet listening ports for workspace agent
- GETGet logs by workspace agent
- GETOpen PTY to workspace agent
- GETRemoved: Get logs by workspace agent
- GETWatch for workspace agent metadata updates
Git
Insights
Organizations
Notifications
Members
Workspaces
- POSTCreate user workspace by organization
- GETGet workspace metadata by user and workspace name
- POSTCreate user workspace
- GETList workspaces
- GETGet workspace metadata by ID
- PATCHUpdate workspace metadata by ID
- PUTUpdate workspace autostart schedule by ID
- PUTUpdate workspace automatic updates by ID
- PUTUpdate workspace dormancy status by id.
- PUTExtend workspace deadline by ID
- PUTFavorite workspace by ID.
- DELUnfavorite workspace by ID.
- GETResolve workspace autostart by id.
- GETGet workspace timings by ID
- PUTUpdate workspace TTL by ID
- POSTPost Workspace Usage by ID
- GETWatch workspace by ID
Templates
- GETGet templates by organization
- POSTCreate template by organization
- GETGet template examples by organization
- GETGet templates by organization and template name
- GETGet template version by organization, template, and name
- GETGet previous template version by organization, template, and name
- POSTCreate template version by organization
- GETGet all templates
- GETGet template examples
- GETGet template metadata by ID
- DELDelete template by ID
- PATCHUpdate template metadata by ID
- GETGet template DAUs by ID
- GETList template versions by template ID
- PATCHUpdate active template version by template ID
- POSTArchive template unused versions by template id
- GETGet template version by template ID and name
- GETGet template version by ID
- PATCHPatch template version by ID
- POSTArchive template version
- PATCHCancel template version by ID
- POSTCreate template version dry-run
- GETGet template version dry-run by job ID
- PATCHCancel template version dry-run by job ID
- GETGet template version dry-run logs by job ID
- GETGet template version dry-run resources by job ID
- GETGet external auth by template version
- GETGet logs by template version
- GETRemoved: Get parameters by template version
- GETGet resources by template version
- GETGet rich parameters by template version
- GETRemoved: Get schema by template version
- POSTUnarchive template version
- GETGet template variables by template version
WorkspaceProxies
Users
- GETGet users
- POSTCreate new user
- GETGet authentication methods
- GETCheck initial user created
- POSTCreate initial user
- POSTLog out user
- GETOAuth 2.0 GitHub Callback
- GETOpenID Connect Callback
- GETGet user by name
- DELDelete user
- PUTUpdate user appearance settings
- GETGet autofill build parameters for user
- GETGet user Git SSH key
- PUTRegenerate user SSH key
- POSTCreate new session key
- GETGet user tokens
- POSTCreate token API key
- GETGet API key by token name
- GETGet API key by ID
- DELDelete API key
- GETGet user login type
- GETGet organizations by user
- GETGet organization by user and organization name
- PUTUpdate user password
- PUTUpdate user profile
- GETGet user roles
- PUTAssign role to user
- PUTActivate user account
- PUTSuspend user account
Builds
- GETGet workspace build by user, workspace name, and build number
- GETGet workspace build
- PATCHCancel workspace build
- GETGet workspace build logs
- GETGet build parameters for workspace build
- GETRemoved: Get workspace resources for workspace build
- GETGet provisioner state for workspace build
- GETGet workspace build timings by ID
- GETGet workspace builds by workspace ID
- POSTCreate workspace build
Templates
Get template version by ID
GET
/
templateversions
/
{templateversion}
curl --request GET \
--url https://cloud.local.wirtual.dev/api/v2/templateversions/{templateversion} \
--header 'Wirtual-Session-Token: <api-key>'{
"archived": true,
"created_at": "2023-11-07T05:31:56Z",
"created_by": {
"avatar_url": "<string>",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"username": "<string>"
},
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"job": {
"canceled_at": "2023-11-07T05:31:56Z",
"completed_at": "2023-11-07T05:31:56Z",
"created_at": "2023-11-07T05:31:56Z",
"error": "<string>",
"error_code": "<any>",
"file_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"queue_position": 123,
"queue_size": 123,
"started_at": "2023-11-07T05:31:56Z",
"status": "<any>",
"tags": {},
"worker_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"matched_provisioners": {
"available": 123,
"count": 123,
"most_recently_seen": "2023-11-07T05:31:56Z"
},
"message": "<string>",
"name": "<string>",
"organization_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"readme": "<string>",
"template_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"updated_at": "2023-11-07T05:31:56Z",
"warnings": [
"UNSUPPORTED_WORKSPACES"
]
}Authorizations
Path Parameters
Template version ID
Response
200 - application/json
OK
Available is the number of provisioner daemons that are available to take jobs. This may be less than the count if some provisioners are busy or have been stopped.
Count is the number of provisioner daemons that matched the given tags. If the count is 0, it means no provisioner daemons matched the requested tags.
MostRecentlySeen is the most recently seen time of the set of matched provisioners. If no provisioners matched, this field will be null.
Available options:
UNSUPPORTED_WORKSPACES curl --request GET \
--url https://cloud.local.wirtual.dev/api/v2/templateversions/{templateversion} \
--header 'Wirtual-Session-Token: <api-key>'{
"archived": true,
"created_at": "2023-11-07T05:31:56Z",
"created_by": {
"avatar_url": "<string>",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"username": "<string>"
},
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"job": {
"canceled_at": "2023-11-07T05:31:56Z",
"completed_at": "2023-11-07T05:31:56Z",
"created_at": "2023-11-07T05:31:56Z",
"error": "<string>",
"error_code": "<any>",
"file_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"queue_position": 123,
"queue_size": 123,
"started_at": "2023-11-07T05:31:56Z",
"status": "<any>",
"tags": {},
"worker_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"matched_provisioners": {
"available": 123,
"count": 123,
"most_recently_seen": "2023-11-07T05:31:56Z"
},
"message": "<string>",
"name": "<string>",
"organization_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"readme": "<string>",
"template_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"updated_at": "2023-11-07T05:31:56Z",
"warnings": [
"UNSUPPORTED_WORKSPACES"
]
}