coder/docs/reference/api/templates.md at a005e5cd22fad9366368387a2c68f1fd6533a4f8

mirror of https://github.com/coder/coder.git synced 2026-09-21 20:51:01 +08:00

Files

T

Nick Vigilante 0a7bb80a1e feat: make CLI/API doc generators emit front-matter metadata (Phase 2) (#27246 )

## Summary

Phase 2 of the H1 → front-matter migration (`DOCS-483`; parent
`DOCS-477`). Makes the two reference-doc generators emit per-page
metadata as YAML front matter instead of a leading `# H1`, so generated
pages are self-describing and `make gen` stops reverting migrated pages
(Phase 3).

Phase 1 (`DOCS-482`) made the coder.com renderers prefer a front-matter
`title` (manifest fallback).

> [!NOTE]
> Rebased onto `main` and fully regenerated, and updated across two
rounds of Coder Agents Review — see **Review follow-ups** below.

## Changes

- **`scripts/clidocgen/command.tpl` + `gen.go` + `main.go`** — front
matter now carries `title` (from `fullName`) and `description` (from the
command's `Short`), and the leading `# H1` is dropped. The CLI index
page's front matter is taken from the manifest `Command Line` route
(title/description/icon_path).
- **`scripts/apidocgen/postprocess/main.go`** — reads the manifest and,
at write time, injects front matter carrying each section's `title` plus
any curated `description`, `state`, and `icon_path`. The API index
page's front matter is taken from the manifest `REST API` route.
- **`scripts/docgenenv`** (new shared code) — one `YAMLScalar`
front-matter escaper, one `Route`/`Manifest` schema +
`LoadManifest`/`FindRoute`, and one `FrontMatter(Route)` emitter, all
imported by both generators (no duplicated helpers, types, or emitters).
- Regenerated all **166 CLI + 31 API** reference pages.

### Metadata → front matter, and what stays in the manifest

Every *per-page* manifest field is mirrored into the page's front
matter: `title`, `description`, `state`, `icon_path`. The **structural**
fields stay in `manifest.json`:

- `children` — the nav tree (explicitly out of scope).
- `path` — the manifest's pointer to the file; a page carrying its own
path is redundant/error-prone, so it's treated like `children`.

The fields are **duplicated** into front matter and **`manifest.json` is
left unchanged**, so this is a **no-op for rendering today** (coder.com
strips front matter for `llms`, and Algolia + the renderer read only
`title`). Removing the fields from the manifest is the natural
follow-up, gated on the renderer reading them from front matter first.

### Why the API side changes the postprocessor, not the `.dot` templates

The issue text suggested editing
`scripts/apidocgen/markdown-template/*`. I deliberately did **not**,
because the postprocessor derives each page's **filename, section title,
and manifest route** from the leading `# {name}` line
(`extractSectionName`). Emitting front matter from the template would
break that extraction. Instead the widdershins templates still emit `#
{name}`, the postprocessor reads it (and now verifies it), and then
swaps the heading for a front-matter block as each section is written.

## Review follow-ups (Coder Agents Review)

### Round 1 — addressed in `e53d5e03` (all threads resolved)

- **CRF-1 / CRF-4** — de-duplicated the escaper and the
`route`/`manifest` schema + traversal into `scripts/docgenenv` (shared
by both generators).
- **CRF-2** — `YAMLScalar` now quotes YAML-reserved scalars
(`true/false/null/…`, numbers); no current value is affected.
- **CRF-3** — added unit tests: a `YAMLScalar` round-trip, `FindRoute`,
and `prependFrontMatter`.
- **CRF-5** — the CLI and API **index** pages now mirror their manifest
route's title/description/icon_path instead of a hardcoded
`coder`/`API`, fixing a rendered-heading regression (`REST API`/`Command
Line` were being overwritten).
- **CRF-6** — dropped the dead `#login` anchor in
`docs/support/support-bundle.md` (the migrated `login.md` no longer
mints that heading anchor).
- **CRF-7 / CRF-8 / CRF-11** — renamed to `prependFrontMatter`, switched
to `bytes.Cut`, and it now strips the first line only when it is the `#
{name}` heading (`extractSectionName` errors otherwise).
- **CRF-9** — removed the orphan `docs/reference/api/chat.md` (not in
the manifest, not linked; the real page is `chats.md`).
- **CRF-10** — the metadata read and the manifest rewrite now share one
`FindRoute` traversal.
- **CRF-13** — moot under squash-merge; this branch is a single
scopeless commit.
- **CRF-15** — the pre-existing `sort.Slice`/`slices.IsSorted`
comparator is left as-is per the review (out of scope; safe today
because section names are unique).

### Round 2 — addressed in `ee796e7107` (all threads resolved)

- **CRF-16** (P1) — removed three em-dashes from new doc comments (the
only `make lint` failure on the prior head); the emdash gate is green.
- **CRF-17 / CRF-18** — unified front-matter emission into one shared
`docgenenv.FrontMatter(Route)`, used by the API postprocessor directly
and by `command.tpl` via a `frontMatter` template func. This retires the
hand-written template YAML and the
`indexTitle`/`indexDescription`/`indexIconPath` closures, so a new
front-matter field is wired in one place, and it gives the CLI index the
`state` arm it previously lacked. Verified byte-identical: a full CLI +
API regen produces zero page changes.
- **CRF-19** — CLI child sort switched to `slices.SortFunc` +
`cmp.Compare` (typed comparator).
- **CRF-20** — reworded the `prependFrontMatter` comment:
`extractSectionName`'s fail-fast is the load-bearing guard; the prefix
check is a defensive backstop.
- **CRF-21** — added `icon_path`/`state` coverage in `docgenenv`'s
`TestFrontMatter/AllFields` (the branch the index page relies on,
previously at 0%).
- **CRF-22** — `YAMLScalar` no longer emits a trailing-space value as a
bare scalar (YAML strips it on read, so it would not round-trip); added
test coverage.
- **CRF-24** — the shared emitter removed the duplicated `cliIndexRoute`
doc comment; the rationale now lives in one place.
- **CRF-23** (Phase 3, out of scope here) — noted: the API generator
wipes and regenerates `reference/api/` from the manifest, so removing
curated metadata from the manifest in Phase 3 needs another source first
(a generator that preserves existing front matter, or metadata carried
alongside the swagger annotations).
- **Process (Mafu-san)** — the verification set below now leads with
`make lint`, the mandatory CI gate that the earlier list omitted.

## Cross-repo dependency

**Resolved — this PR no longer has a hard merge-ordering gate** (CRF-14
was right; the earlier "must merge after #968" note was stale).

The coder.com surfaces that would otherwise leak raw front matter from
`coder/coder` `main` are already front-matter-aware on merged PRs:

- **coder.com#964** (`DOCS-554`, llms-full.txt corpus + Algolia) —
**merged**.
- **coder.com#974** (`DOCS-574`, the `.md` proxy twin + `llms.txt` index
titles) — **merged**.

coder.com#968 (`DOCS-577`) was re-scoped to only the renderer
route-metadata generalization; it's a no-op on today's corpus and its
own description confirms the "deploy before the generators" constraint
no longer applies (that was driven by the llms corpus, now in #964).
Worth a final confirmation that #964/#974 are **deployed** before merge,
but there's no branch/PR ordering blocker left.

## Verification & evidence

AI was the primary author of this PR (see disclosure below); per the [AI
Contribution
Guidelines](https://coder.com/docs/about/contributing/AI_CONTRIBUTING)
here is manual verification.

- `make lint` (golangci-lint + the emdash gate) passes; `go build` / `go
vet` / `go test` are clean for the generators + `scripts/docgenenv`;
`pnpm check-docs` passes.
- `swagger.json`, `docs.go`, and `manifest.json` are **unchanged** —
metadata is duplicated into front matter; command/section names and
routes did not move.
- The diff is purely additive front matter
(`title`/`description`/`state`/`icon_path`) + the leading H1 removal; no
body reflow. A full CLI + API regen produces **zero** page changes
beyond the two index pages.

<details>
<summary>Terminal evidence</summary>

CLI `description` from the command's `Short` (`YAMLScalar` quotes when
needed, e.g. a `Short` with a colon):

```md
---
title: server
description: Start a Coder server
---
```

API pages inherit curated manifest metadata (only Agents/Chats have any
today):

```md
---
title: Chats
description: "REST endpoints for Coder Agents Chats API (programmatic agent sessions)."
state:
  - early access
---
```

Diff scope + "no body changes" proof (uses an explicit `base..HEAD`
range, so it actually tests the claim):

```
$ git diff --shortstat origin/main
 210 files changed, 1447 insertions(+), 344 deletions(-)
# = 166 CLI + 31 API reference pages + generators + scripts/docgenenv
# swagger.json / docs.go / manifest.json: NOT modified

# Every removed line under docs/reference is a leading "# H1"; nothing else:
$ git diff origin/main..HEAD -- docs/reference/ | grep '^-' | grep -v '^---' | grep -v '^-# '
(empty)

$ pnpm check-docs
Summary: 0 error(s)
```

</details>

Linear: DOCS-483

> This PR was created with AI assistance (Coder Agents).

2026-08-11 15:22:55 +00:00

260 KiB

Generated

Raw Blame History

title

title
Templates

Get templates by organization

Code samples

# Example request using curl
curl -X GET http://coder-server:8080/api/v2/organizations/{organization}/templates \
  -H 'Accept: application/json' \
  -H 'Coder-Session-Token: API_KEY'

GET /api/v2/organizations/{organization}/templates

Returns a list of templates for the specified organization. By default, only non-deprecated templates are returned. To include deprecated templates, specify deprecated:true in the search query.

Parameters

Name	In	Type	Required	Description
`organization`	path	string(uuid)	true	Organization ID

Example responses

[
  {
    "active_user_count": 0,
    "active_version_id": "eae64611-bd53-4a80-bb77-df1e432c0fbc",
    "activity_bump_ms": 0,
    "agents_allowed": true,
    "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": 0
    },
    "build_time_stats": {
      "property1": {
        "p50": 123,
        "p95": 146
      },
      "property2": {
        "p50": 123,
        "p95": 146
      }
    },
    "cors_behavior": "simple",
    "created_at": "2019-08-24T14:15:22Z",
    "created_by_id": "9377d689-01fb-4abf-8450-3368d2c1924f",
    "created_by_name": "string",
    "default_ttl_ms": 0,
    "deleted": true,
    "deprecated": true,
    "deprecation_message": "string",
    "description": "string",
    "disable_module_cache": true,
    "display_name": "string",
    "failure_ttl_ms": 0,
    "icon": "string",
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "max_port_share_level": "owner",
    "name": "string",
    "organization_display_name": "string",
    "organization_icon": "string",
    "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
    "organization_name": "string",
    "provisioner": "terraform",
    "require_active_version": true,
    "time_til_autostop_notify_ms": 0,
    "time_til_dormant_autodelete_ms": 0,
    "time_til_dormant_ms": 0,
    "updated_at": "2019-08-24T14:15:22Z",
    "use_classic_parameter_flow": true
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	array of codersdk.Template

Response Schema

Status Code 200

Name	Type	Required	Description
`[array item]`	array	false
`» active_user_count`	integer	false	Active user count is set to -1 when loading.
`» active_version_id`	string(uuid)	false
`» activity_bump_ms`	integer	false
`» agents_allowed`	boolean	false
`» allow_user_autostart`	boolean	false	Allow user autostart 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	false
`» allow_user_cancel_workspace_jobs`	boolean	false
`» autostart_requirement`	codersdk.TemplateAutostartRequirement	false
`»» days_of_week`	array	false	Days of week is a list of days of the week in which autostart is allowed to happen. If no days are specified, autostart is not allowed.
`» autostop_requirement`	codersdk.TemplateAutostopRequirement	false	Autostop requirement and AutostartRequirement are enterprise features. Its value is only used if your license is entitled to use the advanced template scheduling feature.
`»» days_of_week`	array	false	Days of week is a list of days of the week on which restarts are required. Restarts happen within the user's quiet hours (in their configured timezone). If no days are specified, restarts are not required. Weekdays cannot be specified twice.
Restarts will only happen on weekdays in this list on weeks which line up with Weeks.
`»» weeks`	integer	false	Weeks is the number of weeks between required restarts. Weeks are synced across all workspaces (and Coder deployments) using modulo math on a hardcoded epoch week of January 2nd, 2023 (the first Monday of 2023). Values of 0 or 1 indicate weekly restarts. Values of 2 indicate fortnightly restarts, etc.
`» build_time_stats`	codersdk.TemplateBuildTimeStats	false
`»» [any property]`	codersdk.TransitionStats	false
`»»» p50`	integer	false
`»»» p95`	integer	false
`» cors_behavior`	codersdk.CORSBehavior	false
`» created_at`	string(date-time)	false
`» created_by_id`	string(uuid)	false
`» created_by_name`	string	false
`» default_ttl_ms`	integer	false
`» deleted`	boolean	false
`» deprecated`	boolean	false
`» deprecation_message`	string	false
`» description`	string	false
`» disable_module_cache`	boolean	false	Disable module cache disables the use of cached Terraform modules during provisioning.
`» display_name`	string	false
`» failure_ttl_ms`	integer	false	Failure ttl ms TimeTilDormantMillis, and TimeTilDormantAutoDeleteMillis are enterprise-only. Their values are used if your license is entitled to use the advanced template scheduling feature.
`» icon`	string	false
`» id`	string(uuid)	false
`» max_port_share_level`	codersdk.WorkspaceAgentPortShareLevel	false
`» name`	string	false
`» organization_display_name`	string	false
`» organization_icon`	string	false
`» organization_id`	string(uuid)	false
`» organization_name`	string(url)	false
`» provisioner`	string	false
`» require_active_version`	boolean	false	Require active version mandates that workspaces are built with the active template version.
`» time_til_autostop_notify_ms`	integer	false	Time til autostop notify ms is the duration before the workspace's autostop deadline at which a reminder notification is sent. 0 disables the notification.
`» time_til_dormant_autodelete_ms`	integer	false
`» time_til_dormant_ms`	integer	false
`» updated_at`	string(date-time)	false
`» use_classic_parameter_flow`	boolean	false

Enumerated Values

Property	Value(s)
`cors_behavior`	`passthru`, `simple`
`max_port_share_level`	`authenticated`, `organization`, `owner`, `public`
`provisioner`	`terraform`

To perform this operation, you must be authenticated. Learn more.

Create template by organization

Code samples

# Example request using curl
curl -X POST http://coder-server:8080/api/v2/organizations/{organization}/templates \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Coder-Session-Token: API_KEY'

POST /api/v2/organizations/{organization}/templates

{
  "activity_bump_ms": 0,
  "agents_allowed": true,
  "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": 0
  },
  "cors_behavior": "simple",
  "default_ttl_ms": 0,
  "delete_ttl_ms": 0,
  "description": "string",
  "disable_everyone_group_access": true,
  "display_name": "string",
  "dormant_ttl_ms": 0,
  "failure_ttl_ms": 0,
  "icon": "string",
  "max_port_share_level": "owner",
  "name": "string",
  "require_active_version": true,
  "template_use_classic_parameter_flow": true,
  "template_version_id": "0ba39c92-1f1b-4c32-aa3e-9925d7713eb1",
  "time_til_autostop_notify_ms": 0
}

Parameters

Name	In	Type	Required	Description
`organization`	path	string	true	Organization ID
`body`	body	codersdk.CreateTemplateRequest	true	Request body

Example responses

{
  "active_user_count": 0,
  "active_version_id": "eae64611-bd53-4a80-bb77-df1e432c0fbc",
  "activity_bump_ms": 0,
  "agents_allowed": true,
  "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": 0
  },
  "build_time_stats": {
    "property1": {
      "p50": 123,
      "p95": 146
    },
    "property2": {
      "p50": 123,
      "p95": 146
    }
  },
  "cors_behavior": "simple",
  "created_at": "2019-08-24T14:15:22Z",
  "created_by_id": "9377d689-01fb-4abf-8450-3368d2c1924f",
  "created_by_name": "string",
  "default_ttl_ms": 0,
  "deleted": true,
  "deprecated": true,
  "deprecation_message": "string",
  "description": "string",
  "disable_module_cache": true,
  "display_name": "string",
  "failure_ttl_ms": 0,
  "icon": "string",
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "max_port_share_level": "owner",
  "name": "string",
  "organization_display_name": "string",
  "organization_icon": "string",
  "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
  "organization_name": "string",
  "provisioner": "terraform",
  "require_active_version": true,
  "time_til_autostop_notify_ms": 0,
  "time_til_dormant_autodelete_ms": 0,
  "time_til_dormant_ms": 0,
  "updated_at": "2019-08-24T14:15:22Z",
  "use_classic_parameter_flow": true
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	codersdk.Template

To perform this operation, you must be authenticated. Learn more.

Get template examples by organization

Code samples

# Example request using curl
curl -X GET http://coder-server:8080/api/v2/organizations/{organization}/templates/examples \
  -H 'Accept: application/json' \
  -H 'Coder-Session-Token: API_KEY'

GET /api/v2/organizations/{organization}/templates/examples

Parameters

Name	In	Type	Required	Description
`organization`	path	string(uuid)	true	Organization ID

Example responses

[
  {
    "description": "string",
    "icon": "string",
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "markdown": "string",
    "name": "string",
    "tags": [
      "string"
    ],
    "url": "string"
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	array of codersdk.TemplateExample

Response Schema

Status Code 200

Name	Type	Required
`[array item]`	array	false
`» description`	string	false
`» icon`	string	false
`» id`	string(uuid)	false
`» markdown`	string	false
`» name`	string	false
`» tags`	array	false
`» url`	string	false

To perform this operation, you must be authenticated. Learn more.

Get templates by organization and template name

Code samples

# Example request using curl
curl -X GET http://coder-server:8080/api/v2/organizations/{organization}/templates/{templatename} \
  -H 'Accept: application/json' \
  -H 'Coder-Session-Token: API_KEY'

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

Parameters

Name	In	Type	Required	Description
`organization`	path	string(uuid)	true	Organization ID
`templatename`	path	string	true	Template name

Example responses

{
  "active_user_count": 0,
  "active_version_id": "eae64611-bd53-4a80-bb77-df1e432c0fbc",
  "activity_bump_ms": 0,
  "agents_allowed": true,
  "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": 0
  },
  "build_time_stats": {
    "property1": {
      "p50": 123,
      "p95": 146
    },
    "property2": {
      "p50": 123,
      "p95": 146
    }
  },
  "cors_behavior": "simple",
  "created_at": "2019-08-24T14:15:22Z",
  "created_by_id": "9377d689-01fb-4abf-8450-3368d2c1924f",
  "created_by_name": "string",
  "default_ttl_ms": 0,
  "deleted": true,
  "deprecated": true,
  "deprecation_message": "string",
  "description": "string",
  "disable_module_cache": true,
  "display_name": "string",
  "failure_ttl_ms": 0,
  "icon": "string",
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "max_port_share_level": "owner",
  "name": "string",
  "organization_display_name": "string",
  "organization_icon": "string",
  "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
  "organization_name": "string",
  "provisioner": "terraform",
  "require_active_version": true,
  "time_til_autostop_notify_ms": 0,
  "time_til_dormant_autodelete_ms": 0,
  "time_til_dormant_ms": 0,
  "updated_at": "2019-08-24T14:15:22Z",
  "use_classic_parameter_flow": true
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	codersdk.Template

To perform this operation, you must be authenticated. Learn more.

Get template version by organization, template, and name

Code samples

# Example request using curl
curl -X GET http://coder-server:8080/api/v2/organizations/{organization}/templates/{templatename}/versions/{templateversionname} \
  -H 'Accept: application/json' \
  -H 'Coder-Session-Token: API_KEY'

GET /api/v2/organizations/{organization}/templates/{templatename}/versions/{templateversionname}

Parameters

Name	In	Type	Required	Description
`organization`	path	string(uuid)	true	Organization ID
`templatename`	path	string	true	Template name
`templateversionname`	path	string	true	Template version name

Example responses

{
  "archived": true,
  "created_at": "2019-08-24T14:15:22Z",
  "created_by": {
    "avatar_url": "http://example.com",
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string",
    "username": "string"
  },
  "has_external_agent": true,
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "job": {
    "available_workers": [
      "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    ],
    "canceled_at": "2019-08-24T14:15:22Z",
    "completed_at": "2019-08-24T14:15:22Z",
    "created_at": "2019-08-24T14:15:22Z",
    "error": "string",
    "error_code": "REQUIRED_TEMPLATE_VARIABLES",
    "file_id": "8a0cfb4f-ddc9-436d-91bb-75133c583767",
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "initiator_id": "06588898-9a84-4b35-ba8f-f9cbd64946f3",
    "input": {
      "error": "string",
      "template_version_id": "0ba39c92-1f1b-4c32-aa3e-9925d7713eb1",
      "workspace_build_id": "badaf2eb-96c5-4050-9f1d-db2d39ca5478"
    },
    "logs_overflowed": true,
    "metadata": {
      "template_display_name": "string",
      "template_icon": "string",
      "template_id": "c6d67e98-83ea-49f0-8812-e4abae2b68bc",
      "template_name": "string",
      "template_version_name": "string",
      "workspace_build_transition": "start",
      "workspace_id": "0967198e-ec7b-4c6b-b4d3-f71244cadbe9",
      "workspace_name": "string"
    },
    "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
    "queue_position": 0,
    "queue_size": 0,
    "started_at": "2019-08-24T14:15:22Z",
    "status": "pending",
    "tags": {
      "property1": "string",
      "property2": "string"
    },
    "type": "template_version_import",
    "worker_id": "ae5fa6f7-c55b-40c1-b40a-b36ac467652b",
    "worker_name": "string"
  },
  "matched_provisioners": {
    "available": 0,
    "count": 0,
    "most_recently_seen": "2019-08-24T14:15:22Z"
  },
  "message": "string",
  "name": "string",
  "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
  "readme": "string",
  "template_id": "c6d67e98-83ea-49f0-8812-e4abae2b68bc",
  "updated_at": "2019-08-24T14:15:22Z",
  "warnings": [
    "UNSUPPORTED_WORKSPACES"
  ]
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	codersdk.TemplateVersion

To perform this operation, you must be authenticated. Learn more.

Get previous template version by organization, template, and name

Code samples

# Example request using curl
curl -X GET http://coder-server:8080/api/v2/organizations/{organization}/templates/{templatename}/versions/{templateversionname}/previous \
  -H 'Accept: application/json' \
  -H 'Coder-Session-Token: API_KEY'

GET /api/v2/organizations/{organization}/templates/{templatename}/versions/{templateversionname}/previous

Parameters

Name	In	Type	Required	Description
`organization`	path	string(uuid)	true	Organization ID
`templatename`	path	string	true	Template name
`templateversionname`	path	string	true	Template version name

Example responses

{
  "archived": true,
  "created_at": "2019-08-24T14:15:22Z",
  "created_by": {
    "avatar_url": "http://example.com",
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string",
    "username": "string"
  },
  "has_external_agent": true,
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "job": {
    "available_workers": [
      "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    ],
    "canceled_at": "2019-08-24T14:15:22Z",
    "completed_at": "2019-08-24T14:15:22Z",
    "created_at": "2019-08-24T14:15:22Z",
    "error": "string",
    "error_code": "REQUIRED_TEMPLATE_VARIABLES",
    "file_id": "8a0cfb4f-ddc9-436d-91bb-75133c583767",
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "initiator_id": "06588898-9a84-4b35-ba8f-f9cbd64946f3",
    "input": {
      "error": "string",
      "template_version_id": "0ba39c92-1f1b-4c32-aa3e-9925d7713eb1",
      "workspace_build_id": "badaf2eb-96c5-4050-9f1d-db2d39ca5478"
    },
    "logs_overflowed": true,
    "metadata": {
      "template_display_name": "string",
      "template_icon": "string",
      "template_id": "c6d67e98-83ea-49f0-8812-e4abae2b68bc",
      "template_name": "string",
      "template_version_name": "string",
      "workspace_build_transition": "start",
      "workspace_id": "0967198e-ec7b-4c6b-b4d3-f71244cadbe9",
      "workspace_name": "string"
    },
    "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
    "queue_position": 0,
    "queue_size": 0,
    "started_at": "2019-08-24T14:15:22Z",
    "status": "pending",
    "tags": {
      "property1": "string",
      "property2": "string"
    },
    "type": "template_version_import",
    "worker_id": "ae5fa6f7-c55b-40c1-b40a-b36ac467652b",
    "worker_name": "string"
  },
  "matched_provisioners": {
    "available": 0,
    "count": 0,
    "most_recently_seen": "2019-08-24T14:15:22Z"
  },
  "message": "string",
  "name": "string",
  "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
  "readme": "string",
  "template_id": "c6d67e98-83ea-49f0-8812-e4abae2b68bc",
  "updated_at": "2019-08-24T14:15:22Z",
  "warnings": [
    "UNSUPPORTED_WORKSPACES"
  ]
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	codersdk.TemplateVersion
204	No Content	No Content

To perform this operation, you must be authenticated. Learn more.

Create template version by organization

Code samples

# Example request using curl
curl -X POST http://coder-server:8080/api/v2/organizations/{organization}/templateversions \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Coder-Session-Token: API_KEY'

POST /api/v2/organizations/{organization}/templateversions

{
  "example_id": "string",
  "file_id": "8a0cfb4f-ddc9-436d-91bb-75133c583767",
  "message": "string",
  "name": "string",
  "provisioner": "terraform",
  "storage_method": "file",
  "tags": {
    "property1": "string",
    "property2": "string"
  },
  "template_id": "c6d67e98-83ea-49f0-8812-e4abae2b68bc",
  "user_variable_values": [
    {
      "name": "string",
      "value": "string"
    }
  ]
}

Parameters

Name	In	Type	Required	Description
`organization`	path	string(uuid)	true	Organization ID
`body`	body	codersdk.CreateTemplateVersionRequest	true	Create template version request

Example responses

{
  "archived": true,
  "created_at": "2019-08-24T14:15:22Z",
  "created_by": {
    "avatar_url": "http://example.com",
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string",
    "username": "string"
  },
  "has_external_agent": true,
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "job": {
    "available_workers": [
      "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    ],
    "canceled_at": "2019-08-24T14:15:22Z",
    "completed_at": "2019-08-24T14:15:22Z",
    "created_at": "2019-08-24T14:15:22Z",
    "error": "string",
    "error_code": "REQUIRED_TEMPLATE_VARIABLES",
    "file_id": "8a0cfb4f-ddc9-436d-91bb-75133c583767",
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "initiator_id": "06588898-9a84-4b35-ba8f-f9cbd64946f3",
    "input": {
      "error": "string",
      "template_version_id": "0ba39c92-1f1b-4c32-aa3e-9925d7713eb1",
      "workspace_build_id": "badaf2eb-96c5-4050-9f1d-db2d39ca5478"
    },
    "logs_overflowed": true,
    "metadata": {
      "template_display_name": "string",
      "template_icon": "string",
      "template_id": "c6d67e98-83ea-49f0-8812-e4abae2b68bc",
      "template_name": "string",
      "template_version_name": "string",
      "workspace_build_transition": "start",
      "workspace_id": "0967198e-ec7b-4c6b-b4d3-f71244cadbe9",
      "workspace_name": "string"
    },
    "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
    "queue_position": 0,
    "queue_size": 0,
    "started_at": "2019-08-24T14:15:22Z",
    "status": "pending",
    "tags": {
      "property1": "string",
      "property2": "string"
    },
    "type": "template_version_import",
    "worker_id": "ae5fa6f7-c55b-40c1-b40a-b36ac467652b",
    "worker_name": "string"
  },
  "matched_provisioners": {
    "available": 0,
    "count": 0,
    "most_recently_seen": "2019-08-24T14:15:22Z"
  },
  "message": "string",
  "name": "string",
  "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
  "readme": "string",
  "template_id": "c6d67e98-83ea-49f0-8812-e4abae2b68bc",
  "updated_at": "2019-08-24T14:15:22Z",
  "warnings": [
    "UNSUPPORTED_WORKSPACES"
  ]
}

Responses

Status	Meaning	Description	Schema
201	Created	Created	codersdk.TemplateVersion

To perform this operation, you must be authenticated. Learn more.

Get all templates

Code samples

# Example request using curl
curl -X GET http://coder-server:8080/api/v2/templates \
  -H 'Accept: application/json' \
  -H 'Coder-Session-Token: API_KEY'

GET /api/v2/templates

Returns a list of templates. By default, only non-deprecated templates are returned. To include deprecated templates, specify deprecated:true in the search query.

Example responses

[
  {
    "active_user_count": 0,
    "active_version_id": "eae64611-bd53-4a80-bb77-df1e432c0fbc",
    "activity_bump_ms": 0,
    "agents_allowed": true,
    "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": 0
    },
    "build_time_stats": {
      "property1": {
        "p50": 123,
        "p95": 146
      },
      "property2": {
        "p50": 123,
        "p95": 146
      }
    },
    "cors_behavior": "simple",
    "created_at": "2019-08-24T14:15:22Z",
    "created_by_id": "9377d689-01fb-4abf-8450-3368d2c1924f",
    "created_by_name": "string",
    "default_ttl_ms": 0,
    "deleted": true,
    "deprecated": true,
    "deprecation_message": "string",
    "description": "string",
    "disable_module_cache": true,
    "display_name": "string",
    "failure_ttl_ms": 0,
    "icon": "string",
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "max_port_share_level": "owner",
    "name": "string",
    "organization_display_name": "string",
    "organization_icon": "string",
    "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
    "organization_name": "string",
    "provisioner": "terraform",
    "require_active_version": true,
    "time_til_autostop_notify_ms": 0,
    "time_til_dormant_autodelete_ms": 0,
    "time_til_dormant_ms": 0,
    "updated_at": "2019-08-24T14:15:22Z",
    "use_classic_parameter_flow": true
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	array of codersdk.Template

Response Schema

Status Code 200

Name	Type	Required	Description
`[array item]`	array	false
`» active_user_count`	integer	false	Active user count is set to -1 when loading.
`» active_version_id`	string(uuid)	false
`» activity_bump_ms`	integer	false
`» agents_allowed`	boolean	false
`» allow_user_autostart`	boolean	false	Allow user autostart 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	false
`» allow_user_cancel_workspace_jobs`	boolean	false
`» autostart_requirement`	codersdk.TemplateAutostartRequirement	false
`»» days_of_week`	array	false	Days of week is a list of days of the week in which autostart is allowed to happen. If no days are specified, autostart is not allowed.
`» autostop_requirement`	codersdk.TemplateAutostopRequirement	false	Autostop requirement and AutostartRequirement are enterprise features. Its value is only used if your license is entitled to use the advanced template scheduling feature.
`»» days_of_week`	array	false	Days of week is a list of days of the week on which restarts are required. Restarts happen within the user's quiet hours (in their configured timezone). If no days are specified, restarts are not required. Weekdays cannot be specified twice.
Restarts will only happen on weekdays in this list on weeks which line up with Weeks.
`»» weeks`	integer	false	Weeks is the number of weeks between required restarts. Weeks are synced across all workspaces (and Coder deployments) using modulo math on a hardcoded epoch week of January 2nd, 2023 (the first Monday of 2023). Values of 0 or 1 indicate weekly restarts. Values of 2 indicate fortnightly restarts, etc.
`» build_time_stats`	codersdk.TemplateBuildTimeStats	false
`»» [any property]`	codersdk.TransitionStats	false
`»»» p50`	integer	false
`»»» p95`	integer	false
`» cors_behavior`	codersdk.CORSBehavior	false
`» created_at`	string(date-time)	false
`» created_by_id`	string(uuid)	false
`» created_by_name`	string	false
`» default_ttl_ms`	integer	false
`» deleted`	boolean	false
`» deprecated`	boolean	false
`» deprecation_message`	string	false
`» description`	string	false
`» disable_module_cache`	boolean	false	Disable module cache disables the use of cached Terraform modules during provisioning.
`» display_name`	string	false
`» failure_ttl_ms`	integer	false	Failure ttl ms TimeTilDormantMillis, and TimeTilDormantAutoDeleteMillis are enterprise-only. Their values are used if your license is entitled to use the advanced template scheduling feature.
`» icon`	string	false
`» id`	string(uuid)	false
`» max_port_share_level`	codersdk.WorkspaceAgentPortShareLevel	false
`» name`	string	false
`» organization_display_name`	string	false
`» organization_icon`	string	false
`» organization_id`	string(uuid)	false
`» organization_name`	string(url)	false
`» provisioner`	string	false
`» require_active_version`	boolean	false	Require active version mandates that workspaces are built with the active template version.
`» time_til_autostop_notify_ms`	integer	false	Time til autostop notify ms is the duration before the workspace's autostop deadline at which a reminder notification is sent. 0 disables the notification.
`» time_til_dormant_autodelete_ms`	integer	false
`» time_til_dormant_ms`	integer	false
`» updated_at`	string(date-time)	false
`» use_classic_parameter_flow`	boolean	false

Enumerated Values

Property	Value(s)
`cors_behavior`	`passthru`, `simple`
`max_port_share_level`	`authenticated`, `organization`, `owner`, `public`
`provisioner`	`terraform`

To perform this operation, you must be authenticated. Learn more.

Get template examples

Code samples

# Example request using curl
curl -X GET http://coder-server:8080/api/v2/templates/examples \
  -H 'Accept: application/json' \
  -H 'Coder-Session-Token: API_KEY'

GET /api/v2/templates/examples

Example responses

[
  {
    "description": "string",
    "icon": "string",
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "markdown": "string",
    "name": "string",
    "tags": [
      "string"
    ],
    "url": "string"
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	array of codersdk.TemplateExample

Response Schema

Status Code 200

Name	Type	Required
`[array item]`	array	false
`» description`	string	false
`» icon`	string	false
`» id`	string(uuid)	false
`» markdown`	string	false
`» name`	string	false
`» tags`	array	false
`» url`	string	false

To perform this operation, you must be authenticated. Learn more.

Get template settings by ID

Code samples

# Example request using curl
curl -X GET http://coder-server:8080/api/v2/templates/{template} \
  -H 'Accept: application/json' \
  -H 'Coder-Session-Token: API_KEY'

GET /api/v2/templates/{template}

Parameters

Name	In	Type	Required	Description
`template`	path	string(uuid)	true	Template ID

Example responses

{
  "active_user_count": 0,
  "active_version_id": "eae64611-bd53-4a80-bb77-df1e432c0fbc",
  "activity_bump_ms": 0,
  "agents_allowed": true,
  "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": 0
  },
  "build_time_stats": {
    "property1": {
      "p50": 123,
      "p95": 146
    },
    "property2": {
      "p50": 123,
      "p95": 146
    }
  },
  "cors_behavior": "simple",
  "created_at": "2019-08-24T14:15:22Z",
  "created_by_id": "9377d689-01fb-4abf-8450-3368d2c1924f",
  "created_by_name": "string",
  "default_ttl_ms": 0,
  "deleted": true,
  "deprecated": true,
  "deprecation_message": "string",
  "description": "string",
  "disable_module_cache": true,
  "display_name": "string",
  "failure_ttl_ms": 0,
  "icon": "string",
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "max_port_share_level": "owner",
  "name": "string",
  "organization_display_name": "string",
  "organization_icon": "string",
  "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
  "organization_name": "string",
  "provisioner": "terraform",
  "require_active_version": true,
  "time_til_autostop_notify_ms": 0,
  "time_til_dormant_autodelete_ms": 0,
  "time_til_dormant_ms": 0,
  "updated_at": "2019-08-24T14:15:22Z",
  "use_classic_parameter_flow": true
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	codersdk.Template

To perform this operation, you must be authenticated. Learn more.

Delete template by ID

Code samples

# Example request using curl
curl -X DELETE http://coder-server:8080/api/v2/templates/{template} \
  -H 'Accept: application/json' \
  -H 'Coder-Session-Token: API_KEY'

DELETE /api/v2/templates/{template}

Parameters

Name	In	Type	Required	Description
`template`	path	string(uuid)	true	Template ID

Example responses

{
  "detail": "string",
  "message": "string",
  "validations": [
    {
      "detail": "string",
      "field": "string"
    }
  ]
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	codersdk.Response

To perform this operation, you must be authenticated. Learn more.

Update template settings by ID

Code samples

# Example request using curl
curl -X PATCH http://coder-server:8080/api/v2/templates/{template} \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Coder-Session-Token: API_KEY'

PATCH /api/v2/templates/{template}

{
  "activity_bump_ms": 0,
  "agents_allowed": true,
  "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": 0
  },
  "cors_behavior": "simple",
  "default_ttl_ms": 0,
  "deprecation_message": "string",
  "description": "string",
  "disable_everyone_group_access": true,
  "disable_module_cache": true,
  "display_name": "string",
  "failure_ttl_ms": 0,
  "icon": "string",
  "max_port_share_level": "owner",
  "name": "string",
  "require_active_version": true,
  "time_til_autostop_notify_ms": 0,
  "time_til_dormant_autodelete_ms": 0,
  "time_til_dormant_ms": 0,
  "update_workspace_dormant_at": true,
  "update_workspace_last_used_at": true,
  "use_classic_parameter_flow": true
}

Parameters

Name	In	Type	Required	Description
`template`	path	string(uuid)	true	Template ID
`body`	body	codersdk.UpdateTemplateMeta	true	Patch template settings request

Example responses

{
  "active_user_count": 0,
  "active_version_id": "eae64611-bd53-4a80-bb77-df1e432c0fbc",
  "activity_bump_ms": 0,
  "agents_allowed": true,
  "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": 0
  },
  "build_time_stats": {
    "property1": {
      "p50": 123,
      "p95": 146
    },
    "property2": {
      "p50": 123,
      "p95": 146
    }
  },
  "cors_behavior": "simple",
  "created_at": "2019-08-24T14:15:22Z",
  "created_by_id": "9377d689-01fb-4abf-8450-3368d2c1924f",
  "created_by_name": "string",
  "default_ttl_ms": 0,
  "deleted": true,
  "deprecated": true,
  "deprecation_message": "string",
  "description": "string",
  "disable_module_cache": true,
  "display_name": "string",
  "failure_ttl_ms": 0,
  "icon": "string",
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "max_port_share_level": "owner",
  "name": "string",
  "organization_display_name": "string",
  "organization_icon": "string",
  "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
  "organization_name": "string",
  "provisioner": "terraform",
  "require_active_version": true,
  "time_til_autostop_notify_ms": 0,
  "time_til_dormant_autodelete_ms": 0,
  "time_til_dormant_ms": 0,
  "updated_at": "2019-08-24T14:15:22Z",
  "use_classic_parameter_flow": true
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	codersdk.Template

To perform this operation, you must be authenticated. Learn more.

Get template DAUs by ID

Code samples

# Example request using curl
curl -X GET http://coder-server:8080/api/v2/templates/{template}/daus \
  -H 'Accept: application/json' \
  -H 'Coder-Session-Token: API_KEY'

GET /api/v2/templates/{template}/daus

Parameters

Name	In	Type	Required	Description
`template`	path	string(uuid)	true	Template ID

Example responses

{
  "entries": [
    {
      "amount": 0,
      "date": "string"
    }
  ],
  "tz_hour_offset": 0
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	codersdk.DAUsResponse

To perform this operation, you must be authenticated. Learn more.

List template versions by template ID

Code samples

# Example request using curl
curl -X GET http://coder-server:8080/api/v2/templates/{template}/versions \
  -H 'Accept: application/json' \
  -H 'Coder-Session-Token: API_KEY'

GET /api/v2/templates/{template}/versions

Parameters

Name	In	Type	Required	Description
`template`	path	string(uuid)	true	Template ID
`after_id`	query	string(uuid)	false	After ID
`include_archived`	query	boolean	false	Include archived versions in the list
`limit`	query	integer	false	Page limit
`offset`	query	integer	false	Page offset

Example responses

[
  {
    "archived": true,
    "created_at": "2019-08-24T14:15:22Z",
    "created_by": {
      "avatar_url": "http://example.com",
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "name": "string",
      "username": "string"
    },
    "has_external_agent": true,
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "job": {
      "available_workers": [
        "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      ],
      "canceled_at": "2019-08-24T14:15:22Z",
      "completed_at": "2019-08-24T14:15:22Z",
      "created_at": "2019-08-24T14:15:22Z",
      "error": "string",
      "error_code": "REQUIRED_TEMPLATE_VARIABLES",
      "file_id": "8a0cfb4f-ddc9-436d-91bb-75133c583767",
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "initiator_id": "06588898-9a84-4b35-ba8f-f9cbd64946f3",
      "input": {
        "error": "string",
        "template_version_id": "0ba39c92-1f1b-4c32-aa3e-9925d7713eb1",
        "workspace_build_id": "badaf2eb-96c5-4050-9f1d-db2d39ca5478"
      },
      "logs_overflowed": true,
      "metadata": {
        "template_display_name": "string",
        "template_icon": "string",
        "template_id": "c6d67e98-83ea-49f0-8812-e4abae2b68bc",
        "template_name": "string",
        "template_version_name": "string",
        "workspace_build_transition": "start",
        "workspace_id": "0967198e-ec7b-4c6b-b4d3-f71244cadbe9",
        "workspace_name": "string"
      },
      "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
      "queue_position": 0,
      "queue_size": 0,
      "started_at": "2019-08-24T14:15:22Z",
      "status": "pending",
      "tags": {
        "property1": "string",
        "property2": "string"
      },
      "type": "template_version_import",
      "worker_id": "ae5fa6f7-c55b-40c1-b40a-b36ac467652b",
      "worker_name": "string"
    },
    "matched_provisioners": {
      "available": 0,
      "count": 0,
      "most_recently_seen": "2019-08-24T14:15:22Z"
    },
    "message": "string",
    "name": "string",
    "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
    "readme": "string",
    "template_id": "c6d67e98-83ea-49f0-8812-e4abae2b68bc",
    "updated_at": "2019-08-24T14:15:22Z",
    "warnings": [
      "UNSUPPORTED_WORKSPACES"
    ]
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	array of codersdk.TemplateVersion

Response Schema

Status Code 200

Name	Type	Required	Description
`[array item]`	array	false
`» archived`	boolean	false
`» created_at`	string(date-time)	false
`» created_by`	codersdk.MinimalUser	false
`»» avatar_url`	string(uri)	false
`»» id`	string(uuid)	true
`»» name`	string	false
`»» username`	string	true
`» has_external_agent`	boolean	false
`» id`	string(uuid)	false
`» job`	codersdk.ProvisionerJob	false
`»» available_workers`	array	false
`»» canceled_at`	string(date-time)	false
`»» completed_at`	string(date-time)	false
`»» created_at`	string(date-time)	false
`»» error`	string	false
`»» error_code`	codersdk.JobErrorCode	false
`»» file_id`	string(uuid)	false
`»» id`	string(uuid)	false
`»» initiator_id`	string(uuid)	false
`»» input`	codersdk.ProvisionerJobInput	false
`»»» error`	string	false
`»»» template_version_id`	string(uuid)	false
`»»» workspace_build_id`	string(uuid)	false
`»» logs_overflowed`	boolean	false
`»» metadata`	codersdk.ProvisionerJobMetadata	false
`»»» template_display_name`	string	false
`»»» template_icon`	string	false
`»»» template_id`	string(uuid)	false
`»»» template_name`	string	false
`»»» template_version_name`	string	false
`»»» workspace_build_transition`	codersdk.WorkspaceTransition	false
`»»» workspace_id`	string(uuid)	false
`»»» workspace_name`	string	false
`»» organization_id`	string(uuid)	false
`»» queue_position`	integer	false
`»» queue_size`	integer	false
`»» started_at`	string(date-time)	false
`»» status`	codersdk.ProvisionerJobStatus	false
`»» tags`	object	false
`»»» [any property]`	string	false
`»» type`	codersdk.ProvisionerJobType	false
`»» worker_id`	string(uuid)	false
`»» worker_name`	string	false
`» matched_provisioners`	codersdk.MatchedProvisioners	false
`»» available`	integer	false	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`	integer	false	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.
`»» most_recently_seen`	string(date-time)	false	Most recently seen is the most recently seen time of the set of matched provisioners. If no provisioners matched, this field will be null.
`» message`	string	false
`» name`	string	false
`» organization_id`	string(uuid)	false
`» readme`	string	false
`» template_id`	string(uuid)	false
`» updated_at`	string(date-time)	false
`» warnings`	array	false

Enumerated Values

Property	Value(s)
`error_code`	`INSUFFICIENT_QUOTA`, `REQUIRED_TEMPLATE_VARIABLES`
`workspace_build_transition`	`delete`, `start`, `stop`
`status`	`canceled`, `canceling`, `failed`, `pending`, `running`, `succeeded`
`type`	`template_version_dry_run`, `template_version_import`, `workspace_build`

To perform this operation, you must be authenticated. Learn more.

Update active template version by template ID

Code samples

# Example request using curl
curl -X PATCH http://coder-server:8080/api/v2/templates/{template}/versions \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Coder-Session-Token: API_KEY'

PATCH /api/v2/templates/{template}/versions

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}

Parameters

Name	In	Type	Required	Description
`template`	path	string(uuid)	true	Template ID
`body`	body	codersdk.UpdateActiveTemplateVersion	true	Modified template version

Example responses

{
  "detail": "string",
  "message": "string",
  "validations": [
    {
      "detail": "string",
      "field": "string"
    }
  ]
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	codersdk.Response

To perform this operation, you must be authenticated. Learn more.

Archive template unused versions by template id

Code samples

# Example request using curl
curl -X POST http://coder-server:8080/api/v2/templates/{template}/versions/archive \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Coder-Session-Token: API_KEY'

POST /api/v2/templates/{template}/versions/archive

{
  "all": true
}

Parameters

Name	In	Type	Required	Description
`template`	path	string(uuid)	true	Template ID
`body`	body	codersdk.ArchiveTemplateVersionsRequest	true	Archive request

Example responses

{
  "detail": "string",
  "message": "string",
  "validations": [
    {
      "detail": "string",
      "field": "string"
    }
  ]
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	codersdk.Response

To perform this operation, you must be authenticated. Learn more.

Get template version by template ID and name

Code samples

# Example request using curl
curl -X GET http://coder-server:8080/api/v2/templates/{template}/versions/{templateversionname} \
  -H 'Accept: application/json' \
  -H 'Coder-Session-Token: API_KEY'

GET /api/v2/templates/{template}/versions/{templateversionname}

Parameters

Name	In	Type	Required	Description
`template`	path	string(uuid)	true	Template ID
`templateversionname`	path	string	true	Template version name

Example responses

[
  {
    "archived": true,
    "created_at": "2019-08-24T14:15:22Z",
    "created_by": {
      "avatar_url": "http://example.com",
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "name": "string",
      "username": "string"
    },
    "has_external_agent": true,
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "job": {
      "available_workers": [
        "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      ],
      "canceled_at": "2019-08-24T14:15:22Z",
      "completed_at": "2019-08-24T14:15:22Z",
      "created_at": "2019-08-24T14:15:22Z",
      "error": "string",
      "error_code": "REQUIRED_TEMPLATE_VARIABLES",
      "file_id": "8a0cfb4f-ddc9-436d-91bb-75133c583767",
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "initiator_id": "06588898-9a84-4b35-ba8f-f9cbd64946f3",
      "input": {
        "error": "string",
        "template_version_id": "0ba39c92-1f1b-4c32-aa3e-9925d7713eb1",
        "workspace_build_id": "badaf2eb-96c5-4050-9f1d-db2d39ca5478"
      },
      "logs_overflowed": true,
      "metadata": {
        "template_display_name": "string",
        "template_icon": "string",
        "template_id": "c6d67e98-83ea-49f0-8812-e4abae2b68bc",
        "template_name": "string",
        "template_version_name": "string",
        "workspace_build_transition": "start",
        "workspace_id": "0967198e-ec7b-4c6b-b4d3-f71244cadbe9",
        "workspace_name": "string"
      },
      "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
      "queue_position": 0,
      "queue_size": 0,
      "started_at": "2019-08-24T14:15:22Z",
      "status": "pending",
      "tags": {
        "property1": "string",
        "property2": "string"
      },
      "type": "template_version_import",
      "worker_id": "ae5fa6f7-c55b-40c1-b40a-b36ac467652b",
      "worker_name": "string"
    },
    "matched_provisioners": {
      "available": 0,
      "count": 0,
      "most_recently_seen": "2019-08-24T14:15:22Z"
    },
    "message": "string",
    "name": "string",
    "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
    "readme": "string",
    "template_id": "c6d67e98-83ea-49f0-8812-e4abae2b68bc",
    "updated_at": "2019-08-24T14:15:22Z",
    "warnings": [
      "UNSUPPORTED_WORKSPACES"
    ]
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	array of codersdk.TemplateVersion

Response Schema

Status Code 200

Name	Type	Required	Description
`[array item]`	array	false
`» archived`	boolean	false
`» created_at`	string(date-time)	false
`» created_by`	codersdk.MinimalUser	false
`»» avatar_url`	string(uri)	false
`»» id`	string(uuid)	true
`»» name`	string	false
`»» username`	string	true
`» has_external_agent`	boolean	false
`» id`	string(uuid)	false
`» job`	codersdk.ProvisionerJob	false
`»» available_workers`	array	false
`»» canceled_at`	string(date-time)	false
`»» completed_at`	string(date-time)	false
`»» created_at`	string(date-time)	false
`»» error`	string	false
`»» error_code`	codersdk.JobErrorCode	false
`»» file_id`	string(uuid)	false
`»» id`	string(uuid)	false
`»» initiator_id`	string(uuid)	false
`»» input`	codersdk.ProvisionerJobInput	false
`»»» error`	string	false
`»»» template_version_id`	string(uuid)	false
`»»» workspace_build_id`	string(uuid)	false
`»» logs_overflowed`	boolean	false
`»» metadata`	codersdk.ProvisionerJobMetadata	false
`»»» template_display_name`	string	false
`»»» template_icon`	string	false
`»»» template_id`	string(uuid)	false
`»»» template_name`	string	false
`»»» template_version_name`	string	false
`»»» workspace_build_transition`	codersdk.WorkspaceTransition	false
`»»» workspace_id`	string(uuid)	false
`»»» workspace_name`	string	false
`»» organization_id`	string(uuid)	false
`»» queue_position`	integer	false
`»» queue_size`	integer	false
`»» started_at`	string(date-time)	false
`»» status`	codersdk.ProvisionerJobStatus	false
`»» tags`	object	false
`»»» [any property]`	string	false
`»» type`	codersdk.ProvisionerJobType	false
`»» worker_id`	string(uuid)	false
`»» worker_name`	string	false
`» matched_provisioners`	codersdk.MatchedProvisioners	false
`»» available`	integer	false	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`	integer	false	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.
`»» most_recently_seen`	string(date-time)	false	Most recently seen is the most recently seen time of the set of matched provisioners. If no provisioners matched, this field will be null.
`» message`	string	false
`» name`	string	false
`» organization_id`	string(uuid)	false
`» readme`	string	false
`» template_id`	string(uuid)	false
`» updated_at`	string(date-time)	false
`» warnings`	array	false

Enumerated Values

Property	Value(s)
`error_code`	`INSUFFICIENT_QUOTA`, `REQUIRED_TEMPLATE_VARIABLES`
`workspace_build_transition`	`delete`, `start`, `stop`
`status`	`canceled`, `canceling`, `failed`, `pending`, `running`, `succeeded`
`type`	`template_version_dry_run`, `template_version_import`, `workspace_build`

To perform this operation, you must be authenticated. Learn more.

Get template version by ID

Code samples

# Example request using curl
curl -X GET http://coder-server:8080/api/v2/templateversions/{templateversion} \
  -H 'Accept: application/json' \
  -H 'Coder-Session-Token: API_KEY'

GET /api/v2/templateversions/{templateversion}

Parameters

Name	In	Type	Required	Description
`templateversion`	path	string(uuid)	true	Template version ID

Example responses

{
  "archived": true,
  "created_at": "2019-08-24T14:15:22Z",
  "created_by": {
    "avatar_url": "http://example.com",
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string",
    "username": "string"
  },
  "has_external_agent": true,
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "job": {
    "available_workers": [
      "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    ],
    "canceled_at": "2019-08-24T14:15:22Z",
    "completed_at": "2019-08-24T14:15:22Z",
    "created_at": "2019-08-24T14:15:22Z",
    "error": "string",
    "error_code": "REQUIRED_TEMPLATE_VARIABLES",
    "file_id": "8a0cfb4f-ddc9-436d-91bb-75133c583767",
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "initiator_id": "06588898-9a84-4b35-ba8f-f9cbd64946f3",
    "input": {
      "error": "string",
      "template_version_id": "0ba39c92-1f1b-4c32-aa3e-9925d7713eb1",
      "workspace_build_id": "badaf2eb-96c5-4050-9f1d-db2d39ca5478"
    },
    "logs_overflowed": true,
    "metadata": {
      "template_display_name": "string",
      "template_icon": "string",
      "template_id": "c6d67e98-83ea-49f0-8812-e4abae2b68bc",
      "template_name": "string",
      "template_version_name": "string",
      "workspace_build_transition": "start",
      "workspace_id": "0967198e-ec7b-4c6b-b4d3-f71244cadbe9",
      "workspace_name": "string"
    },
    "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
    "queue_position": 0,
    "queue_size": 0,
    "started_at": "2019-08-24T14:15:22Z",
    "status": "pending",
    "tags": {
      "property1": "string",
      "property2": "string"
    },
    "type": "template_version_import",
    "worker_id": "ae5fa6f7-c55b-40c1-b40a-b36ac467652b",
    "worker_name": "string"
  },
  "matched_provisioners": {
    "available": 0,
    "count": 0,
    "most_recently_seen": "2019-08-24T14:15:22Z"
  },
  "message": "string",
  "name": "string",
  "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
  "readme": "string",
  "template_id": "c6d67e98-83ea-49f0-8812-e4abae2b68bc",
  "updated_at": "2019-08-24T14:15:22Z",
  "warnings": [
    "UNSUPPORTED_WORKSPACES"
  ]
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	codersdk.TemplateVersion

To perform this operation, you must be authenticated. Learn more.

Patch template version by ID

Code samples

# Example request using curl
curl -X PATCH http://coder-server:8080/api/v2/templateversions/{templateversion} \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Coder-Session-Token: API_KEY'

PATCH /api/v2/templateversions/{templateversion}

{
  "message": "string",
  "name": "string"
}

Parameters

Name	In	Type	Required	Description
`templateversion`	path	string(uuid)	true	Template version ID
`body`	body	codersdk.PatchTemplateVersionRequest	true	Patch template version request

Example responses

{
  "archived": true,
  "created_at": "2019-08-24T14:15:22Z",
  "created_by": {
    "avatar_url": "http://example.com",
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string",
    "username": "string"
  },
  "has_external_agent": true,
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "job": {
    "available_workers": [
      "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    ],
    "canceled_at": "2019-08-24T14:15:22Z",
    "completed_at": "2019-08-24T14:15:22Z",
    "created_at": "2019-08-24T14:15:22Z",
    "error": "string",
    "error_code": "REQUIRED_TEMPLATE_VARIABLES",
    "file_id": "8a0cfb4f-ddc9-436d-91bb-75133c583767",
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "initiator_id": "06588898-9a84-4b35-ba8f-f9cbd64946f3",
    "input": {
      "error": "string",
      "template_version_id": "0ba39c92-1f1b-4c32-aa3e-9925d7713eb1",
      "workspace_build_id": "badaf2eb-96c5-4050-9f1d-db2d39ca5478"
    },
    "logs_overflowed": true,
    "metadata": {
      "template_display_name": "string",
      "template_icon": "string",
      "template_id": "c6d67e98-83ea-49f0-8812-e4abae2b68bc",
      "template_name": "string",
      "template_version_name": "string",
      "workspace_build_transition": "start",
      "workspace_id": "0967198e-ec7b-4c6b-b4d3-f71244cadbe9",
      "workspace_name": "string"
    },
    "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
    "queue_position": 0,
    "queue_size": 0,
    "started_at": "2019-08-24T14:15:22Z",
    "status": "pending",
    "tags": {
      "property1": "string",
      "property2": "string"
    },
    "type": "template_version_import",
    "worker_id": "ae5fa6f7-c55b-40c1-b40a-b36ac467652b",
    "worker_name": "string"
  },
  "matched_provisioners": {
    "available": 0,
    "count": 0,
    "most_recently_seen": "2019-08-24T14:15:22Z"
  },
  "message": "string",
  "name": "string",
  "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
  "readme": "string",
  "template_id": "c6d67e98-83ea-49f0-8812-e4abae2b68bc",
  "updated_at": "2019-08-24T14:15:22Z",
  "warnings": [
    "UNSUPPORTED_WORKSPACES"
  ]
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	codersdk.TemplateVersion

To perform this operation, you must be authenticated. Learn more.

Archive template version

Code samples

# Example request using curl
curl -X POST http://coder-server:8080/api/v2/templateversions/{templateversion}/archive \
  -H 'Accept: application/json' \
  -H 'Coder-Session-Token: API_KEY'

POST /api/v2/templateversions/{templateversion}/archive

Parameters

Name	In	Type	Required	Description
`templateversion`	path	string(uuid)	true	Template version ID

Example responses

{
  "detail": "string",
  "message": "string",
  "validations": [
    {
      "detail": "string",
      "field": "string"
    }
  ]
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	codersdk.Response

To perform this operation, you must be authenticated. Learn more.

Cancel template version by ID

Code samples

# Example request using curl
curl -X PATCH http://coder-server:8080/api/v2/templateversions/{templateversion}/cancel \
  -H 'Accept: application/json' \
  -H 'Coder-Session-Token: API_KEY'

PATCH /api/v2/templateversions/{templateversion}/cancel

Parameters

Name	In	Type	Required	Description
`templateversion`	path	string(uuid)	true	Template version ID

Example responses

{
  "detail": "string",
  "message": "string",
  "validations": [
    {
      "detail": "string",
      "field": "string"
    }
  ]
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	codersdk.Response

To perform this operation, you must be authenticated. Learn more.

Create template version dry-run

Code samples

# Example request using curl
curl -X POST http://coder-server:8080/api/v2/templateversions/{templateversion}/dry-run \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Coder-Session-Token: API_KEY'

POST /api/v2/templateversions/{templateversion}/dry-run

{
  "rich_parameter_values": [
    {
      "name": "string",
      "value": "string"
    }
  ],
  "user_variable_values": [
    {
      "name": "string",
      "value": "string"
    }
  ],
  "workspace_name": "string"
}

Parameters

Name	In	Type	Required	Description
`templateversion`	path	string(uuid)	true	Template version ID
`body`	body	codersdk.CreateTemplateVersionDryRunRequest	true	Dry-run request

Example responses

{
  "available_workers": [
    "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  ],
  "canceled_at": "2019-08-24T14:15:22Z",
  "completed_at": "2019-08-24T14:15:22Z",
  "created_at": "2019-08-24T14:15:22Z",
  "error": "string",
  "error_code": "REQUIRED_TEMPLATE_VARIABLES",
  "file_id": "8a0cfb4f-ddc9-436d-91bb-75133c583767",
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "initiator_id": "06588898-9a84-4b35-ba8f-f9cbd64946f3",
  "input": {
    "error": "string",
    "template_version_id": "0ba39c92-1f1b-4c32-aa3e-9925d7713eb1",
    "workspace_build_id": "badaf2eb-96c5-4050-9f1d-db2d39ca5478"
  },
  "logs_overflowed": true,
  "metadata": {
    "template_display_name": "string",
    "template_icon": "string",
    "template_id": "c6d67e98-83ea-49f0-8812-e4abae2b68bc",
    "template_name": "string",
    "template_version_name": "string",
    "workspace_build_transition": "start",
    "workspace_id": "0967198e-ec7b-4c6b-b4d3-f71244cadbe9",
    "workspace_name": "string"
  },
  "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
  "queue_position": 0,
  "queue_size": 0,
  "started_at": "2019-08-24T14:15:22Z",
  "status": "pending",
  "tags": {
    "property1": "string",
    "property2": "string"
  },
  "type": "template_version_import",
  "worker_id": "ae5fa6f7-c55b-40c1-b40a-b36ac467652b",
  "worker_name": "string"
}

Responses

Status	Meaning	Description	Schema
201	Created	Created	codersdk.ProvisionerJob

To perform this operation, you must be authenticated. Learn more.

Get template version dry-run by job ID

Code samples

# Example request using curl
curl -X GET http://coder-server:8080/api/v2/templateversions/{templateversion}/dry-run/{jobID} \
  -H 'Accept: application/json' \
  -H 'Coder-Session-Token: API_KEY'

GET /api/v2/templateversions/{templateversion}/dry-run/{jobID}

Parameters

Name	In	Type	Required	Description
`templateversion`	path	string(uuid)	true	Template version ID
`jobID`	path	string(uuid)	true	Job ID

Example responses

{
  "available_workers": [
    "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  ],
  "canceled_at": "2019-08-24T14:15:22Z",
  "completed_at": "2019-08-24T14:15:22Z",
  "created_at": "2019-08-24T14:15:22Z",
  "error": "string",
  "error_code": "REQUIRED_TEMPLATE_VARIABLES",
  "file_id": "8a0cfb4f-ddc9-436d-91bb-75133c583767",
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "initiator_id": "06588898-9a84-4b35-ba8f-f9cbd64946f3",
  "input": {
    "error": "string",
    "template_version_id": "0ba39c92-1f1b-4c32-aa3e-9925d7713eb1",
    "workspace_build_id": "badaf2eb-96c5-4050-9f1d-db2d39ca5478"
  },
  "logs_overflowed": true,
  "metadata": {
    "template_display_name": "string",
    "template_icon": "string",
    "template_id": "c6d67e98-83ea-49f0-8812-e4abae2b68bc",
    "template_name": "string",
    "template_version_name": "string",
    "workspace_build_transition": "start",
    "workspace_id": "0967198e-ec7b-4c6b-b4d3-f71244cadbe9",
    "workspace_name": "string"
  },
  "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
  "queue_position": 0,
  "queue_size": 0,
  "started_at": "2019-08-24T14:15:22Z",
  "status": "pending",
  "tags": {
    "property1": "string",
    "property2": "string"
  },
  "type": "template_version_import",
  "worker_id": "ae5fa6f7-c55b-40c1-b40a-b36ac467652b",
  "worker_name": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	codersdk.ProvisionerJob

To perform this operation, you must be authenticated. Learn more.

Cancel template version dry-run by job ID

Code samples

# Example request using curl
curl -X PATCH http://coder-server:8080/api/v2/templateversions/{templateversion}/dry-run/{jobID}/cancel \
  -H 'Accept: application/json' \
  -H 'Coder-Session-Token: API_KEY'

PATCH /api/v2/templateversions/{templateversion}/dry-run/{jobID}/cancel

Parameters

Name	In	Type	Required	Description
`jobID`	path	string(uuid)	true	Job ID
`templateversion`	path	string(uuid)	true	Template version ID

Example responses

{
  "detail": "string",
  "message": "string",
  "validations": [
    {
      "detail": "string",
      "field": "string"
    }
  ]
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	codersdk.Response

To perform this operation, you must be authenticated. Learn more.

Get template version dry-run logs by job ID

Code samples

# Example request using curl
curl -X GET http://coder-server:8080/api/v2/templateversions/{templateversion}/dry-run/{jobID}/logs \
  -H 'Accept: application/json' \
  -H 'Coder-Session-Token: API_KEY'

GET /api/v2/templateversions/{templateversion}/dry-run/{jobID}/logs

Parameters

Name	In	Type	Required	Description
`templateversion`	path	string(uuid)	true	Template version ID
`jobID`	path	string(uuid)	true	Job ID
`before`	query	integer	false	Before Unix timestamp
`after`	query	integer	false	After Unix timestamp
`follow`	query	boolean	false	Follow log stream
`format`	query	string	false	Log output format. Accepted: 'json' (default), 'text' (plain text with RFC3339 timestamps and ANSI colors). Not supported with follow=true.

Enumerated Values

Parameter	Value(s)
`format`	`json`, `text`

Example responses

[
  {
    "created_at": "2019-08-24T14:15:22Z",
    "id": 0,
    "log_level": "trace",
    "log_source": "provisioner_daemon",
    "output": "string",
    "stage": "string"
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	array of codersdk.ProvisionerJobLog

Response Schema

Status Code 200

Name	Type	Required
`[array item]`	array	false
`» created_at`	string(date-time)	false
`» id`	integer	false
`» log_level`	codersdk.LogLevel	false
`» log_source`	codersdk.LogSource	false
`» output`	string	false
`» stage`	string	false

Enumerated Values

Property	Value(s)
`log_level`	`debug`, `error`, `info`, `trace`, `warn`
`log_source`	`provisioner`, `provisioner_daemon`

To perform this operation, you must be authenticated. Learn more.

Get template version dry-run matched provisioners

Code samples

# Example request using curl
curl -X GET http://coder-server:8080/api/v2/templateversions/{templateversion}/dry-run/{jobID}/matched-provisioners \
  -H 'Accept: application/json' \
  -H 'Coder-Session-Token: API_KEY'

GET /api/v2/templateversions/{templateversion}/dry-run/{jobID}/matched-provisioners

Parameters

Name	In	Type	Required	Description
`templateversion`	path	string(uuid)	true	Template version ID
`jobID`	path	string(uuid)	true	Job ID

Example responses

{
  "available": 0,
  "count": 0,
  "most_recently_seen": "2019-08-24T14:15:22Z"
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	codersdk.MatchedProvisioners

To perform this operation, you must be authenticated. Learn more.

Get template version dry-run resources by job ID

Code samples

# Example request using curl
curl -X GET http://coder-server:8080/api/v2/templateversions/{templateversion}/dry-run/{jobID}/resources \
  -H 'Accept: application/json' \
  -H 'Coder-Session-Token: API_KEY'

GET /api/v2/templateversions/{templateversion}/dry-run/{jobID}/resources

Parameters

Name	In	Type	Required	Description
`templateversion`	path	string(uuid)	true	Template version ID
`jobID`	path	string(uuid)	true	Job ID

Example responses

[
  {
    "agents": [
      {
        "api_version": "string",
        "apps": [
          {
            "command": "string",
            "display_name": "string",
            "external": true,
            "group": "string",
            "health": "disabled",
            "healthcheck": {
              "interval": 0,
              "threshold": 0,
              "url": "string"
            },
            "hidden": true,
            "icon": "string",
            "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
            "open_in": "slim-window",
            "sharing_level": "owner",
            "slug": "string",
            "statuses": [
              {
                "agent_id": "2b1e3b65-2c04-4fa2-a2d7-467901e98978",
                "app_id": "affd1d10-9538-4fc8-9e0b-4594a28c1335",
                "created_at": "2019-08-24T14:15:22Z",
                "icon": "string",
                "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
                "message": "string",
                "needs_user_attention": true,
                "state": "working",
                "uri": "string",
                "workspace_id": "0967198e-ec7b-4c6b-b4d3-f71244cadbe9"
              }
            ],
            "subdomain": true,
            "subdomain_name": "string",
            "tooltip": "string",
            "url": "string"
          }
        ],
        "architecture": "string",
        "connection_timeout_seconds": 0,
        "created_at": "2019-08-24T14:15:22Z",
        "directory": "string",
        "disconnected_at": "2019-08-24T14:15:22Z",
        "display_apps": [
          "vscode"
        ],
        "environment_variables": {
          "property1": "string",
          "property2": "string"
        },
        "expanded_directory": "string",
        "first_connected_at": "2019-08-24T14:15:22Z",
        "health": {
          "healthy": false,
          "reason": "agent has lost connection"
        },
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "instance_id": "string",
        "last_connected_at": "2019-08-24T14:15:22Z",
        "latency": {
          "property1": {
            "latency_ms": 0,
            "preferred": true
          },
          "property2": {
            "latency_ms": 0,
            "preferred": true
          }
        },
        "lifecycle_state": "created",
        "log_sources": [
          {
            "created_at": "2019-08-24T14:15:22Z",
            "display_name": "string",
            "icon": "string",
            "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
            "workspace_agent_id": "7ad2e618-fea7-4c1a-b70a-f501566a72f1"
          }
        ],
        "logs_length": 0,
        "logs_overflowed": true,
        "metadata": [
          {
            "description": {
              "display_name": "string",
              "interval": 0,
              "key": "string",
              "script": "string",
              "timeout": 0
            },
            "result": {
              "age": 0,
              "collected_at": "2019-08-24T14:15:22Z",
              "error": "string",
              "value": "string"
            }
          }
        ],
        "name": "string",
        "operating_system": "string",
        "parent_id": {
          "uuid": "string",
          "valid": true
        },
        "ready_at": "2019-08-24T14:15:22Z",
        "resource_id": "4d5215ed-38bb-48ed-879a-fdb9ca58522f",
        "scripts": [
          {
            "cron": "string",
            "display_name": "string",
            "exit_code": 0,
            "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
            "log_path": "string",
            "log_source_id": "4197ab25-95cf-4b91-9c78-f7f2af5d353a",
            "run_on_start": true,
            "run_on_stop": true,
            "script": "string",
            "start_blocks_login": true,
            "status": "ok",
            "timeout": 0
          }
        ],
        "started_at": "2019-08-24T14:15:22Z",
        "startup_script_behavior": "blocking",
        "status": "connecting",
        "subsystems": [
          "envbox"
        ],
        "troubleshooting_url": "string",
        "updated_at": "2019-08-24T14:15:22Z",
        "version": "string"
      }
    ],
    "created_at": "2019-08-24T14:15:22Z",
    "daily_cost": 0,
    "hide": true,
    "icon": "string",
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "job_id": "453bd7d7-5355-4d6d-a38e-d9e7eb218c3f",
    "metadata": [
      {
        "key": "string",
        "sensitive": true,
        "value": "string"
      }
    ],
    "name": "string",
    "type": "string",
    "workspace_transition": "start"
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	array of codersdk.WorkspaceResource

Response Schema

Status Code 200

Name	Type	Required	Description
`[array item]`	array	false
`» agents`	array	false
`»» api_version`	string	false
`»» apps`	array	false
`»»» command`	string	false
`»»» display_name`	string	false	Display name is a friendly name for the app.
`»»» external`	boolean	false	External specifies whether the URL should be opened externally on the client or not.
`»»» group`	string	false
`»»» health`	codersdk.WorkspaceAppHealth	false
`»»» healthcheck`	codersdk.Healthcheck	false	Healthcheck specifies the configuration for checking app health.
`»»»» interval`	integer	false	Interval specifies the seconds between each health check.
`»»»» threshold`	integer	false	Threshold specifies the number of consecutive failed health checks before returning "unhealthy".
`»»»» url`	string	false	URL specifies the endpoint to check for the app health.
`»»» hidden`	boolean	false
`»»» icon`	string	false	Icon is a relative path or external URL that specifies an icon to be displayed in the dashboard.
`»»» id`	string(uuid)	false
`»»» open_in`	codersdk.WorkspaceAppOpenIn	false
`»»» sharing_level`	codersdk.WorkspaceAppSharingLevel	false
`»»» slug`	string	false	Slug is a unique identifier within the agent.
`»»» statuses`	array	false	Statuses is a list of statuses for the app.
`»»»» agent_id`	string(uuid)	false
`»»»» app_id`	string(uuid)	false
`»»»» created_at`	string(date-time)	false
`»»»» icon`	string	false	Deprecated: This field is unused and will be removed in a future version. Icon is an external URL to an icon that will be rendered in the UI.
`»»»» id`	string(uuid)	false
`»»»» message`	string	false
`»»»» needs_user_attention`	boolean	false	Deprecated: This field is unused and will be removed in a future version. NeedsUserAttention specifies whether the status needs user attention.
`»»»» state`	codersdk.WorkspaceAppStatusState	false
`»»»» uri`	string	false	Uri is the URI of the resource that the status is for. e.g. https://github.com/org/repo/pull/123 e.g. file:///path/to/file
`»»»» workspace_id`	string(uuid)	false
`»»» subdomain`	boolean	false	Subdomain denotes whether the app should be accessed via a path on the `coder server` or via a hostname-based dev URL. If this is set to true and there is no app wildcard configured on the server, the app will not be accessible in the UI.
`»»» subdomain_name`	string	false	Subdomain name is the application domain exposed on the `coder server`.
`»»» tooltip`	string	false	Tooltip is an optional markdown supported field that is displayed when hovering over workspace apps in the UI.
`»»» url`	string	false	URL is the address being proxied to inside the workspace. If external is specified, this will be opened on the client.
`»» architecture`	string	false
`»» connection_timeout_seconds`	integer	false
`»» created_at`	string(date-time)	false
`»» directory`	string	false
`»» disconnected_at`	string(date-time)	false
`»» display_apps`	array	false
`»» environment_variables`	object	false
`»»» [any property]`	string	false
`»» expanded_directory`	string	false
`»» first_connected_at`	string(date-time)	false
`»» health`	codersdk.WorkspaceAgentHealth	false	Health reports the health of the agent.
`»»» healthy`	boolean	false	Healthy is true if the agent is healthy.
`»»» reason`	string	false	Reason is a human-readable explanation of the agent's health. It is empty if Healthy is true.
`»» id`	string(uuid)	false
`»» instance_id`	string	false
`»» last_connected_at`	string(date-time)	false
`»» latency`	object	false	Latency is mapped by region name (e.g. "New York City", "Seattle").
`»»» [any property]`	codersdk.DERPRegion	false
`»»»» latency_ms`	number	false
`»»»» preferred`	boolean	false
`»» lifecycle_state`	codersdk.WorkspaceAgentLifecycle	false
`»» log_sources`	array	false
`»»» created_at`	string(date-time)	false
`»»» display_name`	string	false
`»»» icon`	string	false
`»»» id`	string(uuid)	false
`»»» workspace_agent_id`	string(uuid)	false
`»» logs_length`	integer	false
`»» logs_overflowed`	boolean	false
`»» metadata`	array	false	Metadata is only populated on the workspaces list endpoint when the request opts in with the include_agent_metadata search key, and it only carries the requested keys. The description's script is always empty here: it can be long, and list consumers want values.
`»»» description`	codersdk.WorkspaceAgentMetadataDescription	false
`»»»» display_name`	string	false
`»»»» interval`	integer	false
`»»»» key`	string	false
`»»»» script`	string	false
`»»»» timeout`	integer	false
`»»» result`	codersdk.WorkspaceAgentMetadataResult	false
`»»»» age`	integer	false	Age is the number of seconds since the metadata was collected. It is provided in addition to CollectedAt to protect against clock skew.
`»»»» collected_at`	string(date-time)	false
`»»»» error`	string	false
`»»»» value`	string	false
`»» name`	string	false
`»» operating_system`	string	false
`»» parent_id`	uuid.NullUUID	false
`»»» uuid`	string	false
`»»» valid`	boolean	false	Valid is true if UUID is not NULL
`»» ready_at`	string(date-time)	false
`»» resource_id`	string(uuid)	false
`»» scripts`	array	false
`»»» cron`	string	false
`»»» display_name`	string	false
`»»» exit_code`	integer	false
`»»» id`	string(uuid)	false
`»»» log_path`	string	false
`»»» log_source_id`	string(uuid)	false
`»»» run_on_start`	boolean	false
`»»» run_on_stop`	boolean	false
`»»» script`	string	false
`»»» start_blocks_login`	boolean	false
`»»» status`	codersdk.WorkspaceAgentScriptStatus	false
`»»» timeout`	integer	false
`»» started_at`	string(date-time)	false
`»» startup_script_behavior`	codersdk.WorkspaceAgentStartupScriptBehavior	false	Startup script behavior is a legacy field that is deprecated in favor of the `coder_script` resource. It's only referenced by old clients. Deprecated: Remove in the future!
`»» status`	codersdk.WorkspaceAgentStatus	false
`»» subsystems`	array	false
`»» troubleshooting_url`	string	false
`»» updated_at`	string(date-time)	false
`»» version`	string	false
`» created_at`	string(date-time)	false
`» daily_cost`	integer	false
`» hide`	boolean	false
`» icon`	string	false
`» id`	string(uuid)	false
`» job_id`	string(uuid)	false
`» metadata`	array	false
`»» key`	string	false
`»» sensitive`	boolean	false
`»» value`	string	false
`» name`	string	false
`» type`	string	false
`» workspace_transition`	codersdk.WorkspaceTransition	false

Enumerated Values

Property	Value(s)
`health`	`disabled`, `healthy`, `initializing`, `unhealthy`
`open_in`	`slim-window`, `tab`
`sharing_level`	`authenticated`, `organization`, `owner`, `public`
`state`	`complete`, `failure`, `idle`, `working`
`lifecycle_state`	`created`, `off`, `ready`, `shutdown_error`, `shutdown_timeout`, `shutting_down`, `start_error`, `start_timeout`, `starting`
`status`	`connected`, `connecting`, `disconnected`, `exit_failure`, `ok`, `pipes_left_open`, `timed_out`, `timeout`
`startup_script_behavior`	`blocking`, `non-blocking`
`workspace_transition`	`delete`, `start`, `stop`

To perform this operation, you must be authenticated. Learn more.

Open dynamic parameters WebSocket by template version

Code samples

# Example request using curl
curl -X GET http://coder-server:8080/api/v2/templateversions/{templateversion}/dynamic-parameters \
  -H 'Coder-Session-Token: API_KEY'

GET /api/v2/templateversions/{templateversion}/dynamic-parameters

Parameters

Name	In	Type	Required	Description
`templateversion`	path	string(uuid)	true	Template version ID

Responses

Status	Meaning	Description	Schema
101	Switching Protocols	Switching Protocols

To perform this operation, you must be authenticated. Learn more.

Evaluate dynamic parameters for template version

Code samples

# Example request using curl
curl -X POST http://coder-server:8080/api/v2/templateversions/{templateversion}/dynamic-parameters/evaluate \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Coder-Session-Token: API_KEY'

POST /api/v2/templateversions/{templateversion}/dynamic-parameters/evaluate

{
  "id": 0,
  "inputs": {
    "property1": "string",
    "property2": "string"
  },
  "owner_id": "8826ee2e-7933-4665-aef2-2393f84a0d05"
}

Parameters

Name	In	Type	Required	Description
`templateversion`	path	string(uuid)	true	Template version ID
`body`	body	codersdk.DynamicParametersRequest	true	Initial parameter values

Example responses

{
  "diagnostics": [
    {
      "detail": "string",
      "extra": {
        "code": "string"
      },
      "severity": "error",
      "summary": "string"
    }
  ],
  "id": 0,
  "parameters": [
    {
      "default_value": {
        "valid": true,
        "value": "string"
      },
      "description": "string",
      "diagnostics": [
        {
          "detail": "string",
          "extra": {
            "code": "string"
          },
          "severity": "error",
          "summary": "string"
        }
      ],
      "display_name": "string",
      "ephemeral": true,
      "form_type": "",
      "icon": "string",
      "mutable": true,
      "name": "string",
      "options": [
        {
          "description": "string",
          "icon": "string",
          "name": "string",
          "value": {
            "valid": true,
            "value": "string"
          }
        }
      ],
      "order": 0,
      "required": true,
      "styling": {
        "disabled": true,
        "label": "string",
        "mask_input": true,
        "placeholder": "string"
      },
      "type": "string",
      "validations": [
        {
          "validation_error": "string",
          "validation_max": 0,
          "validation_min": 0,
          "validation_monotonic": "string",
          "validation_regex": "string"
        }
      ],
      "value": {
        "valid": true,
        "value": "string"
      }
    }
  ]
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	codersdk.DynamicParametersResponse

To perform this operation, you must be authenticated. Learn more.

Get external auth by template version

Code samples

# Example request using curl
curl -X GET http://coder-server:8080/api/v2/templateversions/{templateversion}/external-auth \
  -H 'Accept: application/json' \
  -H 'Coder-Session-Token: API_KEY'

GET /api/v2/templateversions/{templateversion}/external-auth

Parameters

Name	In	Type	Required	Description
`templateversion`	path	string(uuid)	true	Template version ID
`user_id`	query	string(uuid)	false	Owner to report external auth state for. Defaults to the requesting user.

Example responses

[
  {
    "authenticate_url": "string",
    "authenticated": true,
    "display_icon": "string",
    "display_name": "string",
    "id": "string",
    "optional": true,
    "type": "string"
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	array of codersdk.TemplateVersionExternalAuth

Response Schema

Status Code 200

Name	Type	Required
`[array item]`	array	false
`» authenticate_url`	string	false
`» authenticated`	boolean	false
`» display_icon`	string	false
`» display_name`	string	false
`» id`	string	false
`» optional`	boolean	false
`» type`	string	false

To perform this operation, you must be authenticated. Learn more.

Get logs by template version

Code samples

# Example request using curl
curl -X GET http://coder-server:8080/api/v2/templateversions/{templateversion}/logs \
  -H 'Accept: application/json' \
  -H 'Coder-Session-Token: API_KEY'

GET /api/v2/templateversions/{templateversion}/logs

Parameters

Name	In	Type	Required	Description
`templateversion`	path	string(uuid)	true	Template version ID
`before`	query	integer	false	Before log id
`after`	query	integer	false	After log id
`follow`	query	boolean	false	Follow log stream
`format`	query	string	false	Log output format. Accepted: 'json' (default), 'text' (plain text with RFC3339 timestamps and ANSI colors). Not supported with follow=true.

Enumerated Values

Parameter	Value(s)
`format`	`json`, `text`

Example responses

[
  {
    "created_at": "2019-08-24T14:15:22Z",
    "id": 0,
    "log_level": "trace",
    "log_source": "provisioner_daemon",
    "output": "string",
    "stage": "string"
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	array of codersdk.ProvisionerJobLog

Response Schema

Status Code 200

Name	Type	Required
`[array item]`	array	false
`» created_at`	string(date-time)	false
`» id`	integer	false
`» log_level`	codersdk.LogLevel	false
`» log_source`	codersdk.LogSource	false
`» output`	string	false
`» stage`	string	false

Enumerated Values

Property	Value(s)
`log_level`	`debug`, `error`, `info`, `trace`, `warn`
`log_source`	`provisioner`, `provisioner_daemon`

To perform this operation, you must be authenticated. Learn more.

Removed: Get parameters by template version

Code samples

# Example request using curl
curl -X GET http://coder-server:8080/api/v2/templateversions/{templateversion}/parameters \
  -H 'Coder-Session-Token: API_KEY'

GET /api/v2/templateversions/{templateversion}/parameters

Parameters

Name	In	Type	Required	Description
`templateversion`	path	string(uuid)	true	Template version ID

Responses

Status	Meaning	Description	Schema
200	OK	OK

To perform this operation, you must be authenticated. Learn more.

Get template version presets

Code samples

# Example request using curl
curl -X GET http://coder-server:8080/api/v2/templateversions/{templateversion}/presets \
  -H 'Accept: application/json' \
  -H 'Coder-Session-Token: API_KEY'

GET /api/v2/templateversions/{templateversion}/presets

Parameters

Name	In	Type	Required	Description
`templateversion`	path	string(uuid)	true	Template version ID

Example responses

[
  {
    "default": true,
    "description": "string",
    "desiredPrebuildInstances": 0,
    "icon": "string",
    "id": "string",
    "name": "string",
    "parameters": [
      {
        "name": "string",
        "value": "string"
      }
    ]
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	array of codersdk.Preset

Response Schema

Status Code 200

Name	Type	Required
`[array item]`	array	false
`» default`	boolean	false
`» description`	string	false
`» desiredPrebuildInstances`	integer	false
`» icon`	string	false
`» id`	string	false
`» name`	string	false
`» parameters`	array	false
`»» name`	string	false
`»» value`	string	false

To perform this operation, you must be authenticated. Learn more.

Get resources by template version

Code samples

# Example request using curl
curl -X GET http://coder-server:8080/api/v2/templateversions/{templateversion}/resources \
  -H 'Accept: application/json' \
  -H 'Coder-Session-Token: API_KEY'

GET /api/v2/templateversions/{templateversion}/resources

Parameters

Name	In	Type	Required	Description
`templateversion`	path	string(uuid)	true	Template version ID

Example responses

[
  {
    "agents": [
      {
        "api_version": "string",
        "apps": [
          {
            "command": "string",
            "display_name": "string",
            "external": true,
            "group": "string",
            "health": "disabled",
            "healthcheck": {
              "interval": 0,
              "threshold": 0,
              "url": "string"
            },
            "hidden": true,
            "icon": "string",
            "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
            "open_in": "slim-window",
            "sharing_level": "owner",
            "slug": "string",
            "statuses": [
              {
                "agent_id": "2b1e3b65-2c04-4fa2-a2d7-467901e98978",
                "app_id": "affd1d10-9538-4fc8-9e0b-4594a28c1335",
                "created_at": "2019-08-24T14:15:22Z",
                "icon": "string",
                "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
                "message": "string",
                "needs_user_attention": true,
                "state": "working",
                "uri": "string",
                "workspace_id": "0967198e-ec7b-4c6b-b4d3-f71244cadbe9"
              }
            ],
            "subdomain": true,
            "subdomain_name": "string",
            "tooltip": "string",
            "url": "string"
          }
        ],
        "architecture": "string",
        "connection_timeout_seconds": 0,
        "created_at": "2019-08-24T14:15:22Z",
        "directory": "string",
        "disconnected_at": "2019-08-24T14:15:22Z",
        "display_apps": [
          "vscode"
        ],
        "environment_variables": {
          "property1": "string",
          "property2": "string"
        },
        "expanded_directory": "string",
        "first_connected_at": "2019-08-24T14:15:22Z",
        "health": {
          "healthy": false,
          "reason": "agent has lost connection"
        },
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "instance_id": "string",
        "last_connected_at": "2019-08-24T14:15:22Z",
        "latency": {
          "property1": {
            "latency_ms": 0,
            "preferred": true
          },
          "property2": {
            "latency_ms": 0,
            "preferred": true
          }
        },
        "lifecycle_state": "created",
        "log_sources": [
          {
            "created_at": "2019-08-24T14:15:22Z",
            "display_name": "string",
            "icon": "string",
            "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
            "workspace_agent_id": "7ad2e618-fea7-4c1a-b70a-f501566a72f1"
          }
        ],
        "logs_length": 0,
        "logs_overflowed": true,
        "metadata": [
          {
            "description": {
              "display_name": "string",
              "interval": 0,
              "key": "string",
              "script": "string",
              "timeout": 0
            },
            "result": {
              "age": 0,
              "collected_at": "2019-08-24T14:15:22Z",
              "error": "string",
              "value": "string"
            }
          }
        ],
        "name": "string",
        "operating_system": "string",
        "parent_id": {
          "uuid": "string",
          "valid": true
        },
        "ready_at": "2019-08-24T14:15:22Z",
        "resource_id": "4d5215ed-38bb-48ed-879a-fdb9ca58522f",
        "scripts": [
          {
            "cron": "string",
            "display_name": "string",
            "exit_code": 0,
            "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
            "log_path": "string",
            "log_source_id": "4197ab25-95cf-4b91-9c78-f7f2af5d353a",
            "run_on_start": true,
            "run_on_stop": true,
            "script": "string",
            "start_blocks_login": true,
            "status": "ok",
            "timeout": 0
          }
        ],
        "started_at": "2019-08-24T14:15:22Z",
        "startup_script_behavior": "blocking",
        "status": "connecting",
        "subsystems": [
          "envbox"
        ],
        "troubleshooting_url": "string",
        "updated_at": "2019-08-24T14:15:22Z",
        "version": "string"
      }
    ],
    "created_at": "2019-08-24T14:15:22Z",
    "daily_cost": 0,
    "hide": true,
    "icon": "string",
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "job_id": "453bd7d7-5355-4d6d-a38e-d9e7eb218c3f",
    "metadata": [
      {
        "key": "string",
        "sensitive": true,
        "value": "string"
      }
    ],
    "name": "string",
    "type": "string",
    "workspace_transition": "start"
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	array of codersdk.WorkspaceResource

Response Schema

Status Code 200

Name	Type	Required	Description
`[array item]`	array	false
`» agents`	array	false
`»» api_version`	string	false
`»» apps`	array	false
`»»» command`	string	false
`»»» display_name`	string	false	Display name is a friendly name for the app.
`»»» external`	boolean	false	External specifies whether the URL should be opened externally on the client or not.
`»»» group`	string	false
`»»» health`	codersdk.WorkspaceAppHealth	false
`»»» healthcheck`	codersdk.Healthcheck	false	Healthcheck specifies the configuration for checking app health.
`»»»» interval`	integer	false	Interval specifies the seconds between each health check.
`»»»» threshold`	integer	false	Threshold specifies the number of consecutive failed health checks before returning "unhealthy".
`»»»» url`	string	false	URL specifies the endpoint to check for the app health.
`»»» hidden`	boolean	false
`»»» icon`	string	false	Icon is a relative path or external URL that specifies an icon to be displayed in the dashboard.
`»»» id`	string(uuid)	false
`»»» open_in`	codersdk.WorkspaceAppOpenIn	false
`»»» sharing_level`	codersdk.WorkspaceAppSharingLevel	false
`»»» slug`	string	false	Slug is a unique identifier within the agent.
`»»» statuses`	array	false	Statuses is a list of statuses for the app.
`»»»» agent_id`	string(uuid)	false
`»»»» app_id`	string(uuid)	false
`»»»» created_at`	string(date-time)	false
`»»»» icon`	string	false	Deprecated: This field is unused and will be removed in a future version. Icon is an external URL to an icon that will be rendered in the UI.
`»»»» id`	string(uuid)	false
`»»»» message`	string	false
`»»»» needs_user_attention`	boolean	false	Deprecated: This field is unused and will be removed in a future version. NeedsUserAttention specifies whether the status needs user attention.
`»»»» state`	codersdk.WorkspaceAppStatusState	false
`»»»» uri`	string	false	Uri is the URI of the resource that the status is for. e.g. https://github.com/org/repo/pull/123 e.g. file:///path/to/file
`»»»» workspace_id`	string(uuid)	false
`»»» subdomain`	boolean	false	Subdomain denotes whether the app should be accessed via a path on the `coder server` or via a hostname-based dev URL. If this is set to true and there is no app wildcard configured on the server, the app will not be accessible in the UI.
`»»» subdomain_name`	string	false	Subdomain name is the application domain exposed on the `coder server`.
`»»» tooltip`	string	false	Tooltip is an optional markdown supported field that is displayed when hovering over workspace apps in the UI.
`»»» url`	string	false	URL is the address being proxied to inside the workspace. If external is specified, this will be opened on the client.
`»» architecture`	string	false
`»» connection_timeout_seconds`	integer	false
`»» created_at`	string(date-time)	false
`»» directory`	string	false
`»» disconnected_at`	string(date-time)	false
`»» display_apps`	array	false
`»» environment_variables`	object	false
`»»» [any property]`	string	false
`»» expanded_directory`	string	false
`»» first_connected_at`	string(date-time)	false
`»» health`	codersdk.WorkspaceAgentHealth	false	Health reports the health of the agent.
`»»» healthy`	boolean	false	Healthy is true if the agent is healthy.
`»»» reason`	string	false	Reason is a human-readable explanation of the agent's health. It is empty if Healthy is true.
`»» id`	string(uuid)	false
`»» instance_id`	string	false
`»» last_connected_at`	string(date-time)	false
`»» latency`	object	false	Latency is mapped by region name (e.g. "New York City", "Seattle").
`»»» [any property]`	codersdk.DERPRegion	false
`»»»» latency_ms`	number	false
`»»»» preferred`	boolean	false
`»» lifecycle_state`	codersdk.WorkspaceAgentLifecycle	false
`»» log_sources`	array	false
`»»» created_at`	string(date-time)	false
`»»» display_name`	string	false
`»»» icon`	string	false
`»»» id`	string(uuid)	false
`»»» workspace_agent_id`	string(uuid)	false
`»» logs_length`	integer	false
`»» logs_overflowed`	boolean	false
`»» metadata`	array	false	Metadata is only populated on the workspaces list endpoint when the request opts in with the include_agent_metadata search key, and it only carries the requested keys. The description's script is always empty here: it can be long, and list consumers want values.
`»»» description`	codersdk.WorkspaceAgentMetadataDescription	false
`»»»» display_name`	string	false
`»»»» interval`	integer	false
`»»»» key`	string	false
`»»»» script`	string	false
`»»»» timeout`	integer	false
`»»» result`	codersdk.WorkspaceAgentMetadataResult	false
`»»»» age`	integer	false	Age is the number of seconds since the metadata was collected. It is provided in addition to CollectedAt to protect against clock skew.
`»»»» collected_at`	string(date-time)	false
`»»»» error`	string	false
`»»»» value`	string	false
`»» name`	string	false
`»» operating_system`	string	false
`»» parent_id`	uuid.NullUUID	false
`»»» uuid`	string	false
`»»» valid`	boolean	false	Valid is true if UUID is not NULL
`»» ready_at`	string(date-time)	false
`»» resource_id`	string(uuid)	false
`»» scripts`	array	false
`»»» cron`	string	false
`»»» display_name`	string	false
`»»» exit_code`	integer	false
`»»» id`	string(uuid)	false
`»»» log_path`	string	false
`»»» log_source_id`	string(uuid)	false
`»»» run_on_start`	boolean	false
`»»» run_on_stop`	boolean	false
`»»» script`	string	false
`»»» start_blocks_login`	boolean	false
`»»» status`	codersdk.WorkspaceAgentScriptStatus	false
`»»» timeout`	integer	false
`»» started_at`	string(date-time)	false
`»» startup_script_behavior`	codersdk.WorkspaceAgentStartupScriptBehavior	false	Startup script behavior is a legacy field that is deprecated in favor of the `coder_script` resource. It's only referenced by old clients. Deprecated: Remove in the future!
`»» status`	codersdk.WorkspaceAgentStatus	false
`»» subsystems`	array	false
`»» troubleshooting_url`	string	false
`»» updated_at`	string(date-time)	false
`»» version`	string	false
`» created_at`	string(date-time)	false
`» daily_cost`	integer	false
`» hide`	boolean	false
`» icon`	string	false
`» id`	string(uuid)	false
`» job_id`	string(uuid)	false
`» metadata`	array	false
`»» key`	string	false
`»» sensitive`	boolean	false
`»» value`	string	false
`» name`	string	false
`» type`	string	false
`» workspace_transition`	codersdk.WorkspaceTransition	false

Enumerated Values

Property	Value(s)
`health`	`disabled`, `healthy`, `initializing`, `unhealthy`
`open_in`	`slim-window`, `tab`
`sharing_level`	`authenticated`, `organization`, `owner`, `public`
`state`	`complete`, `failure`, `idle`, `working`
`lifecycle_state`	`created`, `off`, `ready`, `shutdown_error`, `shutdown_timeout`, `shutting_down`, `start_error`, `start_timeout`, `starting`
`status`	`connected`, `connecting`, `disconnected`, `exit_failure`, `ok`, `pipes_left_open`, `timed_out`, `timeout`
`startup_script_behavior`	`blocking`, `non-blocking`
`workspace_transition`	`delete`, `start`, `stop`

To perform this operation, you must be authenticated. Learn more.

Get rich parameters by template version

Code samples

# Example request using curl
curl -X GET http://coder-server:8080/api/v2/templateversions/{templateversion}/rich-parameters \
  -H 'Accept: application/json' \
  -H 'Coder-Session-Token: API_KEY'

GET /api/v2/templateversions/{templateversion}/rich-parameters

Parameters

Name	In	Type	Required	Description
`templateversion`	path	string(uuid)	true	Template version ID

Example responses

[
  {
    "default_value": "string",
    "description": "string",
    "description_plaintext": "string",
    "display_name": "string",
    "ephemeral": true,
    "form_type": "",
    "icon": "string",
    "mutable": true,
    "name": "string",
    "options": [
      {
        "description": "string",
        "icon": "string",
        "name": "string",
        "value": "string"
      }
    ],
    "required": true,
    "type": "string",
    "validation_error": "string",
    "validation_max": 0,
    "validation_min": 0,
    "validation_monotonic": "increasing",
    "validation_regex": "string"
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	array of codersdk.TemplateVersionParameter

Response Schema

Status Code 200

Name	Type	Required	Description
`[array item]`	array	false
`» default_value`	string	false
`» description`	string	false
`» description_plaintext`	string	false
`» display_name`	string	false
`» ephemeral`	boolean	false
`» form_type`	string	false	Form type has an enum value of empty string, `""`. Keep the leading comma in the enums struct tag.
`» icon`	string	false
`» mutable`	boolean	false
`» name`	string	false
`» options`	array	false
`»» description`	string	false
`»» icon`	string	false
`»» name`	string	false
`»» value`	string	false
`» required`	boolean	false
`» type`	string	false
`» validation_error`	string	false
`» validation_max`	integer	false
`» validation_min`	integer	false
`» validation_monotonic`	codersdk.ValidationMonotonicOrder	false
`» validation_regex`	string	false

Enumerated Values

Property	Value(s)
`form_type`	``, `checkbox`, `dropdown`, `error`, `input`, `multi-select`, `radio`, `slider`, `switch`, `tag-select`, `textarea`
`type`	`bool`, `list(string)`, `number`, `string`
`validation_monotonic`	`decreasing`, `increasing`

To perform this operation, you must be authenticated. Learn more.

Removed: Get schema by template version

Code samples

# Example request using curl
curl -X GET http://coder-server:8080/api/v2/templateversions/{templateversion}/schema \
  -H 'Coder-Session-Token: API_KEY'

GET /api/v2/templateversions/{templateversion}/schema

Parameters

Name	In	Type	Required	Description
`templateversion`	path	string(uuid)	true	Template version ID

Responses

Status	Meaning	Description	Schema
200	OK	OK

To perform this operation, you must be authenticated. Learn more.

Unarchive template version

Code samples

# Example request using curl
curl -X POST http://coder-server:8080/api/v2/templateversions/{templateversion}/unarchive \
  -H 'Accept: application/json' \
  -H 'Coder-Session-Token: API_KEY'

POST /api/v2/templateversions/{templateversion}/unarchive

Parameters

Name	In	Type	Required	Description
`templateversion`	path	string(uuid)	true	Template version ID

Example responses

{
  "detail": "string",
  "message": "string",
  "validations": [
    {
      "detail": "string",
      "field": "string"
    }
  ]
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	codersdk.Response

To perform this operation, you must be authenticated. Learn more.

Get template variables by template version

Code samples

# Example request using curl
curl -X GET http://coder-server:8080/api/v2/templateversions/{templateversion}/variables \
  -H 'Accept: application/json' \
  -H 'Coder-Session-Token: API_KEY'

GET /api/v2/templateversions/{templateversion}/variables

Parameters

Name	In	Type	Required	Description
`templateversion`	path	string(uuid)	true	Template version ID

Example responses

[
  {
    "default_value": "string",
    "description": "string",
    "name": "string",
    "required": true,
    "sensitive": true,
    "type": "string",
    "value": "string"
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	array of codersdk.TemplateVersionVariable

Response Schema

Status Code 200

Name	Type	Required
`[array item]`	array	false
`» default_value`	string	false
`» description`	string	false
`» name`	string	false
`» required`	boolean	false
`» sensitive`	boolean	false
`» type`	string	false
`» value`	string	false

Enumerated Values

Property	Value(s)
`type`	`bool`, `number`, `string`

To perform this operation, you must be authenticated. Learn more.

260 KiB Generated Raw Blame History

Get templates by organization

Code samples

Parameters

Example responses

Responses

Response Schema

Enumerated Values

Create template by organization

Code samples

Parameters

Example responses

Responses

Get template examples by organization

Code samples

Parameters

Example responses

Responses

Response Schema

Get templates by organization and template name

Code samples

Parameters

Example responses

Responses

Get template version by organization, template, and name

Code samples

Parameters

Example responses

Responses

Get previous template version by organization, template, and name

Code samples

Parameters

Example responses

Responses

Create template version by organization

Code samples

Parameters

Example responses

Responses

Get all templates

Code samples

Example responses

Responses

Response Schema

Enumerated Values

Get template examples

Code samples

Example responses

Responses

Response Schema

Get template settings by ID

Code samples

Parameters

Example responses

Responses

Delete template by ID

Code samples

Parameters

Example responses

Responses

Update template settings by ID

Code samples

Parameters

Example responses

Responses

Get template DAUs by ID

Code samples

Parameters

Example responses

Responses

List template versions by template ID

Code samples

Parameters

Example responses

Responses

Response Schema

Enumerated Values

Update active template version by template ID

Code samples

Parameters

260 KiB

Generated

Raw Blame History