synced/coder
1
0
Fork 0
mirror of https://github.com/coder/coder.git synced 2025-07-12 00:14:10 +00:00
Code Issues Packages Projects Releases Wiki Activity

chore: adopt markdownlint and markdown-table-formatter for *.md (#15831)

Browse Source 
Co-authored-by: Edward Angert <EdwardAngert@users.noreply.github.com>
This commit is contained in:
Muhammad Atif Ali
2025-01-03 18:12:59 +05:00
committed by GitHub
parent 08463c27d8
commit 94f5d52fdc
255 changed files with 18279 additions and 16786 deletions
Download Patch File Download Diff File Expand all files Collapse all files

45
.github/workflows/docs-ci.yaml vendored Normal file
View File

@ -0,0 +1,45 @@
name: Docs CI
on:
push:
branches:
- main
paths:
- "docs/**"
- "**.md"
- ".github/workflows/docs-ci.yaml"
pull_request:
paths:
- "docs/**"
- "**.md"
- ".github/workflows/docs-ci.yaml"
jobs:
docs:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@eef61447b9ff4aafe5dcd4e0bbf5d482be7e7871 # v4.2.1
- name: Setup Node
uses: ./.github/actions/setup-node
- uses: tj-actions/changed-files@bab30c2299617f6615ec02a68b9a40d10bd21366 # v45.0.5
id: changed-files
with:
files: |
docs/**
**.md
separator: ","
- name: lint
if: steps.changed-files.outputs.any_changed == 'true'
run: |
pnpm exec markdownlint-cli2 ${{ steps.changed-files.outputs.all_changed_files }}
- name: fmt
if: steps.changed-files.outputs.any_changed == 'true'
run: |
# markdown-table-formatter requires a space separated list of files
echo ${{ steps.changed-files.outputs.all_changed_files }} | tr ',' '\n' | pnpm exec markdown-table-formatter --check

31
.markdownlint.jsonc Normal file
View File

@ -0,0 +1,31 @@
// Example markdownlint configuration with all properties set to their default value
{
"MD010": { "spaces_per_tab": 4}, // No hard tabs: we use 4 spaces per tab
"MD013": false, // Line length: we are not following a strict line lnegth in markdown files
"MD024": { "siblings_only": true }, // Multiple headings with the same content:
"MD033": false, // Inline HTML: we use it in some places
"MD034": false, // Bare URL: we use it in some places in generated docs e.g.
// codersdk/deployment.go L597, L1177, L2287, L2495, L2533
// codersdk/workspaceproxy.go L196, L200-L201
// coderd/tracing/exporter.go L26
// cli/exp_scaletest.go L-9
"MD041": false, // First line in file should be a top level heading: All of our changelogs do not start with a top level heading
// TODO: We need to update /home/coder/repos/coder/coder/scripts/release/generate_release_notes.sh to generate changelogs that follow this rule
"MD052": false, // Image reference: Not a valid reference in generated docs
// docs/reference/cli/server.md L628
"MD055": false, // Table pipe style: Some of the generated tables do not have ending pipes
// docs/reference/api/schema.md
// docs/reference/api/templates.md
// docs/reference/cli/server.md
"MD056": false // Table column count: Some of the auto-generated tables have issues. TODO: This is probably because of splitting cell content to multiple lines.
// docs/reference/api/schema.md
// docs/reference/api/templates.md
}

96
.prettierignore
View File

@ -1,96 +0,0 @@
# Code generated by Makefile (.gitignore .prettierignore.include). DO NOT EDIT.
# .gitignore:
# Common ignore patterns, these rules applies in both root and subdirectories.
.DS_Store
.eslintcache
.gitpod.yml
.idea
**/*.swp
gotests.coverage
gotests.xml
gotests_stats.json
gotests.json
node_modules/
vendor/
yarn-error.log
# VSCode settings.
**/.vscode/*
# Allow VSCode recommendations and default settings in project root.
!/.vscode/extensions.json
!/.vscode/settings.json
# Allow code snippets
!/.vscode/*.code-snippets
# Front-end ignore patterns.
.next/
site/build-storybook.log
site/coverage/
site/storybook-static/
site/test-results/*
site/e2e/test-results/*
site/e2e/states/*.json
site/e2e/.auth.json
site/playwright-report/*
site/.swc
# Make target for updating golden files (any dir).
.gen-golden
# Build
build/
dist/
out/
# Bundle analysis
site/stats/
*.tfstate
*.tfstate.backup
*.tfplan
*.lock.hcl
.terraform/
**/.coderv2/*
**/__debug_bin
# direnv
.envrc
*.test
# Loadtesting
./scaletest/terraform/.terraform
./scaletest/terraform/.terraform.lock.hcl
scaletest/terraform/secrets.tfvars
.terraform.tfstate.*
# Nix
result
# Data dumps from unit tests
**/*.test.sql
# Filebrowser.db
**/filebrowser.db
# pnpm
.pnpm-store/
# Zed
.zed_server
# .prettierignore.include:
# Helm templates contain variables that are invalid YAML and can't be formatted
# by Prettier.
helm/**/templates/*.yaml
# Testdata shouldn't be formatted.
testdata/
# Ignore generated files
**/pnpm-lock.yaml
**/*.gen.json
# Everything in site/ is formatted by Biome. For the rest of the repo though, we
# need broader language support.
site/

14
.prettierignore.include
View File

@ -1,14 +0,0 @@
# Helm templates contain variables that are invalid YAML and can't be formatted
# by Prettier.
helm/**/templates/*.yaml
# Testdata shouldn't be formatted.
testdata/
# Ignore generated files
**/pnpm-lock.yaml
**/*.gen.json
# Everything in site/ is formatted by Biome. For the rest of the repo though, we
# need broader language support.
site/

14
.vscode/extensions.json vendored
View File

@ -1,16 +1,16 @@
{ {
"recommendations": [ "recommendations": [
"biomejs.biome",
"bradlc.vscode-tailwindcss",
"DavidAnson.vscode-markdownlint",
"EditorConfig.EditorConfig",
"emeraldwalk.runonsave",
"foxundermoon.shell-format",
"github.vscode-codeql", "github.vscode-codeql",
"golang.go", "golang.go",
"hashicorp.terraform", "hashicorp.terraform",
"esbenp.prettier-vscode",
"foxundermoon.shell-format",
"emeraldwalk.runonsave",
"zxh404.vscode-proto3",
"redhat.vscode-yaml", "redhat.vscode-yaml",
"tekumara.typos-vscode", "tekumara.typos-vscode",
"EditorConfig.EditorConfig", "zxh404.vscode-proto3"
"biomejs.biome",
"bradlc.vscode-tailwindcss"
] ]
} }

3
CODE_OF_CONDUCT.md
View File

@ -1 +1,2 @@
[https://coder.com/docs/coder-oss/latest/contributing/CODE_OF_CONDUCT](https://coder.com/docs/contributing/CODE_OF_CONDUCT) <!-- markdownlint-disable MD041 -->
[https://coder.com/docs/contributing/CODE_OF_CONDUCT](https://coder.com/docs/contributing/CODE_OF_CONDUCT)

3
CONTRIBUTING.md
View File

@ -1 +1,2 @@
https://coder.com/docs/CONTRIBUTING <!-- markdownlint-disable MD041 -->
[https://coder.com/docs/CONTRIBUTING](https://coder.com/docs/CONTRIBUTING)

67
Makefile
View File

@ -414,7 +414,7 @@ BOLD := $(shell tput bold 2>/dev/null)
GREEN := $(shell tput setaf 2 2>/dev/null) GREEN := $(shell tput setaf 2 2>/dev/null)
RESET := $(shell tput sgr0 2>/dev/null) RESET := $(shell tput sgr0 2>/dev/null)
fmt: fmt/ts fmt/go fmt/terraform fmt/shfmt fmt/prettier fmt: fmt/ts fmt/go fmt/terraform fmt/shfmt fmt/biome fmt/markdown
.PHONY: fmt .PHONY: fmt
fmt/go: fmt/go:
@ -438,15 +438,16 @@ else
endif endif
.PHONY: fmt/ts .PHONY: fmt/ts
fmt/prettier: .prettierignore fmt/biome:
echo "$(GREEN)==>$(RESET) $(BOLD)fmt/prettier$(RESET)" echo "$(GREEN)==>$(RESET) $(BOLD)fmt/biome$(RESET)"
cd site
# Avoid writing files in CI to reduce file write activity # Avoid writing files in CI to reduce file write activity
ifdef CI ifdef CI
pnpm run format:check pnpm run format:check
else else
pnpm run format pnpm run format
endif endif
.PHONY: fmt/prettier .PHONY: fmt/biome
fmt/terraform: $(wildcard *.tf) fmt/terraform: $(wildcard *.tf)
echo "$(GREEN)==>$(RESET) $(BOLD)fmt/terraform$(RESET)" echo "$(GREEN)==>$(RESET) $(BOLD)fmt/terraform$(RESET)"
@ -463,7 +464,13 @@ else
endif endif
.PHONY: fmt/shfmt .PHONY: fmt/shfmt
lint: lint/shellcheck lint/go lint/ts lint/examples lint/helm lint/site-icons fmt/markdown:
echo "$(GREEN)==>$(RESET) $(BOLD)fmt/markdown$(RESET)"
./scripts/pnpm_install.sh
pnpm format-docs
.PHONY: fmt/markdown
lint: lint/shellcheck lint/go lint/ts lint/examples lint/helm lint/site-icons lint/markdown
.PHONY: lint .PHONY: lint
lint/site-icons: lint/site-icons:
@ -497,6 +504,11 @@ lint/helm:
make lint make lint
.PHONY: lint/helm .PHONY: lint/helm
lint/markdown:
./scripts/pnpm_install.sh
pnpm lint-docs
.PHONY: lint/markdown
# All files generated by the database should be added here, and this can be used # All files generated by the database should be added here, and this can be used
# as a target for jobs that need to run after the database is generated. # as a target for jobs that need to run after the database is generated.
DB_GEN_FILES := \ DB_GEN_FILES := \
@ -530,8 +542,6 @@ GEN_FILES := \
docs/reference/cli/index.md \ docs/reference/cli/index.md \
docs/admin/security/audit-logs.md \ docs/admin/security/audit-logs.md \
coderd/apidoc/swagger.json \ coderd/apidoc/swagger.json \
.prettierignore.include \
.prettierignore \
provisioner/terraform/testdata/version \ provisioner/terraform/testdata/version \
site/e2e/provisionerGenerated.ts \ site/e2e/provisionerGenerated.ts \
site/src/theme/icons.json \ site/src/theme/icons.json \
@ -566,8 +576,6 @@ gen/mark-fresh:
docs/reference/cli/index.md \ docs/reference/cli/index.md \
docs/admin/security/audit-logs.md \ docs/admin/security/audit-logs.md \
coderd/apidoc/swagger.json \ coderd/apidoc/swagger.json \
.prettierignore.include \
.prettierignore \
site/e2e/provisionerGenerated.ts \ site/e2e/provisionerGenerated.ts \
site/src/theme/icons.json \ site/src/theme/icons.json \
examples/examples.gen.json \ examples/examples.gen.json \
@ -648,6 +656,9 @@ vpn/vpn.pb.go: vpn/vpn.proto
site/src/api/typesGenerated.ts: $(wildcard scripts/apitypings/*) $(shell find ./codersdk $(FIND_EXCLUSIONS) -type f -name '*.go') site/src/api/typesGenerated.ts: $(wildcard scripts/apitypings/*) $(shell find ./codersdk $(FIND_EXCLUSIONS) -type f -name '*.go')
# -C sets the directory for the go run command # -C sets the directory for the go run command
go run -C ./scripts/apitypings main.go > $@ go run -C ./scripts/apitypings main.go > $@
cd site
../scripts/pnpm_install.sh
pnpm exec biome format --write src/api/typesGenerated.ts
site/e2e/provisionerGenerated.ts: provisionerd/proto/provisionerd.pb.go provisionersdk/proto/provisioner.pb.go site/e2e/provisionerGenerated.ts: provisionerd/proto/provisionerd.pb.go provisionersdk/proto/provisioner.pb.go
cd site cd site
@ -656,8 +667,9 @@ site/e2e/provisionerGenerated.ts: provisionerd/proto/provisionerd.pb.go provisio
site/src/theme/icons.json: $(wildcard scripts/gensite/*) $(wildcard site/static/icon/*) site/src/theme/icons.json: $(wildcard scripts/gensite/*) $(wildcard site/static/icon/*)
go run ./scripts/gensite/ -icons "$@" go run ./scripts/gensite/ -icons "$@"
./scripts/pnpm_install.sh cd site
pnpm -C site/ exec biome format --write src/theme/icons.json ../scripts/pnpm_install.sh
pnpm exec biome format --write src/theme/icons.json
examples/examples.gen.json: scripts/examplegen/main.go examples/examples.go $(shell find ./examples/templates) examples/examples.gen.json: scripts/examplegen/main.go examples/examples.go $(shell find ./examples/templates)
go run ./scripts/examplegen/main.go > examples/examples.gen.json go run ./scripts/examplegen/main.go > examples/examples.gen.json
@ -676,29 +688,45 @@ codersdk/rbacresources_gen.go: scripts/typegen/codersdk.gotmpl scripts/typegen/m
site/src/api/rbacresourcesGenerated.ts: scripts/typegen/codersdk.gotmpl scripts/typegen/main.go coderd/rbac/object.go coderd/rbac/policy/policy.go site/src/api/rbacresourcesGenerated.ts: scripts/typegen/codersdk.gotmpl scripts/typegen/main.go coderd/rbac/object.go coderd/rbac/policy/policy.go
go run scripts/typegen/main.go rbac typescript > "$@" go run scripts/typegen/main.go rbac typescript > "$@"
cd site
../scripts/pnpm_install.sh
pnpm exec biome format --write src/api/rbacresourcesGenerated.ts
site/src/api/countriesGenerated.ts: scripts/typegen/countries.tstmpl scripts/typegen/main.go codersdk/countries.go site/src/api/countriesGenerated.ts: scripts/typegen/countries.tstmpl scripts/typegen/main.go codersdk/countries.go
go run scripts/typegen/main.go countries > "$@" go run scripts/typegen/main.go countries > "$@"
cd site
../scripts/pnpm_install.sh
pnpm exec biome format --write src/api/countriesGenerated.ts
docs/admin/integrations/prometheus.md: scripts/metricsdocgen/main.go scripts/metricsdocgen/metrics docs/admin/integrations/prometheus.md: scripts/metricsdocgen/main.go scripts/metricsdocgen/metrics
go run scripts/metricsdocgen/main.go go run scripts/metricsdocgen/main.go
./scripts/pnpm_install.sh ./scripts/pnpm_install.sh
pnpm exec prettier --write ./docs/admin/integrations/prometheus.md pnpm exec markdownlint-cli2 --fix ./docs/admin/integrations/prometheus.md
pnpm exec markdown-table-formatter ./docs/admin/integrations/prometheus.md
docs/reference/cli/index.md: scripts/clidocgen/main.go examples/examples.gen.json $(GO_SRC_FILES) docs/reference/cli/index.md: scripts/clidocgen/main.go examples/examples.gen.json $(GO_SRC_FILES)
CI=true BASE_PATH="." go run ./scripts/clidocgen CI=true BASE_PATH="." go run ./scripts/clidocgen
./scripts/pnpm_install.sh ./scripts/pnpm_install.sh
pnpm exec prettier --write ./docs/reference/cli/index.md ./docs/reference/cli/*.md ./docs/manifest.json pnpm exec markdownlint-cli2 --fix ./docs/reference/cli/*.md
pnpm exec markdown-table-formatter ./docs/reference/cli/*.md
cd site
../scripts/pnpm_install.sh
pnpm exec biome format --write ../docs/manifest.json
docs/admin/security/audit-logs.md: coderd/database/querier.go scripts/auditdocgen/main.go enterprise/audit/table.go coderd/rbac/object_gen.go docs/admin/security/audit-logs.md: coderd/database/querier.go scripts/auditdocgen/main.go enterprise/audit/table.go coderd/rbac/object_gen.go
go run scripts/auditdocgen/main.go go run scripts/auditdocgen/main.go
./scripts/pnpm_install.sh ./scripts/pnpm_install.sh
pnpm exec prettier --write ./docs/admin/security/audit-logs.md pnpm exec markdownlint-cli2 --fix ./docs/admin/security/audit-logs.md
pnpm exec markdown-table-formatter ./docs/admin/security/audit-logs.md
coderd/apidoc/swagger.json: $(shell find ./scripts/apidocgen $(FIND_EXCLUSIONS) -type f) $(wildcard coderd/*.go) $(wildcard enterprise/coderd/*.go) $(wildcard codersdk/*.go) $(wildcard enterprise/wsproxy/wsproxysdk/*.go) $(DB_GEN_FILES) .swaggo docs/manifest.json coderd/rbac/object_gen.go coderd/apidoc/swagger.json: $(shell find ./scripts/apidocgen $(FIND_EXCLUSIONS) -type f) $(wildcard coderd/*.go) $(wildcard enterprise/coderd/*.go) $(wildcard codersdk/*.go) $(wildcard enterprise/wsproxy/wsproxysdk/*.go) $(DB_GEN_FILES) .swaggo docs/manifest.json coderd/rbac/object_gen.go
./scripts/apidocgen/generate.sh ./scripts/apidocgen/generate.sh
./scripts/pnpm_install.sh ./scripts/pnpm_install.sh
pnpm exec prettier --write ./docs/reference/api ./docs/manifest.json ./coderd/apidoc/swagger.json pnpm exec markdownlint-cli2 --fix ./docs/reference/api/*.md
pnpm exec markdown-table-formatter ./docs/reference/api/*.md
cd site
../scripts/pnpm_install.sh
pnpm exec biome format --write ../docs/manifest.json ../coderd/apidoc/swagger.json
update-golden-files: \ update-golden-files: \
cli/testdata/.gen-golden \ cli/testdata/.gen-golden \
@ -769,15 +797,6 @@ provisioner/terraform/testdata/version:
fi fi
.PHONY: provisioner/terraform/testdata/version .PHONY: provisioner/terraform/testdata/version
# Combine .gitignore with .prettierignore.include to generate .prettierignore.
.prettierignore: .gitignore .prettierignore.include
echo "# Code generated by Makefile ($^). DO NOT EDIT." > "$@"
echo "" >> "$@"
for f in $^; do
echo "# $${f}:" >> "$@"
cat "$$f" >> "$@"
done
test: test:
$(GIT_FLAGS) gotestsum --format standard-quiet -- -v -short -count=1 ./... $(GIT_FLAGS) gotestsum --format standard-quiet -- -v -short -count=1 ./...
.PHONY: test .PHONY: test

15
README.md
View File

@ -1,9 +1,10 @@
<!-- markdownlint-disable MD041 -->
<div align="center"> <div align="center">
<a href="https://coder.com#gh-light-mode-only"> <a href="https://coder.com#gh-light-mode-only">
<img src="./docs/images/logo-black.png" style="width: 128px"> <img src="./docs/images/logo-black.png" alt="Coder Logo Light" style="width: 128px">
</a> </a>
<a href="https://coder.com#gh-dark-mode-only"> <a href="https://coder.com#gh-dark-mode-only">
<img src="./docs/images/logo-white.png" style="width: 128px"> <img src="./docs/images/logo-white.png" alt="Coder Logo Dark" style="width: 128px">
</a> </a>
<h1> <h1>
@ -11,10 +12,10 @@
</h1> </h1>
<a href="https://coder.com#gh-light-mode-only"> <a href="https://coder.com#gh-light-mode-only">
<img src="./docs/images/banner-black.png" style="width: 650px"> <img src="./docs/images/banner-black.png" alt="Coder Banner Light" style="width: 650px">
</a> </a>
<a href="https://coder.com#gh-dark-mode-only"> <a href="https://coder.com#gh-dark-mode-only">
<img src="./docs/images/banner-white.png" style="width: 650px"> <img src="./docs/images/banner-white.png" alt="Coder Banner Dark" style="width: 650px">
</a> </a>
<br> <br>
@ -40,14 +41,14 @@
- Onboard developers in seconds instead of days - Onboard developers in seconds instead of days
<p align="center"> <p align="center">
<img src="./docs/images/hero-image.png"> <img src="./docs/images/hero-image.png" alt="Coder Hero Image">
</p> </p>
## Quickstart ## Quickstart
The most convenient way to try Coder is to install it on your local machine and experiment with provisioning cloud development environments using Docker (works on Linux, macOS, and Windows). The most convenient way to try Coder is to install it on your local machine and experiment with provisioning cloud development environments using Docker (works on Linux, macOS, and Windows).
``` ```shell
# First, install Coder # First, install Coder
curl -L https://coder.com/install.sh | sh curl -L https://coder.com/install.sh | sh
@ -65,7 +66,7 @@ The easiest way to install Coder is to use our
and macOS. For Windows, use the latest `..._installer.exe` file from GitHub and macOS. For Windows, use the latest `..._installer.exe` file from GitHub
Releases. Releases.
```bash ```shell
curl -L https://coder.com/install.sh | sh curl -L https://coder.com/install.sh | sh
``` ```

12
SECURITY.md
View File

@ -8,7 +8,7 @@ to us, what we expect, what you can expect from us.
You can see the pretty version [here](https://coder.com/security/policy) You can see the pretty version [here](https://coder.com/security/policy)
# Why Coder's security matters ## Why Coder's security matters
If an attacker could fully compromise a Coder installation, they could spin up If an attacker could fully compromise a Coder installation, they could spin up
expensive workstations, steal valuable credentials, or steal proprietary source expensive workstations, steal valuable credentials, or steal proprietary source
@ -16,13 +16,13 @@ code. We take this risk very seriously and employ routine pen testing,
vulnerability scanning, and code reviews. We also welcome the contributions from vulnerability scanning, and code reviews. We also welcome the contributions from
the community that helped make this product possible. the community that helped make this product possible.
# Where should I report security issues? ## Where should I report security issues?
Please report security issues to security@coder.com, providing all relevant Please report security issues to <security@coder.com>, providing all relevant
information. The more details you provide, the easier it will be for us to information. The more details you provide, the easier it will be for us to
triage and fix the issue. triage and fix the issue.
# Out of Scope ## Out of Scope
Our primary concern is around an abuse of the Coder application that allows an Our primary concern is around an abuse of the Coder application that allows an
attacker to gain access to another users workspace, or spin up unwanted attacker to gain access to another users workspace, or spin up unwanted
@ -40,7 +40,7 @@ workspaces.
out-of-scope systems should be reported to the appropriate vendor or out-of-scope systems should be reported to the appropriate vendor or
applicable authority. applicable authority.
# Our Commitments ## Our Commitments
When working with us, according to this policy, you can expect us to: When working with us, according to this policy, you can expect us to:
@ -53,7 +53,7 @@ When working with us, according to this policy, you can expect us to:
- Extend Safe Harbor for your vulnerability research that is related to this - Extend Safe Harbor for your vulnerability research that is related to this
policy. policy.
# Our Expectations ## Our Expectations
In participating in our vulnerability disclosure program in good faith, we ask In participating in our vulnerability disclosure program in good faith, we ask
that you: that you:

4
cli/testdata/server-config.yaml.golden vendored
View File

@ -459,8 +459,8 @@ termsOfServiceURL: ""
# (default: ed25519, type: string) # (default: ed25519, type: string)
sshKeygenAlgorithm: ed25519 sshKeygenAlgorithm: ed25519
# URL to use for agent troubleshooting when not set in the template. # URL to use for agent troubleshooting when not set in the template.
# (default: https://coder.com/docs/templates/troubleshooting, type: url) # (default: https://coder.com/docs/admin/templates/troubleshooting, type: url)
agentFallbackTroubleshootingURL: https://coder.com/docs/templates/troubleshooting agentFallbackTroubleshootingURL: https://coder.com/docs/admin/templates/troubleshooting
# Disable workspace apps that are not served from subdomains. Path-based apps can # Disable workspace apps that are not served from subdomains. Path-based apps can
# make requests to the Coder API and pose a security risk when the workspace # make requests to the Coder API and pose a security risk when the workspace
# serves malicious JavaScript. This is recommended for security purposes if a # serves malicious JavaScript. This is recommended for security purposes if a

6
coderd/rbac/README.md
View File

@ -36,7 +36,7 @@ Both **negative** and **positive** permissions override **abstain** at the same
This can be represented by the following truth table, where Y represents _positive_, N represents _negative_, and \_ represents _abstain_: This can be represented by the following truth table, where Y represents _positive_, N represents _negative_, and \_ represents _abstain_:
| Action | Positive | Negative | Result | | Action | Positive | Negative | Result |
| ------ | -------- | -------- | ------ | |--------|----------|----------|--------|
| read | Y | \_ | Y | | read | Y | \_ | Y |
| read | Y | N | N | | read | Y | N | N |
| read | \_ | \_ | \_ | | read | \_ | \_ | \_ |
@ -66,7 +66,7 @@ The following table shows the per-level role evaluation.
Y indicates that the role provides positive permissions, N indicates the role provides negative permissions, and _indicates the role does not provide positive or negative permissions. YN_ indicates that the value in the cell does not matter for the access result. Y indicates that the role provides positive permissions, N indicates the role provides negative permissions, and _indicates the role does not provide positive or negative permissions. YN_ indicates that the value in the cell does not matter for the access result.
| Role (example) | Site | Org | User | Result | | Role (example) | Site | Org | User | Result |
| --------------- | ---- | ---- | ---- | ------ | |-----------------|------|------|------|--------|
| site-admin | Y | YN\_ | YN\_ | Y | | site-admin | Y | YN\_ | YN\_ | Y |
| no-permission | N | YN\_ | YN\_ | N | | no-permission | N | YN\_ | YN\_ | N |
| org-admin | \_ | Y | YN\_ | Y | | org-admin | \_ | Y | YN\_ | Y |
@ -102,7 +102,7 @@ Example of a scope for a workspace agent token, using an `allow_list` containing
} }
``` ```
# Testing ## Testing
You can test outside of golang by using the `opa` cli. You can test outside of golang by using the `opa` cli.

12
coderd/rbac/USAGE.md
View File

@ -1,6 +1,6 @@
# Using RBAC # Using RBAC
# Overview ## Overview
> _NOTE: you should probably read [`README.md`](README.md) beforehand, but it's > _NOTE: you should probably read [`README.md`](README.md) beforehand, but it's
> not essential._ > not essential._
@ -19,7 +19,7 @@ We have a number of roles (some of which have legacy connotations back to v1).
These can be found in `coderd/rbac/roles.go`. These can be found in `coderd/rbac/roles.go`.
| Role | Description | Example resources (non-exhaustive) | | Role | Description | Example resources (non-exhaustive) |
| -------------------- | ------------------------------------------------------------------- | -------------------------------------------- | |----------------------|---------------------------------------------------------------------|----------------------------------------------|
| **owner** | Super-user, first user in Coder installation, has all\* permissions | all\* | | **owner** | Super-user, first user in Coder installation, has all\* permissions | all\* |
| **member** | A regular user | workspaces, own details, provisioner daemons | | **member** | A regular user | workspaces, own details, provisioner daemons |
| **auditor** | Viewer of audit log events, read-only access to a few resources | audit logs, templates, users, groups | | **auditor** | Viewer of audit log events, read-only access to a few resources | audit logs, templates, users, groups |
@ -43,7 +43,7 @@ Roles are collections of permissions (we call them _actions_).
These can be found in `coderd/rbac/policy/policy.go`. These can be found in `coderd/rbac/policy/policy.go`.
| Action | Description | | Action | Description |
| ----------------------- | --------------------------------------- | |-------------------------|-----------------------------------------|
| **create** | Create a resource | | **create** | Create a resource |
| **read** | Read a resource | | **read** | Read a resource |
| **update** | Update a resource | | **update** | Update a resource |
@ -58,7 +58,7 @@ These can be found in `coderd/rbac/policy/policy.go`.
| **stop** | Stop a workspace | | **stop** | Stop a workspace |
| **assign** | Assign user to role / org | | **assign** | Assign user to role / org |
# Creating a new noun ## Creating a new noun
In the following example, we're going to create a new RBAC noun for a new entity In the following example, we're going to create a new RBAC noun for a new entity
called a "frobulator" _(just some nonsense word for demonstration purposes)_. called a "frobulator" _(just some nonsense word for demonstration purposes)_.
@ -291,7 +291,7 @@ frobulator, but no test case covered it.
**NOTE: don't just add cases which make the tests pass; consider all the ways in **NOTE: don't just add cases which make the tests pass; consider all the ways in
which your resource must be used, and test all of those scenarios!** which your resource must be used, and test all of those scenarios!**
# Database authorization ## Database authorization
Now that we have the RBAC system fully configured, we need to make use of it. Now that we have the RBAC system fully configured, we need to make use of it.
@ -350,7 +350,7 @@ before we validate (this explains the `fetchWithPostFilter` naming).
All queries are executed through `dbauthz`, and now our little frobulators are All queries are executed through `dbauthz`, and now our little frobulators are
protected! protected!
# API authorization ## API authorization
API authorization is not strictly required because we have database API authorization is not strictly required because we have database
authorization in place, but it's a good practice to reject requests as soon as authorization in place, but it's a good practice to reject requests as soon as

4
codersdk/deployment.go
View File

@ -793,7 +793,7 @@ func DefaultSupportLinks(docsURL string) []LinkConfig {
}, },
{ {
Name: "Report a bug", Name: "Report a bug",
Target: "https://github.com/coder/coder/issues/new?labels=needs+grooming&body=" + buildInfo, Target: "https://github.com/coder/coder/issues/new?labels=needs+triage&body=" + buildInfo,
Icon: "bug", Icon: "bug",
}, },
{ {
@ -2376,7 +2376,7 @@ when required by your organization's security policy.`,
Flag: "agent-fallback-troubleshooting-url", Flag: "agent-fallback-troubleshooting-url",
Env: "CODER_AGENT_FALLBACK_TROUBLESHOOTING_URL", Env: "CODER_AGENT_FALLBACK_TROUBLESHOOTING_URL",
Hidden: true, Hidden: true,
Default: "https://coder.com/docs/templates/troubleshooting", Default: "https://coder.com/docs/admin/templates/troubleshooting",
Value: &c.AgentFallbackTroubleshootingURL, Value: &c.AgentFallbackTroubleshootingURL,
YAML: "agentFallbackTroubleshootingURL", YAML: "agentFallbackTroubleshootingURL",
}, },

2
docs/CONTRIBUTING.md
View File

@ -332,7 +332,7 @@ Breaking changes can be triggered in two ways:
### Security ### Security
> If you find a vulnerability, **DO NOT FILE AN ISSUE**. Instead, send an email > If you find a vulnerability, **DO NOT FILE AN ISSUE**. Instead, send an email
> to security@coder.com. > to <security@coder.com>.
The The
[`security`](https://github.com/coder/coder/issues?q=sort%3Aupdated-desc+label%3Asecurity) [`security`](https://github.com/coder/coder/issues?q=sort%3Aupdated-desc+label%3Asecurity)

4
docs/admin/external-auth.md
View File

@ -49,7 +49,7 @@ GitHub provider).
![Adjust GitHub App Permissions](../images/admin/github-app-permissions.png) ![Adjust GitHub App Permissions](../images/admin/github-app-permissions.png)
| Name | Permission | Description | | Name | Permission | Description |
| ------------- | ------------ | ------------------------------------------------------ | |---------------|--------------|--------------------------------------------------------|
| Contents | Read & Write | Grants access to code and commit statuses. | | Contents | Read & Write | Grants access to code and commit statuses. |
| Pull requests | Read & Write | Grants access to create and update pull requests. | | Pull requests | Read & Write | Grants access to create and update pull requests. |
| Workflows | Read & Write | Grants access to update files in `.github/workflows/`. | | Workflows | Read & Write | Grants access to update files in `.github/workflows/`. |
@ -150,7 +150,7 @@ CODER_EXTERNAL_AUTH_0_AUTH_URL="https://gitea.com/login/oauth/authorize"
``` ```
The Redirect URI for Gitea should be The Redirect URI for Gitea should be
https://coder.company.org/external-auth/gitea/callback `https://coder.company.org/external-auth/gitea/callback`.
## Self-managed git providers ## Self-managed git providers

12
docs/admin/index.md
View File

@ -17,7 +17,7 @@ For any information not strictly contained in these sections, check out our
## What is an image, template, dev container, or workspace ## What is an image, template, dev container, or workspace
**Image** ### Image
- A [base image](./templates/managing-templates/image-management.md) contains - A [base image](./templates/managing-templates/image-management.md) contains
OS-level packages and utilities that the Coder workspace is built on. It can OS-level packages and utilities that the Coder workspace is built on. It can
@ -26,28 +26,28 @@ For any information not strictly contained in these sections, check out our
defined in each template. defined in each template.
- Managed by: Externally to Coder. - Managed by: Externally to Coder.
**Template** ### Template
- [Templates](./templates/index.md) include infrastructure-level dependencies - [Templates](./templates/index.md) include infrastructure-level dependencies
for the workspace. For example, a template can include Kubernetes for the workspace. For example, a template can include Kubernetes
PersistentVolumeClaims, Docker containers, or EC2 VMs. PersistentVolumeClaims, Docker containers, or EC2 VMs.
- Managed by: Template administrators from within the Coder deployment. - Managed by: Template administrators from within the Coder deployment.
**Startup scripts** ### Startup scripts
- Agent startup scripts apply to all users of a template. This is an - Agent startup scripts apply to all users of a template. This is an
intentionally flexible area that template authors have at their disposal to intentionally flexible area that template authors have at their disposal to
manage the "last mile" of workspace creation. manage the "last mile" of workspace creation.
- Managed by: Coder template administrators. - Managed by: Coder template administrators.
**Workspace** ### Workspace
- A [workspace](../user-guides/workspace-management.md) is the environment that - A [workspace](../user-guides/workspace-management.md) is the environment that
a developer works in. Developers on a team each work from their own workspace a developer works in. Developers on a team each work from their own workspace
and can use [multiple IDEs](../user-guides/workspace-access/index.md). and can use [multiple IDEs](../user-guides/workspace-access/index.md).
- Managed by: Developers - Managed by: Developers
**Development containers (dev containers)** ### Development containers (dev containers)
- A - A
[Development Container](./templates/managing-templates/devcontainers/index.md) [Development Container](./templates/managing-templates/devcontainers/index.md)
@ -57,7 +57,7 @@ For any information not strictly contained in these sections, check out our
will be built on-demand. will be built on-demand.
- Managed by: Dev Teams - Managed by: Dev Teams
**Dotfiles / personalization** ### Dotfiles / personalization
- Users may have their own specific preferences relating to shell prompt, custom - Users may have their own specific preferences relating to shell prompt, custom
keybindings, color schemes, and more. Users can leverage Coder's keybindings, color schemes, and more. Users can leverage Coder's

10
docs/admin/infrastructure/scale-testing.md
View File

@ -41,7 +41,7 @@ The scale tests runner can distribute the workload to overlap single scenarios
based on the workflow configuration: based on the workflow configuration:
| | T0 | T1 | T2 | T3 | T4 | T5 | T6 | | | T0 | T1 | T2 | T3 | T4 | T5 | T6 |
| -------------------- | --- | --- | --- | --- | --- | --- | --- | |----------------------|----|----|----|----|----|----|----|
| SSH connections | X | X | X | X | | | | | SSH connections | X | X | X | X | | | |
| Web Terminal (PTY) | | X | X | X | X | | | | Web Terminal (PTY) | | X | X | X | X | | |
| Workspace apps | | | X | X | X | X | | | Workspace apps | | | X | X | X | X | |
@ -137,7 +137,7 @@ When determining scaling requirements, consider the following factors:
connections: For a very high number of proxied connections, more memory is connections: For a very high number of proxied connections, more memory is
required. required.
**HTTP API latency** #### HTTP API latency
For a reliable Coder deployment dealing with medium to high loads, it's For a reliable Coder deployment dealing with medium to high loads, it's
important that API calls for workspace/template queries and workspace build important that API calls for workspace/template queries and workspace build
@ -152,7 +152,7 @@ between users and the load balancer. Fortunately, the latency can be improved
with a deployment of Coder with a deployment of Coder
[workspace proxies](../networking/workspace-proxies.md). [workspace proxies](../networking/workspace-proxies.md).
**Node Autoscaling** #### Node Autoscaling
We recommend disabling the autoscaling for `coderd` nodes. Autoscaling can cause We recommend disabling the autoscaling for `coderd` nodes. Autoscaling can cause
interruptions for user connections, see interruptions for user connections, see
@ -186,7 +186,7 @@ When determining scaling requirements, consider the following factors:
provisioners are free/available, the more concurrent workspace builds can be provisioners are free/available, the more concurrent workspace builds can be
performed. performed.
**Node Autoscaling** #### Node Autoscaling
Autoscaling provisioners is not an easy problem to solve unless it can be Autoscaling provisioners is not an easy problem to solve unless it can be
predicted when a number of concurrent workspace builds increases. predicted when a number of concurrent workspace builds increases.
@ -219,7 +219,7 @@ When determining scaling requirements, consider the following factors:
running Coder agent and occasional CPU and memory bursts for building running Coder agent and occasional CPU and memory bursts for building
projects. projects.
**Node Autoscaling** #### Node Autoscaling
Workspace nodes can be set to operate in autoscaling mode to mitigate the risk Workspace nodes can be set to operate in autoscaling mode to mitigate the risk
of prolonged high resource utilization. of prolonged high resource utilization.

4
docs/admin/infrastructure/scale-utility.md
View File

@ -17,7 +17,7 @@ Learn more about [Coder’s architecture](./architecture.md) and our
> hardware sizing recommendations. > hardware sizing recommendations.
| Environment | Coder CPU | Coder RAM | Coder Replicas | Database | Users | Concurrent builds | Concurrent connections (Terminal/SSH) | Coder Version | Last tested | | Environment | Coder CPU | Coder RAM | Coder Replicas | Database | Users | Concurrent builds | Concurrent connections (Terminal/SSH) | Coder Version | Last tested |
| ---------------- | --------- | --------- | -------------- | ----------------- | ----- | ----------------- | ------------------------------------- | ------------- | ------------ | |------------------|-----------|-----------|----------------|-------------------|-------|-------------------|---------------------------------------|---------------|--------------|
| Kubernetes (GKE) | 3 cores | 12 GB | 1 | db-f1-micro | 200 | 3 | 200 simulated | `v0.24.1` | Jun 26, 2023 | | Kubernetes (GKE) | 3 cores | 12 GB | 1 | db-f1-micro | 200 | 3 | 200 simulated | `v0.24.1` | Jun 26, 2023 |
| Kubernetes (GKE) | 4 cores | 8 GB | 1 | db-custom-1-3840 | 1500 | 20 | 1,500 simulated | `v0.24.1` | Jun 27, 2023 | | Kubernetes (GKE) | 4 cores | 8 GB | 1 | db-custom-1-3840 | 1500 | 20 | 1,500 simulated | `v0.24.1` | Jun 27, 2023 |
| Kubernetes (GKE) | 2 cores | 4 GB | 1 | db-custom-1-3840 | 500 | 20 | 500 simulated | `v0.27.2` | Jul 27, 2023 | | Kubernetes (GKE) | 2 cores | 4 GB | 1 | db-custom-1-3840 | 500 | 20 | 500 simulated | `v0.27.2` | Jul 27, 2023 |
@ -168,7 +168,7 @@ that operators can deploy depending on the traffic projections.
There are a few cluster options available: There are a few cluster options available:
| Workspace size | vCPU | Memory | Persisted storage | Details | | Workspace size | vCPU | Memory | Persisted storage | Details |
| -------------- | ---- | ------ | ----------------- | ----------------------------------------------------- | |----------------|------|--------|-------------------|-------------------------------------------------------|
| minimal | 1 | 2 Gi | None | | | minimal | 1 | 2 Gi | None | |
| small | 1 | 1 Gi | None | | | small | 1 | 1 Gi | None | |
| medium | 2 | 2 Gi | None | Medium-sized cluster offers the greedy agent variant. | | medium | 2 | 2 Gi | None | Medium-sized cluster offers the greedy agent variant. |

8
docs/admin/infrastructure/validated-architectures/1k-users.md
View File

@ -13,7 +13,7 @@ tech startups, educational units, or small to mid-sized enterprises.
### Coderd nodes ### Coderd nodes
| Users | Node capacity | Replicas | GCP | AWS | Azure | | Users | Node capacity | Replicas | GCP | AWS | Azure |
| ----------- | ------------------- | ------------------- | --------------- | ---------- | ----------------- | |-------------|---------------------|---------------------|-----------------|------------|-------------------|
| Up to 1,000 | 2 vCPU, 8 GB memory | 1-2 / 1 coderd each | `n1-standard-2` | `t3.large` | `Standard_D2s_v3` | | Up to 1,000 | 2 vCPU, 8 GB memory | 1-2 / 1 coderd each | `n1-standard-2` | `t3.large` | `Standard_D2s_v3` |
**Footnotes**: **Footnotes**:
@ -24,7 +24,7 @@ tech startups, educational units, or small to mid-sized enterprises.
### Provisioner nodes ### Provisioner nodes
| Users | Node capacity | Replicas | GCP | AWS | Azure | | Users | Node capacity | Replicas | GCP | AWS | Azure |
| ----------- | -------------------- | ------------------------------ | ---------------- | ------------ | ----------------- | |-------------|----------------------|--------------------------------|------------------|--------------|-------------------|
| Up to 1,000 | 8 vCPU, 32 GB memory | 2 nodes / 30 provisioners each | `t2d-standard-8` | `t3.2xlarge` | `Standard_D8s_v3` | | Up to 1,000 | 8 vCPU, 32 GB memory | 2 nodes / 30 provisioners each | `t2d-standard-8` | `t3.2xlarge` | `Standard_D8s_v3` |
**Footnotes**: **Footnotes**:
@ -34,7 +34,7 @@ tech startups, educational units, or small to mid-sized enterprises.
### Workspace nodes ### Workspace nodes
| Users | Node capacity | Replicas | GCP | AWS | Azure | | Users | Node capacity | Replicas | GCP | AWS | Azure |
| ----------- | -------------------- | ----------------------- | ---------------- | ------------ | ----------------- | |-------------|----------------------|-------------------------|------------------|--------------|-------------------|
| Up to 1,000 | 8 vCPU, 32 GB memory | 64 / 16 workspaces each | `t2d-standard-8` | `t3.2xlarge` | `Standard_D8s_v3` | | Up to 1,000 | 8 vCPU, 32 GB memory | 64 / 16 workspaces each | `t2d-standard-8` | `t3.2xlarge` | `Standard_D8s_v3` |
**Footnotes**: **Footnotes**:
@ -47,5 +47,5 @@ tech startups, educational units, or small to mid-sized enterprises.
### Database nodes ### Database nodes
| Users | Node capacity | Replicas | Storage | GCP | AWS | Azure | | Users | Node capacity | Replicas | Storage | GCP | AWS | Azure |
| ----------- | ------------------- | -------- | ------- | ------------------ | ------------- | ----------------- | |-------------|---------------------|----------|---------|--------------------|---------------|-------------------|
| Up to 1,000 | 2 vCPU, 8 GB memory | 1 | 512 GB | `db-custom-2-7680` | `db.t3.large` | `Standard_D2s_v3` | | Up to 1,000 | 2 vCPU, 8 GB memory | 1 | 512 GB | `db-custom-2-7680` | `db.t3.large` | `Standard_D2s_v3` |

8
docs/admin/infrastructure/validated-architectures/2k-users.md
View File

@ -18,13 +18,13 @@ deployment reliability under load.
### Coderd nodes ### Coderd nodes
| Users | Node capacity | Replicas | GCP | AWS | Azure | | Users | Node capacity | Replicas | GCP | AWS | Azure |
| ----------- | -------------------- | ----------------------- | --------------- | ----------- | ----------------- | |-------------|----------------------|-------------------------|-----------------|-------------|-------------------|
| Up to 2,000 | 4 vCPU, 16 GB memory | 2 nodes / 1 coderd each | `n1-standard-4` | `t3.xlarge` | `Standard_D4s_v3` | | Up to 2,000 | 4 vCPU, 16 GB memory | 2 nodes / 1 coderd each | `n1-standard-4` | `t3.xlarge` | `Standard_D4s_v3` |
### Provisioner nodes ### Provisioner nodes
| Users | Node capacity | Replicas | GCP | AWS | Azure | | Users | Node capacity | Replicas | GCP | AWS | Azure |
| ----------- | -------------------- | ------------------------------ | ---------------- | ------------ | ----------------- | |-------------|----------------------|--------------------------------|------------------|--------------|-------------------|
| Up to 2,000 | 8 vCPU, 32 GB memory | 4 nodes / 30 provisioners each | `t2d-standard-8` | `t3.2xlarge` | `Standard_D8s_v3` | | Up to 2,000 | 8 vCPU, 32 GB memory | 4 nodes / 30 provisioners each | `t2d-standard-8` | `t3.2xlarge` | `Standard_D8s_v3` |
**Footnotes**: **Footnotes**:
@ -37,7 +37,7 @@ deployment reliability under load.
### Workspace nodes ### Workspace nodes
| Users | Node capacity | Replicas | GCP | AWS | Azure | | Users | Node capacity | Replicas | GCP | AWS | Azure |
| ----------- | -------------------- | ------------------------ | ---------------- | ------------ | ----------------- | |-------------|----------------------|--------------------------|------------------|--------------|-------------------|
| Up to 2,000 | 8 vCPU, 32 GB memory | 128 / 16 workspaces each | `t2d-standard-8` | `t3.2xlarge` | `Standard_D8s_v3` | | Up to 2,000 | 8 vCPU, 32 GB memory | 128 / 16 workspaces each | `t2d-standard-8` | `t3.2xlarge` | `Standard_D8s_v3` |
**Footnotes**: **Footnotes**:
@ -50,7 +50,7 @@ deployment reliability under load.
### Database nodes ### Database nodes
| Users | Node capacity | Replicas | Storage | GCP | AWS | Azure | | Users | Node capacity | Replicas | Storage | GCP | AWS | Azure |
| ----------- | -------------------- | -------- | ------- | ------------------- | -------------- | ----------------- | |-------------|----------------------|----------|---------|---------------------|----------------|-------------------|
| Up to 2,000 | 4 vCPU, 16 GB memory | 1 | 1 TB | `db-custom-4-15360` | `db.t3.xlarge` | `Standard_D4s_v3` | | Up to 2,000 | 4 vCPU, 16 GB memory | 1 | 1 TB | `db-custom-4-15360` | `db.t3.xlarge` | `Standard_D4s_v3` |
**Footnotes**: **Footnotes**:

8
docs/admin/infrastructure/validated-architectures/3k-users.md
View File

@ -19,13 +19,13 @@ continuously improve the reliability and performance of the platform.
### Coderd nodes ### Coderd nodes
| Users | Node capacity | Replicas | GCP | AWS | Azure | | Users | Node capacity | Replicas | GCP | AWS | Azure |
| ----------- | -------------------- | ----------------- | --------------- | ----------- | ----------------- | |-------------|----------------------|-------------------|-----------------|-------------|-------------------|
| Up to 3,000 | 8 vCPU, 32 GB memory | 4 / 1 coderd each | `n1-standard-4` | `t3.xlarge` | `Standard_D4s_v3` | | Up to 3,000 | 8 vCPU, 32 GB memory | 4 / 1 coderd each | `n1-standard-4` | `t3.xlarge` | `Standard_D4s_v3` |
### Provisioner nodes ### Provisioner nodes
| Users | Node capacity | Replicas | GCP | AWS | Azure | | Users | Node capacity | Replicas | GCP | AWS | Azure |
| ----------- | -------------------- | ------------------------ | ---------------- | ------------ | ----------------- | |-------------|----------------------|--------------------------|------------------|--------------|-------------------|
| Up to 3,000 | 8 vCPU, 32 GB memory | 8 / 30 provisioners each | `t2d-standard-8` | `t3.2xlarge` | `Standard_D8s_v3` | | Up to 3,000 | 8 vCPU, 32 GB memory | 8 / 30 provisioners each | `t2d-standard-8` | `t3.2xlarge` | `Standard_D8s_v3` |
**Footnotes**: **Footnotes**:
@ -39,7 +39,7 @@ continuously improve the reliability and performance of the platform.
### Workspace nodes ### Workspace nodes
| Users | Node capacity | Replicas | GCP | AWS | Azure | | Users | Node capacity | Replicas | GCP | AWS | Azure |
| ----------- | -------------------- | ------------------------------ | ---------------- | ------------ | ----------------- | |-------------|----------------------|--------------------------------|------------------|--------------|-------------------|
| Up to 3,000 | 8 vCPU, 32 GB memory | 256 nodes / 12 workspaces each | `t2d-standard-8` | `t3.2xlarge` | `Standard_D8s_v3` | | Up to 3,000 | 8 vCPU, 32 GB memory | 256 nodes / 12 workspaces each | `t2d-standard-8` | `t3.2xlarge` | `Standard_D8s_v3` |
**Footnotes**: **Footnotes**:
@ -53,7 +53,7 @@ continuously improve the reliability and performance of the platform.
### Database nodes ### Database nodes
| Users | Node capacity | Replicas | Storage | GCP | AWS | Azure | | Users | Node capacity | Replicas | Storage | GCP | AWS | Azure |
| ----------- | -------------------- | -------- | ------- | ------------------- | --------------- | ----------------- | |-------------|----------------------|----------|---------|---------------------|-----------------|-------------------|
| Up to 3,000 | 8 vCPU, 32 GB memory | 2 | 1.5 TB | `db-custom-8-30720` | `db.t3.2xlarge` | `Standard_D8s_v3` | | Up to 3,000 | 8 vCPU, 32 GB memory | 2 | 1.5 TB | `db-custom-8-30720` | `db.t3.2xlarge` | `Standard_D8s_v3` |
**Footnotes**: **Footnotes**:

4
docs/admin/infrastructure/validated-architectures/index.md
View File

@ -23,7 +23,7 @@ This guide targets the following personas. It assumes a basic understanding of
cloud/on-premise computing, containerization, and the Coder platform. cloud/on-premise computing, containerization, and the Coder platform.
| Role | Description | | Role | Description |
| ------------------------- | ------------------------------------------------------------------------------ | |---------------------------|--------------------------------------------------------------------------------|
| Platform Engineers | Responsible for deploying, operating the Coder deployment and infrastructure | | Platform Engineers | Responsible for deploying, operating the Coder deployment and infrastructure |
| Enterprise Architects | Responsible for architecting Coder deployments to meet enterprise requirements | | Enterprise Architects | Responsible for architecting Coder deployments to meet enterprise requirements |
| Managed Service Providers | Entities that deploy and run Coder software as a service for customers | | Managed Service Providers | Entities that deploy and run Coder software as a service for customers |
@ -31,7 +31,7 @@ cloud/on-premise computing, containerization, and the Coder platform.
## CVA Guidance ## CVA Guidance
| CVA provides: | CVA does not provide: | | CVA provides: | CVA does not provide: |
| ---------------------------------------------- | ---------------------------------------------------------------------------------------- | |------------------------------------------------|------------------------------------------------------------------------------------------|
| Single and multi-region K8s deployment options | Prescribing OS, or cloud vs. on-premise | | Single and multi-region K8s deployment options | Prescribing OS, or cloud vs. on-premise |
| Reference architectures for up to 3,000 users | An approval of your architecture; the CVA solely provides recommendations and guidelines | | Reference architectures for up to 3,000 users | An approval of your architecture; the CVA solely provides recommendations and guidelines |
| Best practices for building a Coder deployment | Recommendations for every possible deployment scenario | | Best practices for building a Coder deployment | Recommendations for every possible deployment scenario |

2
docs/admin/integrations/island.md
View File

@ -3,7 +3,7 @@
<div> <div>
<a href="https://github.com/ericpaulsen" style="text-decoration: none; color: inherit;"> <a href="https://github.com/ericpaulsen" style="text-decoration: none; color: inherit;">
<span style="vertical-align:middle;">Eric Paulsen</span> <span style="vertical-align:middle;">Eric Paulsen</span>
<img src="https://github.com/ericpaulsen.png" width="24px" height="24px" style="vertical-align:middle; margin: 0px;"/> <img src="https://github.com/ericpaulsen.png" alt="ericpaulsen" width="24px" height="24px" style="vertical-align:middle; margin: 0px;"/>
</a> </a>
</div> </div>
April 24, 2024 April 24, 2024

24
docs/admin/integrations/jfrog-artifactory.md
View File

@ -3,7 +3,7 @@
<div> <div>
<a href="https://github.com/matifali" style="text-decoration: none; color: inherit;"> <a href="https://github.com/matifali" style="text-decoration: none; color: inherit;">
<span style="vertical-align:middle;">M Atif Ali</span> <span style="vertical-align:middle;">M Atif Ali</span>
<img src="https://github.com/matifali.png" width="24px" height="24px" style="vertical-align:middle; margin: 0px;"/> <img src="https://github.com/matifali.png" alt="matifali" width="24px" height="24px" style="vertical-align:middle; margin: 0px;"/>
</a> </a>
</div> </div>
January 24, 2024 January 24, 2024
@ -31,15 +31,15 @@ by using our official Coder [modules](https://registry.coder.com). We publish
two type of modules that automate the JFrog Artifactory and Coder integration. two type of modules that automate the JFrog Artifactory and Coder integration.
1. [JFrog-OAuth](https://registry.coder.com/modules/jfrog-oauth) 1. [JFrog-OAuth](https://registry.coder.com/modules/jfrog-oauth)
2. [JFrog-Token](https://registry.coder.com/modules/jfrog-token) 1. [JFrog-Token](https://registry.coder.com/modules/jfrog-token)
### JFrog-OAuth ### JFrog-OAuth
This module is usable by JFrog self-hosted (on-premises) Artifactory as it This module is usable by JFrog self-hosted (on-premises) Artifactory as it
requires configuring a custom integration. This integration benefits from requires configuring a custom integration. This integration benefits from
Coder's [external-auth](https://coder.com/docs/admin/external-auth) feature and Coder's [external-auth](../../admin/external-auth.md) feature and allows each
allows each user to authenticate with Artifactory using an OAuth flow and issues user to authenticate with Artifactory using an OAuth flow and issues user-scoped
user-scoped tokens to each user. tokens to each user.
To set this up, follow these steps: To set this up, follow these steps:
@ -65,15 +65,14 @@ artifactory:
> Note Replace `CODER_URL` with your Coder deployment URL, e.g., > Note Replace `CODER_URL` with your Coder deployment URL, e.g.,
> <coder.example.com> > <coder.example.com>
2. Create a new Application Integration by going to 1. Create a new Application Integration by going to
<https://JFROG_URL/ui/admin/configuration/integrations/new> and select the <https://JFROG_URL/ui/admin/configuration/integrations/new> and select the
Application Type as the integration you created in step 1. Application Type as the integration you created in step 1.
![JFrog Platform new integration](../../images/guides/artifactory-integration/jfrog-oauth-app.png) ![JFrog Platform new integration](../../images/guides/artifactory-integration/jfrog-oauth-app.png)
3. Add a new 1. Add a new [external authentication](../../admin/external-auth.md) to Coder by
[external authentication](https://coder.com/docs/admin/external-auth) to setting these env variables,
Coder by setting these env variables,
```env ```env
# JFrog Artifactory External Auth # JFrog Artifactory External Auth
@ -90,7 +89,7 @@ CODER_EXTERNAL_AUTH_1_SCOPES="applied-permissions/user"
> Note Replace `JFROG_URL` with your JFrog Artifactory base URL, e.g., > Note Replace `JFROG_URL` with your JFrog Artifactory base URL, e.g.,
> <example.jfrog.io> > <example.jfrog.io>
4. Create or edit a Coder template and use the 1. Create or edit a Coder template and use the
[JFrog-OAuth](https://registry.coder.com/modules/jfrog-oauth) module to [JFrog-OAuth](https://registry.coder.com/modules/jfrog-oauth) module to
configure the integration. configure the integration.
@ -123,7 +122,7 @@ To set this up, follow these steps:
1. Get a JFrog access token from your Artifactory instance. The token must be an 1. Get a JFrog access token from your Artifactory instance. The token must be an
[admin token](https://registry.terraform.io/providers/jfrog/artifactory/latest/docs#access-token) [admin token](https://registry.terraform.io/providers/jfrog/artifactory/latest/docs#access-token)
with scope `applied-permissions/admin`. with scope `applied-permissions/admin`.
2. Create or edit a Coder template and use the 1. Create or edit a Coder template and use the
[JFrog-Token](https://registry.coder.com/modules/jfrog-token) module to [JFrog-Token](https://registry.coder.com/modules/jfrog-token) module to
configure the integration and pass the admin token. It is recommended to configure the integration and pass the admin token. It is recommended to
store the token in a sensitive terraform variable to prevent it from being store the token in a sensitive terraform variable to prevent it from being
@ -151,8 +150,7 @@ module "jfrog" {
``` ```
<blockquote class="info"> <blockquote class="info">
The admin-level access token is used to provision user tokens and is never exposed to The admin-level access token is used to provision user tokens and is never exposed to developers or stored in workspaces.
developers or stored in workspaces.
</blockquote> </blockquote>
If you do not want to use the official modules, you can check example template If you do not want to use the official modules, you can check example template

3
docs/admin/integrations/jfrog-xray.md
View File

@ -3,7 +3,8 @@
<div> <div>
<a href="https://github.com/matifali" style="text-decoration: none; color: inherit;"> <a href="https://github.com/matifali" style="text-decoration: none; color: inherit;">
<span style="vertical-align:middle;">Muhammad Atif Ali</span> <span style="vertical-align:middle;">Muhammad Atif Ali</span>
<img src="https://github.com/matifali.png" width="24px" height="24px" style="vertical-align:middle; margin: 0px;"/> <img src="https://github.com/matifali.png" alt="matifali" width="24px" height="24px" style="vertical-align:middle; margin: 0px;"/>
</a> </a>
</div> </div>
March 17, 2024 March 17, 2024

2
docs/admin/integrations/prometheus.md
View File

@ -104,7 +104,7 @@ deployment. They will always be available from the agent.
<!-- Code generated by 'make docs/admin/integrations/prometheus.md'. DO NOT EDIT --> <!-- Code generated by 'make docs/admin/integrations/prometheus.md'. DO NOT EDIT -->
| Name | Type | Description | Labels | | Name | Type | Description | Labels |
| ------------------------------------------------------------- | --------- | -------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------ | |---------------------------------------------------------------|-----------|----------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------|
| `agent_scripts_executed_total` | counter | Total number of scripts executed by the Coder agent. Includes cron scheduled scripts. | `agent_name` `success` `template_name` `username` `workspace_name` | | `agent_scripts_executed_total` | counter | Total number of scripts executed by the Coder agent. Includes cron scheduled scripts. | `agent_name` `success` `template_name` `username` `workspace_name` |
| `coderd_agents_apps` | gauge | Agent applications with statuses. | `agent_name` `app_name` `health` `username` `workspace_name` | | `coderd_agents_apps` | gauge | Agent applications with statuses. | `agent_name` `app_name` `health` `username` `workspace_name` |
| `coderd_agents_connection_latencies_seconds` | gauge | Agent connection latencies in seconds. | `agent_name` `derp_region` `preferred` `username` `workspace_name` | | `coderd_agents_connection_latencies_seconds` | gauge | Agent connection latencies in seconds. | `agent_name` `derp_region` `preferred` `username` `workspace_name` |

3
docs/admin/integrations/vault.md
View File

@ -3,7 +3,8 @@
<div> <div>
<a href="https://github.com/matifali" style="text-decoration: none; color: inherit;"> <a href="https://github.com/matifali" style="text-decoration: none; color: inherit;">
<span style="vertical-align:middle;">Muhammad Atif Ali</span> <span style="vertical-align:middle;">Muhammad Atif Ali</span>
<img src="https://github.com/matifali.png" width="24px" height="24px" style="vertical-align:middle; margin: 0px;"/> <img src="https://github.com/matifali.png" alt="matifali" width="24px" height="24px" style="vertical-align:middle; margin: 0px;"/>
</a> </a>
</div> </div>
August 05, 2024 August 05, 2024

40
docs/admin/monitoring/health-check.md
View File

@ -24,7 +24,7 @@ If there is an issue, you may see one of the following errors reported:
### EACS01 ### EACS01
_Access URL not set_ ### Access URL not set
**Problem:** no access URL has been configured. **Problem:** no access URL has been configured.
@ -32,7 +32,7 @@ _Access URL not set_
### EACS02 ### EACS02
_Access URL invalid_ #### Access URL invalid
**Problem:** `${CODER_ACCESS_URL}/healthz` is not a valid URL. **Problem:** `${CODER_ACCESS_URL}/healthz` is not a valid URL.
@ -44,7 +44,7 @@ _Access URL invalid_
### EACS03 ### EACS03
_Failed to fetch `/healthz`_ #### Failed to fetch `/healthz`
**Problem:** Coder was unable to execute a GET request to **Problem:** Coder was unable to execute a GET request to
`${CODER_ACCESS_URL}/healthz`. `${CODER_ACCESS_URL}/healthz`.
@ -74,7 +74,7 @@ The output of this command should aid further diagnosis.
### EACS04 ### EACS04
_/healthz did not return 200 OK_ #### /healthz did not return 200 OK
**Problem:** Coder was able to execute a GET request to **Problem:** Coder was able to execute a GET request to
`${CODER_ACCESS_URL}/healthz`, but the response code was not `200 OK` as `${CODER_ACCESS_URL}/healthz`, but the response code was not `200 OK` as
@ -97,7 +97,7 @@ its configured database, and also measures the median latency over 5 attempts.
### EDB01 ### EDB01
_Database Ping Failed_ #### Database Ping Failed
**Problem:** This error code is returned if any attempt to execute this database **Problem:** This error code is returned if any attempt to execute this database
query fails. query fails.
@ -106,7 +106,7 @@ query fails.
### EDB02 ### EDB02
_Database Latency High_ #### Database Latency High
**Problem:** This code is returned if the median latency is higher than the **Problem:** This code is returned if the median latency is higher than the
[configured threshold](../../reference/cli/server.md#--health-check-threshold-database). [configured threshold](../../reference/cli/server.md#--health-check-threshold-database).
@ -138,7 +138,7 @@ following:
### EDERP01 ### EDERP01
_DERP Node Uses Websocket_ #### DERP Node Uses Websocket
**Problem:** When Coder attempts to establish a connection to one or more DERP **Problem:** When Coder attempts to establish a connection to one or more DERP
servers, it sends a specific `Upgrade: derp` HTTP header. Some load balancers servers, it sends a specific `Upgrade: derp` HTTP header. Some load balancers
@ -157,7 +157,7 @@ still be able to reach their workspaces, connection performance may be degraded.
### EDERP02 ### EDERP02
_One or more DERP nodes are unhealthy_ #### One or more DERP nodes are unhealthy
**Problem:** This is shown if Coder is unable to reach one or more configured **Problem:** This is shown if Coder is unable to reach one or more configured
DERP servers. Clients will fall back to use the remaining DERP servers, but DERP servers. Clients will fall back to use the remaining DERP servers, but
@ -176,7 +176,7 @@ curl -v "https://coder.company.com/derp"
### ESTUN01 ### ESTUN01
_No STUN servers available._ #### No STUN servers available
**Problem:** This is shown if no STUN servers are available. Coder will use STUN **Problem:** This is shown if no STUN servers are available. Coder will use STUN
to establish [direct connections](../networking/stun.md). Without at least one to establish [direct connections](../networking/stun.md). Without at least one
@ -189,7 +189,7 @@ configured port.
### ESTUN02 ### ESTUN02
_STUN returned different addresses; you may be behind a hard NAT._ #### STUN returned different addresses; you may be behind a hard NAT
**Problem:** This is a warning shown when multiple attempts to determine our **Problem:** This is a warning shown when multiple attempts to determine our
public IP address/port via STUN resulted in different `ip:port` combinations. public IP address/port via STUN resulted in different `ip:port` combinations.
@ -218,7 +218,7 @@ message over the connection, and attempt to read back that same message.
### EWS01 ### EWS01
_Failed to establish a WebSocket connection_ #### Failed to establish a WebSocket connection
**Problem:** Coder was unable to establish a WebSocket connection over its own **Problem:** Coder was unable to establish a WebSocket connection over its own
Access URL. Access URL.
@ -237,7 +237,7 @@ Access URL.
### EWS02 ### EWS02
_Failed to echo a WebSocket message_ #### Failed to echo a WebSocket message
**Problem:** Coder was able to establish a WebSocket connection, but was unable **Problem:** Coder was able to establish a WebSocket connection, but was unable
to write a message. to write a message.
@ -258,7 +258,7 @@ Coder will periodically query their availability and show their status here.
### EWP01 ### EWP01
_Error Updating Workspace Proxy Health_ #### Error Updating Workspace Proxy Health
**Problem:** Coder was unable to query the connected workspace proxies for their **Problem:** Coder was unable to query the connected workspace proxies for their
health status. health status.
@ -268,7 +268,7 @@ connectivity issue.
### EWP02 ### EWP02
_Error Fetching Workspace Proxies_ #### Error Fetching Workspace Proxies
**Problem:** Coder was unable to fetch the stored workspace proxy health data **Problem:** Coder was unable to fetch the stored workspace proxy health data
from the database. from the database.
@ -278,7 +278,7 @@ issue with Coder's configured database.
### EWP04 ### EWP04
_One or more Workspace Proxies Unhealthy_ #### One or more Workspace Proxies Unhealthy
**Problem:** One or more workspace proxies are not reachable. **Problem:** One or more workspace proxies are not reachable.
@ -287,7 +287,7 @@ workspace proxies.
### EPD01 ### EPD01
_No Provisioner Daemons Available_ #### No Provisioner Daemons Available
**Problem:** No provisioner daemons are registered with Coder. No workspaces can **Problem:** No provisioner daemons are registered with Coder. No workspaces can
be built until there is at least one provisioner daemon running. be built until there is at least one provisioner daemon running.
@ -305,7 +305,7 @@ is set to a value greater than 0.
### EPD02 ### EPD02
_Provisioner Daemon Version Mismatch_ #### Provisioner Daemon Version Mismatch
**Problem:** One or more provisioner daemons are more than one major or minor **Problem:** One or more provisioner daemons are more than one major or minor
version out of date with the main deployment. It is important that provisioner version out of date with the main deployment. It is important that provisioner
@ -320,7 +320,7 @@ version of Coder.
### EPD03 ### EPD03
_Provisioner Daemon API Version Mismatch_ #### Provisioner Daemon API Version Mismatch
**Problem:** One or more provisioner daemons are using APIs that are marked as **Problem:** One or more provisioner daemons are using APIs that are marked as
deprecated. These deprecated APIs may be removed in a future release of Coder, deprecated. These deprecated APIs may be removed in a future release of Coder,
@ -333,9 +333,9 @@ version of Coder.
> Note: This may be a transient issue if you are currently in the process of > Note: This may be a transient issue if you are currently in the process of
> updating your deployment. > updating your deployment.
## EUNKNOWN ### EUNKNOWN
_Unknown Error_ #### Unknown Error
**Problem:** This error is shown when an unexpected error occurred evaluating **Problem:** This error is shown when an unexpected error occurred evaluating
deployment health. It may resolve on its own. deployment health. It may resolve on its own.

2
docs/admin/monitoring/metrics.md
View File

@ -8,7 +8,7 @@ If you don't have an Prometheus server installed, you can follow the Prometheus
[Getting started](https://prometheus.io/docs/prometheus/latest/getting_started/) [Getting started](https://prometheus.io/docs/prometheus/latest/getting_started/)
guide. guide.
### Setting up metrics ## Setting up metrics
To set up metrics monitoring, please read our To set up metrics monitoring, please read our
[Prometheus integration guide](../integrations/prometheus.md). The following [Prometheus integration guide](../integrations/prometheus.md). The following

27
docs/admin/monitoring/notifications/index.md
View File

@ -64,7 +64,7 @@ You can modify the notification delivery behavior using the following server
flags. flags.
| Required | CLI | Env | Type | Description | Default | | Required | CLI | Env | Type | Description | Default |
| :------: | ----------------------------------- | --------------------------------------- | ---------- | --------------------------------------------------------------------------------------------------------------------- | ------- | |:--------:|-------------------------------------|-----------------------------------------|------------|-----------------------------------------------------------------------------------------------------------------------|---------|
| ✔️ | `--notifications-dispatch-timeout` | `CODER_NOTIFICATIONS_DISPATCH_TIMEOUT` | `duration` | How long to wait while a notification is being sent before giving up. | 1m | | ✔️ | `--notifications-dispatch-timeout` | `CODER_NOTIFICATIONS_DISPATCH_TIMEOUT` | `duration` | How long to wait while a notification is being sent before giving up. | 1m |
| ✔️ | `--notifications-method` | `CODER_NOTIFICATIONS_METHOD` | `string` | Which delivery method to use (available options: 'smtp', 'webhook'). See [Delivery Methods](#delivery-methods) below. | smtp | | ✔️ | `--notifications-method` | `CODER_NOTIFICATIONS_METHOD` | `string` | Which delivery method to use (available options: 'smtp', 'webhook'). See [Delivery Methods](#delivery-methods) below. | smtp |
| -️ | `--notifications-max-send-attempts` | `CODER_NOTIFICATIONS_MAX_SEND_ATTEMPTS` | `int` | The upper limit of attempts to send a notification. | 5 | | -️ | `--notifications-max-send-attempts` | `CODER_NOTIFICATIONS_MAX_SEND_ATTEMPTS` | `int` | The upper limit of attempts to send a notification. | 5 |
@ -90,15 +90,15 @@ existing one.
**Server Settings:** **Server Settings:**
| Required | CLI | Env | Type | Description | Default | | Required | CLI | Env | Type | Description | Default |
| :------: | ------------------- | ----------------------- | -------- | ----------------------------------------- | --------- | |:--------:|---------------------|-------------------------|----------|-------------------------------------------|-----------|
| ✔️ | `--email-from` | `CODER_EMAIL_FROM` | `string` | The sender's address to use. | | | ✔️ | `--email-from` | `CODER_EMAIL_FROM` | `string` | The sender's address to use. | |
| ✔️ | `--email-smarthost` | `CODER_EMAIL_SMARTHOST` | `string` | The SMTP relay to send messages | | ✔️ | `--email-smarthost` | `CODER_EMAIL_SMARTHOST` | `string` | The SMTP relay to send messages | |
| ✔️ | `--email-hello` | `CODER_EMAIL_HELLO` | `string` | The hostname identifying the SMTP server. | localhost | | ✔️ | `--email-hello` | `CODER_EMAIL_HELLO` | `string` | The hostname identifying the SMTP server. | localhost |
**Authentication Settings:** **Authentication Settings:**
| Required | CLI | Env | Type | Description | | Required | CLI | Env | Type | Description |
| :------: | ---------------------------- | -------------------------------- | -------- | ------------------------------------------------------------------------- | |:--------:|------------------------------|----------------------------------|----------|---------------------------------------------------------------------------|
| - | `--email-auth-username` | `CODER_EMAIL_AUTH_USERNAME` | `string` | Username to use with PLAIN/LOGIN authentication. | | - | `--email-auth-username` | `CODER_EMAIL_AUTH_USERNAME` | `string` | Username to use with PLAIN/LOGIN authentication. |
| - | `--email-auth-password` | `CODER_EMAIL_AUTH_PASSWORD` | `string` | Password to use with PLAIN/LOGIN authentication. | | - | `--email-auth-password` | `CODER_EMAIL_AUTH_PASSWORD` | `string` | Password to use with PLAIN/LOGIN authentication. |
| - | `--email-auth-password-file` | `CODER_EMAIL_AUTH_PASSWORD_FILE` | `string` | File from which to load password for use with PLAIN/LOGIN authentication. | | - | `--email-auth-password-file` | `CODER_EMAIL_AUTH_PASSWORD_FILE` | `string` | File from which to load password for use with PLAIN/LOGIN authentication. |
@ -107,8 +107,8 @@ existing one.
**TLS Settings:** **TLS Settings:**
| Required | CLI | Env | Type | Description | Default | | Required | CLI | Env | Type | Description | Default |
| :------: | --------------------------- | ----------------------------- | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------- | |:--------:|-----------------------------|-------------------------------|----------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------|
| - | `--email-force-tls` | `CODER_EMAIL_FORCE_TLS` | `bool` | Force a TLS connection to the configured SMTP smarthost. If port 465 is used, TLS will be forced. See https://datatracker.ietf.org/doc/html/rfc8314#section-3.3. | false | | - | `--email-force-tls` | `CODER_EMAIL_FORCE_TLS` | `bool` | Force a TLS connection to the configured SMTP smarthost. If port 465 is used, TLS will be forced. See <https://datatracker.ietf.org/doc/html/rfc8314#section-3.3>. | false |
| - | `--email-tls-starttls` | `CODER_EMAIL_TLS_STARTTLS` | `bool` | Enable STARTTLS to upgrade insecure SMTP connections using TLS. Ignored if `CODER_NOTIFICATIONS_EMAIL_FORCE_TLS` is set. | false | | - | `--email-tls-starttls` | `CODER_EMAIL_TLS_STARTTLS` | `bool` | Enable STARTTLS to upgrade insecure SMTP connections using TLS. Ignored if `CODER_NOTIFICATIONS_EMAIL_FORCE_TLS` is set. | false |
| - | `--email-tls-skip-verify` | `CODER_EMAIL_TLS_SKIPVERIFY` | `bool` | Skip verification of the target server's certificate (**insecure**). | false | | - | `--email-tls-skip-verify` | `CODER_EMAIL_TLS_SKIPVERIFY` | `bool` | Skip verification of the target server's certificate (**insecure**). | false |
| - | `--email-tls-server-name` | `CODER_EMAIL_TLS_SERVERNAME` | `string` | Server name to verify against the target certificate. | | | - | `--email-tls-server-name` | `CODER_EMAIL_TLS_SERVERNAME` | `string` | Server name to verify against the target certificate. | |
@ -123,9 +123,11 @@ on a port other than `465`.
After setting the required fields above: After setting the required fields above:
1. Create an [App Password](https://myaccount.google.com/apppasswords) using the 1. Create an [App Password](https://myaccount.google.com/apppasswords) using the
account you wish to send from account you wish to send from.
2. Set the following configuration options:
``` 1. Set the following configuration options:
```text
CODER_EMAIL_SMARTHOST=smtp.gmail.com:465 CODER_EMAIL_SMARTHOST=smtp.gmail.com:465
CODER_EMAIL_AUTH_USERNAME=<user>@<domain> CODER_EMAIL_AUTH_USERNAME=<user>@<domain>
CODER_EMAIL_AUTH_PASSWORD="<app password created above>" CODER_EMAIL_AUTH_PASSWORD="<app password created above>"
@ -140,8 +142,9 @@ for more options.
After setting the required fields above: After setting the required fields above:
1. Setup an account on Microsoft 365 or outlook.com 1. Setup an account on Microsoft 365 or outlook.com
2. Set the following configuration options: 1. Set the following configuration options:
```
```text
CODER_EMAIL_SMARTHOST=smtp-mail.outlook.com:587 CODER_EMAIL_SMARTHOST=smtp-mail.outlook.com:587
CODER_EMAIL_TLS_STARTTLS=true CODER_EMAIL_TLS_STARTTLS=true
CODER_EMAIL_AUTH_USERNAME=<user>@<domain> CODER_EMAIL_AUTH_USERNAME=<user>@<domain>
@ -161,7 +164,7 @@ systems.
**Settings**: **Settings**:
| Required | CLI | Env | Type | Description | | Required | CLI | Env | Type | Description |
| :------: | ---------------------------------- | -------------------------------------- | ----- | --------------------------------------- | |:--------:|------------------------------------|----------------------------------------|-------|-----------------------------------------|
| ✔️ | `--notifications-webhook-endpoint` | `CODER_NOTIFICATIONS_WEBHOOK_ENDPOINT` | `url` | The endpoint to which to send webhooks. | | ✔️ | `--notifications-webhook-endpoint` | `CODER_NOTIFICATIONS_WEBHOOK_ENDPOINT` | `url` | The endpoint to which to send webhooks. |
Here is an example payload for Coder's webhook notification: Here is an example payload for Coder's webhook notification:

4
docs/admin/monitoring/notifications/slack.md
View File

@ -162,14 +162,14 @@ app.action("button_click", async ({ body, ack, say }) => {
})(); })();
``` ```
3. Set environment variables to identify the Slack app: 4. Set environment variables to identify the Slack app:
```bash ```bash
export SLACK_BOT_TOKEN=xoxb-... export SLACK_BOT_TOKEN=xoxb-...
export SLACK_SIGNING_SECRET=0da4b... export SLACK_SIGNING_SECRET=0da4b...
``` ```
4. Start the web application by running: 5. Start the web application by running:
```bash ```bash
node app.js node app.js

18
docs/admin/monitoring/notifications/teams.md
View File

@ -28,11 +28,11 @@ The process of setting up a Teams workflow consists of three key steps:
Ensure the trigger access level is set to **"Anyone"**. Ensure the trigger access level is set to **"Anyone"**.
2. Setup the JSON Parsing Action. 1. Setup the JSON Parsing Action.
Next, add the **"Parse JSON"** action, linking the content to the **"Body"** Add the **"Parse JSON"** action, linking the content to the **"Body"** of the
of the received webhook request. Use the following schema to parse the received webhook request. Use the following schema to parse the notification
notification payload: payload:
```json ```json
{ {
@ -80,10 +80,10 @@ The process of setting up a Teams workflow consists of three key steps:
This action parses the notification's title, body, and the recipient's email This action parses the notification's title, body, and the recipient's email
address. address.
3. Configure the Adaptive Card Action. 1. Configure the Adaptive Card Action.
Finally, set up the **"Post Adaptive Card in a chat or channel"** action Finally, set up the **"Post Adaptive Card in a chat or channel"** action with
with the following recommended settings: the following recommended settings:
**Post as**: Flow Bot **Post as**: Flow Bot
@ -128,8 +128,8 @@ The process of setting up a Teams workflow consists of three key steps:
`label` to `title`. Unfortunately, there is no straightforward solution for `label` to `title`. Unfortunately, there is no straightforward solution for
`for-each` pattern. `for-each` pattern.
Feel free to customize the payload to modify the logo, notification title, Feel free to customize the payload to modify the logo, notification title, or
or body content to suit your needs. body content to suit your needs.
## Enable Webhook Integration ## Enable Webhook Integration

2
docs/admin/networking/high-availability.md
View File

@ -42,7 +42,7 @@ rendezvous for the Coder nodes.
Here's an example 3-node network configuration setup: Here's an example 3-node network configuration setup:
| Name | `CODER_HTTP_ADDRESS` | `CODER_DERP_SERVER_RELAY_URL` | `CODER_ACCESS_URL` | | Name | `CODER_HTTP_ADDRESS` | `CODER_DERP_SERVER_RELAY_URL` | `CODER_ACCESS_URL` |
| --------- | -------------------- | ----------------------------- | ------------------------ | |-----------|----------------------|-------------------------------|--------------------------|
| `coder-1` | `*:80` | `http://10.0.0.1:80` | `https://coder.big.corp` | | `coder-1` | `*:80` | `http://10.0.0.1:80` | `https://coder.big.corp` |
| `coder-2` | `*:80` | `http://10.0.0.2:80` | `https://coder.big.corp` | | `coder-2` | `*:80` | `http://10.0.0.2:80` | `https://coder.big.corp` |
| `coder-3` | `*:80` | `http://10.0.0.3:80` | `https://coder.big.corp` | | `coder-3` | `*:80` | `http://10.0.0.3:80` | `https://coder.big.corp` |

2
docs/admin/networking/index.md
View File

@ -168,7 +168,7 @@ After you have custom DERP servers, you can launch Coder with them like so:
``` ```
```bash ```bash
$ coder server --derp-config-path derpmap.json coder server --derp-config-path derpmap.json
``` ```
### Dashboard connections ### Dashboard connections

8
docs/admin/networking/port-forwarding.md
View File

@ -156,7 +156,7 @@ protocol configuration for each shared port individually.
You can access any port on the workspace and can configure the port protocol You can access any port on the workspace and can configure the port protocol
manually by appending a `s` to the port in the URL. manually by appending a `s` to the port in the URL.
``` ```text
# Uses HTTP # Uses HTTP
https://33295--agent--workspace--user--apps.example.com/ https://33295--agent--workspace--user--apps.example.com/
# Uses HTTPS # Uses HTTPS
@ -180,8 +180,8 @@ requests cannot be authenticated and you will see an error resembling the
following: following:
> Access to fetch at > Access to fetch at
> 'https://coder.example.com/api/v2/applications/auth-redirect' from origin > '<https://coder.example.com/api/v2/applications/auth-redirect>' from origin
> 'https://8000--dev--user--apps.coder.example.com' has been blocked by CORS > '<https://8000--dev--user--apps.coder.example.com>' has been blocked by CORS
> policy: No 'Access-Control-Allow-Origin' header is present on the requested > policy: No 'Access-Control-Allow-Origin' header is present on the requested
> resource. If an opaque response serves your needs, set the request's mode to > resource. If an opaque response serves your needs, set the request's mode to
> 'no-cors' to fetch the resource with CORS disabled. > 'no-cors' to fetch the resource with CORS disabled.
@ -190,7 +190,7 @@ following:
Below is a list of the cross-origin headers Coder sets with example values: Below is a list of the cross-origin headers Coder sets with example values:
``` ```text
access-control-allow-credentials: true access-control-allow-credentials: true
access-control-allow-methods: PUT access-control-allow-methods: PUT
access-control-allow-headers: X-Custom-Header access-control-allow-headers: X-Custom-Header

8
docs/admin/networking/workspace-proxies.md
View File

@ -14,11 +14,11 @@ connecting with their workspace over SSH, a workspace app, port forwarding, etc.
Dashboard connections and API calls (e.g. the workspaces list) are not served Dashboard connections and API calls (e.g. the workspaces list) are not served
over workspace proxies. over workspace proxies.
# Deploy a workspace proxy ## Deploy a workspace proxy
Each workspace proxy should be a unique instance. At no point should 2 workspace Each workspace proxy should be a unique instance. At no point should two
proxy instances share the same authentication token. They only require port 443 workspace proxy instances share the same authentication token. They only require
to be open and are expected to have network connectivity to the coderd port 443 to be open and are expected to have network connectivity to the coderd
dashboard. Workspace proxies **do not** make any database connections. dashboard. Workspace proxies **do not** make any database connections.
Workspace proxies can be used in the browser by navigating to the user Workspace proxies can be used in the browser by navigating to the user

4
docs/admin/provisioners.md
View File

@ -201,7 +201,7 @@ different organizations.
This is illustrated in the below table: This is illustrated in the below table:
| Provisioner Tags | Job Tags | Same Org | Can Run Job? | | Provisioner Tags | Job Tags | Same Org | Can Run Job? |
| ----------------------------------------------------------------- | ---------------------------------------------------------------- | -------- | ------------ | |-------------------------------------------------------------------|------------------------------------------------------------------|----------|--------------|
| scope=organization owner= | scope=organization owner= | ✅ | ✅ | | scope=organization owner= | scope=organization owner= | ✅ | ✅ |
| scope=organization owner= environment=on-prem | scope=organization owner= environment=on-prem | ✅ | ✅ | | scope=organization owner= environment=on-prem | scope=organization owner= environment=on-prem | ✅ | ✅ |
| scope=organization owner= environment=on-prem datacenter=chicago | scope=organization owner= environment=on-prem | ✅ | ✅ | | scope=organization owner= environment=on-prem datacenter=chicago | scope=organization owner= environment=on-prem | ✅ | ✅ |
@ -227,7 +227,7 @@ This is illustrated in the below table:
> **Note to maintainers:** to generate this table, run the following command and > **Note to maintainers:** to generate this table, run the following command and
> copy the output: > copy the output:
> >
> ``` > ```go
> go test -v -count=1 ./coderd/provisionerdserver/ -test.run='^TestAcquirer_MatchTags/GenTable$' > go test -v -count=1 ./coderd/provisionerdserver/ -test.run='^TestAcquirer_MatchTags/GenTable$'
> ``` > ```

48
docs/admin/security/audit-logs.md
View File

@ -8,30 +8,30 @@ We track the following resources:
<!-- Code generated by 'make docs/admin/security/audit-logs.md'. DO NOT EDIT --> <!-- Code generated by 'make docs/admin/security/audit-logs.md'. DO NOT EDIT -->
| <b>Resource<b> | | | <b>Resource<b> | | |
| -------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | |----------------------------------------------------------|----------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| APIKey<br><i>login, logout, register, create, delete</i> | <table><thead><tr><th>Field</th><th>Tracked</th></tr></thead><tbody><tr><td>created_at</td><td>true</td></tr><tr><td>expires_at</td><td>true</td></tr><tr><td>hashed_secret</td><td>false</td></tr><tr><td>id</td><td>false</td></tr><tr><td>ip_address</td><td>false</td></tr><tr><td>last_used</td><td>true</td></tr><tr><td>lifetime_seconds</td><td>false</td></tr><tr><td>login_type</td><td>false</td></tr><tr><td>scope</td><td>false</td></tr><tr><td>token_name</td><td>false</td></tr><tr><td>updated_at</td><td>false</td></tr><tr><td>user_id</td><td>true</td></tr></tbody></table> | | APIKey<br><i>login, logout, register, create, delete</i> | <table><thead><tr><th>Field</th><th>Tracked</th></tr></thead><tbody> | <tr><td>created_at</td><td>true</td></tr><tr><td>expires_at</td><td>true</td></tr><tr><td>hashed_secret</td><td>false</td></tr><tr><td>id</td><td>false</td></tr><tr><td>ip_address</td><td>false</td></tr><tr><td>last_used</td><td>true</td></tr><tr><td>lifetime_seconds</td><td>false</td></tr><tr><td>login_type</td><td>false</td></tr><tr><td>scope</td><td>false</td></tr><tr><td>token_name</td><td>false</td></tr><tr><td>updated_at</td><td>false</td></tr><tr><td>user_id</td><td>true</td></tr></tbody></table> |
| AuditOAuthConvertState<br><i></i> | <table><thead><tr><th>Field</th><th>Tracked</th></tr></thead><tbody><tr><td>created_at</td><td>true</td></tr><tr><td>expires_at</td><td>true</td></tr><tr><td>from_login_type</td><td>true</td></tr><tr><td>to_login_type</td><td>true</td></tr><tr><td>user_id</td><td>true</td></tr></tbody></table> | | AuditOAuthConvertState<br><i></i> | <table><thead><tr><th>Field</th><th>Tracked</th></tr></thead><tbody> | <tr><td>created_at</td><td>true</td></tr><tr><td>expires_at</td><td>true</td></tr><tr><td>from_login_type</td><td>true</td></tr><tr><td>to_login_type</td><td>true</td></tr><tr><td>user_id</td><td>true</td></tr></tbody></table> |
| Group<br><i>create, write, delete</i> | <table><thead><tr><th>Field</th><th>Tracked</th></tr></thead><tbody><tr><td>avatar_url</td><td>true</td></tr><tr><td>display_name</td><td>true</td></tr><tr><td>id</td><td>true</td></tr><tr><td>members</td><td>true</td></tr><tr><td>name</td><td>true</td></tr><tr><td>organization_id</td><td>false</td></tr><tr><td>quota_allowance</td><td>true</td></tr><tr><td>source</td><td>false</td></tr></tbody></table> | | Group<br><i>create, write, delete</i> | <table><thead><tr><th>Field</th><th>Tracked</th></tr></thead><tbody> | <tr><td>avatar_url</td><td>true</td></tr><tr><td>display_name</td><td>true</td></tr><tr><td>id</td><td>true</td></tr><tr><td>members</td><td>true</td></tr><tr><td>name</td><td>true</td></tr><tr><td>organization_id</td><td>false</td></tr><tr><td>quota_allowance</td><td>true</td></tr><tr><td>source</td><td>false</td></tr></tbody></table> |
| AuditableOrganizationMember<br><i></i> | <table><thead><tr><th>Field</th><th>Tracked</th></tr></thead><tbody><tr><td>created_at</td><td>true</td></tr><tr><td>organization_id</td><td>false</td></tr><tr><td>roles</td><td>true</td></tr><tr><td>updated_at</td><td>true</td></tr><tr><td>user_id</td><td>true</td></tr><tr><td>username</td><td>true</td></tr></tbody></table> | | AuditableOrganizationMember<br><i></i> | <table><thead><tr><th>Field</th><th>Tracked</th></tr></thead><tbody> | <tr><td>created_at</td><td>true</td></tr><tr><td>organization_id</td><td>false</td></tr><tr><td>roles</td><td>true</td></tr><tr><td>updated_at</td><td>true</td></tr><tr><td>user_id</td><td>true</td></tr><tr><td>username</td><td>true</td></tr></tbody></table> |
| CustomRole<br><i></i> | <table><thead><tr><th>Field</th><th>Tracked</th></tr></thead><tbody><tr><td>created_at</td><td>false</td></tr><tr><td>display_name</td><td>true</td></tr><tr><td>id</td><td>false</td></tr><tr><td>name</td><td>true</td></tr><tr><td>org_permissions</td><td>true</td></tr><tr><td>organization_id</td><td>false</td></tr><tr><td>site_permissions</td><td>true</td></tr><tr><td>updated_at</td><td>false</td></tr><tr><td>user_permissions</td><td>true</td></tr></tbody></table> | | CustomRole<br><i></i> | <table><thead><tr><th>Field</th><th>Tracked</th></tr></thead><tbody> | <tr><td>created_at</td><td>false</td></tr><tr><td>display_name</td><td>true</td></tr><tr><td>id</td><td>false</td></tr><tr><td>name</td><td>true</td></tr><tr><td>org_permissions</td><td>true</td></tr><tr><td>organization_id</td><td>false</td></tr><tr><td>site_permissions</td><td>true</td></tr><tr><td>updated_at</td><td>false</td></tr><tr><td>user_permissions</td><td>true</td></tr></tbody></table> |
| GitSSHKey<br><i>create</i> | <table><thead><tr><th>Field</th><th>Tracked</th></tr></thead><tbody><tr><td>created_at</td><td>false</td></tr><tr><td>private_key</td><td>true</td></tr><tr><td>public_key</td><td>true</td></tr><tr><td>updated_at</td><td>false</td></tr><tr><td>user_id</td><td>true</td></tr></tbody></table> | | GitSSHKey<br><i>create</i> | <table><thead><tr><th>Field</th><th>Tracked</th></tr></thead><tbody> | <tr><td>created_at</td><td>false</td></tr><tr><td>private_key</td><td>true</td></tr><tr><td>public_key</td><td>true</td></tr><tr><td>updated_at</td><td>false</td></tr><tr><td>user_id</td><td>true</td></tr></tbody></table> |
| GroupSyncSettings<br><i></i> | <table><thead><tr><th>Field</th><th>Tracked</th></tr></thead><tbody><tr><td>auto_create_missing_groups</td><td>true</td></tr><tr><td>field</td><td>true</td></tr><tr><td>legacy_group_name_mapping</td><td>false</td></tr><tr><td>mapping</td><td>true</td></tr><tr><td>regex_filter</td><td>true</td></tr></tbody></table> | | GroupSyncSettings<br><i></i> | <table><thead><tr><th>Field</th><th>Tracked</th></tr></thead><tbody> | <tr><td>auto_create_missing_groups</td><td>true</td></tr><tr><td>field</td><td>true</td></tr><tr><td>legacy_group_name_mapping</td><td>false</td></tr><tr><td>mapping</td><td>true</td></tr><tr><td>regex_filter</td><td>true</td></tr></tbody></table> |
| HealthSettings<br><i></i> | <table><thead><tr><th>Field</th><th>Tracked</th></tr></thead><tbody><tr><td>dismissed_healthchecks</td><td>true</td></tr><tr><td>id</td><td>false</td></tr></tbody></table> | | HealthSettings<br><i></i> | <table><thead><tr><th>Field</th><th>Tracked</th></tr></thead><tbody> | <tr><td>dismissed_healthchecks</td><td>true</td></tr><tr><td>id</td><td>false</td></tr></tbody></table> |
| License<br><i>create, delete</i> | <table><thead><tr><th>Field</th><th>Tracked</th></tr></thead><tbody><tr><td>exp</td><td>true</td></tr><tr><td>id</td><td>false</td></tr><tr><td>jwt</td><td>false</td></tr><tr><td>uploaded_at</td><td>true</td></tr><tr><td>uuid</td><td>true</td></tr></tbody></table> | | License<br><i>create, delete</i> | <table><thead><tr><th>Field</th><th>Tracked</th></tr></thead><tbody> | <tr><td>exp</td><td>true</td></tr><tr><td>id</td><td>false</td></tr><tr><td>jwt</td><td>false</td></tr><tr><td>uploaded_at</td><td>true</td></tr><tr><td>uuid</td><td>true</td></tr></tbody></table> |
| NotificationTemplate<br><i></i> | <table><thead><tr><th>Field</th><th>Tracked</th></tr></thead><tbody><tr><td>actions</td><td>true</td></tr><tr><td>body_template</td><td>true</td></tr><tr><td>group</td><td>true</td></tr><tr><td>id</td><td>false</td></tr><tr><td>kind</td><td>true</td></tr><tr><td>method</td><td>true</td></tr><tr><td>name</td><td>true</td></tr><tr><td>title_template</td><td>true</td></tr></tbody></table> | | NotificationTemplate<br><i></i> | <table><thead><tr><th>Field</th><th>Tracked</th></tr></thead><tbody> | <tr><td>actions</td><td>true</td></tr><tr><td>body_template</td><td>true</td></tr><tr><td>group</td><td>true</td></tr><tr><td>id</td><td>false</td></tr><tr><td>kind</td><td>true</td></tr><tr><td>method</td><td>true</td></tr><tr><td>name</td><td>true</td></tr><tr><td>title_template</td><td>true</td></tr></tbody></table> |
| NotificationsSettings<br><i></i> | <table><thead><tr><th>Field</th><th>Tracked</th></tr></thead><tbody><tr><td>id</td><td>false</td></tr><tr><td>notifier_paused</td><td>true</td></tr></tbody></table> | | NotificationsSettings<br><i></i> | <table><thead><tr><th>Field</th><th>Tracked</th></tr></thead><tbody> | <tr><td>id</td><td>false</td></tr><tr><td>notifier_paused</td><td>true</td></tr></tbody></table> |
| OAuth2ProviderApp<br><i></i> | <table><thead><tr><th>Field</th><th>Tracked</th></tr></thead><tbody><tr><td>callback_url</td><td>true</td></tr><tr><td>created_at</td><td>false</td></tr><tr><td>icon</td><td>true</td></tr><tr><td>id</td><td>false</td></tr><tr><td>name</td><td>true</td></tr><tr><td>updated_at</td><td>false</td></tr></tbody></table> | | OAuth2ProviderApp<br><i></i> | <table><thead><tr><th>Field</th><th>Tracked</th></tr></thead><tbody> | <tr><td>callback_url</td><td>true</td></tr><tr><td>created_at</td><td>false</td></tr><tr><td>icon</td><td>true</td></tr><tr><td>id</td><td>false</td></tr><tr><td>name</td><td>true</td></tr><tr><td>updated_at</td><td>false</td></tr></tbody></table> |
| OAuth2ProviderAppSecret<br><i></i> | <table><thead><tr><th>Field</th><th>Tracked</th></tr></thead><tbody><tr><td>app_id</td><td>false</td></tr><tr><td>created_at</td><td>false</td></tr><tr><td>display_secret</td><td>false</td></tr><tr><td>hashed_secret</td><td>false</td></tr><tr><td>id</td><td>false</td></tr><tr><td>last_used_at</td><td>false</td></tr><tr><td>secret_prefix</td><td>false</td></tr></tbody></table> | | OAuth2ProviderAppSecret<br><i></i> | <table><thead><tr><th>Field</th><th>Tracked</th></tr></thead><tbody> | <tr><td>app_id</td><td>false</td></tr><tr><td>created_at</td><td>false</td></tr><tr><td>display_secret</td><td>false</td></tr><tr><td>hashed_secret</td><td>false</td></tr><tr><td>id</td><td>false</td></tr><tr><td>last_used_at</td><td>false</td></tr><tr><td>secret_prefix</td><td>false</td></tr></tbody></table> |
| Organization<br><i></i> | <table><thead><tr><th>Field</th><th>Tracked</th></tr></thead><tbody><tr><td>created_at</td><td>false</td></tr><tr><td>description</td><td>true</td></tr><tr><td>display_name</td><td>true</td></tr><tr><td>icon</td><td>true</td></tr><tr><td>id</td><td>false</td></tr><tr><td>is_default</td><td>true</td></tr><tr><td>name</td><td>true</td></tr><tr><td>updated_at</td><td>true</td></tr></tbody></table> | | Organization<br><i></i> | <table><thead><tr><th>Field</th><th>Tracked</th></tr></thead><tbody> | <tr><td>created_at</td><td>false</td></tr><tr><td>description</td><td>true</td></tr><tr><td>display_name</td><td>true</td></tr><tr><td>icon</td><td>true</td></tr><tr><td>id</td><td>false</td></tr><tr><td>is_default</td><td>true</td></tr><tr><td>name</td><td>true</td></tr><tr><td>updated_at</td><td>true</td></tr></tbody></table> |
| OrganizationSyncSettings<br><i></i> | <table><thead><tr><th>Field</th><th>Tracked</th></tr></thead><tbody><tr><td>assign_default</td><td>true</td></tr><tr><td>field</td><td>true</td></tr><tr><td>mapping</td><td>true</td></tr></tbody></table> | | OrganizationSyncSettings<br><i></i> | <table><thead><tr><th>Field</th><th>Tracked</th></tr></thead><tbody> | <tr><td>assign_default</td><td>true</td></tr><tr><td>field</td><td>true</td></tr><tr><td>mapping</td><td>true</td></tr></tbody></table> |
| RoleSyncSettings<br><i></i> | <table><thead><tr><th>Field</th><th>Tracked</th></tr></thead><tbody><tr><td>field</td><td>true</td></tr><tr><td>mapping</td><td>true</td></tr></tbody></table> | | RoleSyncSettings<br><i></i> | <table><thead><tr><th>Field</th><th>Tracked</th></tr></thead><tbody> | <tr><td>field</td><td>true</td></tr><tr><td>mapping</td><td>true</td></tr></tbody></table> |
| Template<br><i>write, delete</i> | <table><thead><tr><th>Field</th><th>Tracked</th></tr></thead><tbody><tr><td>active_version_id</td><td>true</td></tr><tr><td>activity_bump</td><td>true</td></tr><tr><td>allow_user_autostart</td><td>true</td></tr><tr><td>allow_user_autostop</td><td>true</td></tr><tr><td>allow_user_cancel_workspace_jobs</td><td>true</td></tr><tr><td>autostart_block_days_of_week</td><td>true</td></tr><tr><td>autostop_requirement_days_of_week</td><td>true</td></tr><tr><td>autostop_requirement_weeks</td><td>true</td></tr><tr><td>created_at</td><td>false</td></tr><tr><td>created_by</td><td>true</td></tr><tr><td>created_by_avatar_url</td><td>false</td></tr><tr><td>created_by_username</td><td>false</td></tr><tr><td>default_ttl</td><td>true</td></tr><tr><td>deleted</td><td>false</td></tr><tr><td>deprecated</td><td>true</td></tr><tr><td>description</td><td>true</td></tr><tr><td>display_name</td><td>true</td></tr><tr><td>failure_ttl</td><td>true</td></tr><tr><td>group_acl</td><td>true</td></tr><tr><td>icon</td><td>true</td></tr><tr><td>id</td><td>true</td></tr><tr><td>max_port_sharing_level</td><td>true</td></tr><tr><td>name</td><td>true</td></tr><tr><td>organization_display_name</td><td>false</td></tr><tr><td>organization_icon</td><td>false</td></tr><tr><td>organization_id</td><td>false</td></tr><tr><td>organization_name</td><td>false</td></tr><tr><td>provisioner</td><td>true</td></tr><tr><td>require_active_version</td><td>true</td></tr><tr><td>time_til_dormant</td><td>true</td></tr><tr><td>time_til_dormant_autodelete</td><td>true</td></tr><tr><td>updated_at</td><td>false</td></tr><tr><td>user_acl</td><td>true</td></tr></tbody></table> | | Template<br><i>write, delete</i> | <table><thead><tr><th>Field</th><th>Tracked</th></tr></thead><tbody> | <tr><td>active_version_id</td><td>true</td></tr><tr><td>activity_bump</td><td>true</td></tr><tr><td>allow_user_autostart</td><td>true</td></tr><tr><td>allow_user_autostop</td><td>true</td></tr><tr><td>allow_user_cancel_workspace_jobs</td><td>true</td></tr><tr><td>autostart_block_days_of_week</td><td>true</td></tr><tr><td>autostop_requirement_days_of_week</td><td>true</td></tr><tr><td>autostop_requirement_weeks</td><td>true</td></tr><tr><td>created_at</td><td>false</td></tr><tr><td>created_by</td><td>true</td></tr><tr><td>created_by_avatar_url</td><td>false</td></tr><tr><td>created_by_username</td><td>false</td></tr><tr><td>default_ttl</td><td>true</td></tr><tr><td>deleted</td><td>false</td></tr><tr><td>deprecated</td><td>true</td></tr><tr><td>description</td><td>true</td></tr><tr><td>display_name</td><td>true</td></tr><tr><td>failure_ttl</td><td>true</td></tr><tr><td>group_acl</td><td>true</td></tr><tr><td>icon</td><td>true</td></tr><tr><td>id</td><td>true</td></tr><tr><td>max_port_sharing_level</td><td>true</td></tr><tr><td>name</td><td>true</td></tr><tr><td>organization_display_name</td><td>false</td></tr><tr><td>organization_icon</td><td>false</td></tr><tr><td>organization_id</td><td>false</td></tr><tr><td>organization_name</td><td>false</td></tr><tr><td>provisioner</td><td>true</td></tr><tr><td>require_active_version</td><td>true</td></tr><tr><td>time_til_dormant</td><td>true</td></tr><tr><td>time_til_dormant_autodelete</td><td>true</td></tr><tr><td>updated_at</td><td>false</td></tr><tr><td>user_acl</td><td>true</td></tr></tbody></table> |
| TemplateVersion<br><i>create, write</i> | <table><thead><tr><th>Field</th><th>Tracked</th></tr></thead><tbody><tr><td>archived</td><td>true</td></tr><tr><td>created_at</td><td>false</td></tr><tr><td>created_by</td><td>true</td></tr><tr><td>created_by_avatar_url</td><td>false</td></tr><tr><td>created_by_username</td><td>false</td></tr><tr><td>external_auth_providers</td><td>false</td></tr><tr><td>id</td><td>true</td></tr><tr><td>job_id</td><td>false</td></tr><tr><td>message</td><td>false</td></tr><tr><td>name</td><td>true</td></tr><tr><td>organization_id</td><td>false</td></tr><tr><td>readme</td><td>true</td></tr><tr><td>source_example_id</td><td>false</td></tr><tr><td>template_id</td><td>true</td></tr><tr><td>updated_at</td><td>false</td></tr></tbody></table> | | TemplateVersion<br><i>create, write</i> | <table><thead><tr><th>Field</th><th>Tracked</th></tr></thead><tbody> | <tr><td>archived</td><td>true</td></tr><tr><td>created_at</td><td>false</td></tr><tr><td>created_by</td><td>true</td></tr><tr><td>created_by_avatar_url</td><td>false</td></tr><tr><td>created_by_username</td><td>false</td></tr><tr><td>external_auth_providers</td><td>false</td></tr><tr><td>id</td><td>true</td></tr><tr><td>job_id</td><td>false</td></tr><tr><td>message</td><td>false</td></tr><tr><td>name</td><td>true</td></tr><tr><td>organization_id</td><td>false</td></tr><tr><td>readme</td><td>true</td></tr><tr><td>source_example_id</td><td>false</td></tr><tr><td>template_id</td><td>true</td></tr><tr><td>updated_at</td><td>false</td></tr></tbody></table> |
| User<br><i>create, write, delete</i> | <table><thead><tr><th>Field</th><th>Tracked</th></tr></thead><tbody><tr><td>avatar_url</td><td>false</td></tr><tr><td>created_at</td><td>false</td></tr><tr><td>deleted</td><td>true</td></tr><tr><td>email</td><td>true</td></tr><tr><td>github_com_user_id</td><td>false</td></tr><tr><td>hashed_one_time_passcode</td><td>false</td></tr><tr><td>hashed_password</td><td>true</td></tr><tr><td>id</td><td>true</td></tr><tr><td>last_seen_at</td><td>false</td></tr><tr><td>login_type</td><td>true</td></tr><tr><td>name</td><td>true</td></tr><tr><td>one_time_passcode_expires_at</td><td>true</td></tr><tr><td>quiet_hours_schedule</td><td>true</td></tr><tr><td>rbac_roles</td><td>true</td></tr><tr><td>status</td><td>true</td></tr><tr><td>theme_preference</td><td>false</td></tr><tr><td>updated_at</td><td>false</td></tr><tr><td>username</td><td>true</td></tr></tbody></table> | | User<br><i>create, write, delete</i> | <table><thead><tr><th>Field</th><th>Tracked</th></tr></thead><tbody> | <tr><td>avatar_url</td><td>false</td></tr><tr><td>created_at</td><td>false</td></tr><tr><td>deleted</td><td>true</td></tr><tr><td>email</td><td>true</td></tr><tr><td>github_com_user_id</td><td>false</td></tr><tr><td>hashed_one_time_passcode</td><td>false</td></tr><tr><td>hashed_password</td><td>true</td></tr><tr><td>id</td><td>true</td></tr><tr><td>last_seen_at</td><td>false</td></tr><tr><td>login_type</td><td>true</td></tr><tr><td>name</td><td>true</td></tr><tr><td>one_time_passcode_expires_at</td><td>true</td></tr><tr><td>quiet_hours_schedule</td><td>true</td></tr><tr><td>rbac_roles</td><td>true</td></tr><tr><td>status</td><td>true</td></tr><tr><td>theme_preference</td><td>false</td></tr><tr><td>updated_at</td><td>false</td></tr><tr><td>username</td><td>true</td></tr></tbody></table> |
| WorkspaceBuild<br><i>start, stop</i> | <table><thead><tr><th>Field</th><th>Tracked</th></tr></thead><tbody><tr><td>build_number</td><td>false</td></tr><tr><td>created_at</td><td>false</td></tr><tr><td>daily_cost</td><td>false</td></tr><tr><td>deadline</td><td>false</td></tr><tr><td>id</td><td>false</td></tr><tr><td>initiator_by_avatar_url</td><td>false</td></tr><tr><td>initiator_by_username</td><td>false</td></tr><tr><td>initiator_id</td><td>false</td></tr><tr><td>job_id</td><td>false</td></tr><tr><td>max_deadline</td><td>false</td></tr><tr><td>provisioner_state</td><td>false</td></tr><tr><td>reason</td><td>false</td></tr><tr><td>template_version_id</td><td>true</td></tr><tr><td>transition</td><td>false</td></tr><tr><td>updated_at</td><td>false</td></tr><tr><td>workspace_id</td><td>false</td></tr></tbody></table> | | WorkspaceBuild<br><i>start, stop</i> | <table><thead><tr><th>Field</th><th>Tracked</th></tr></thead><tbody> | <tr><td>build_number</td><td>false</td></tr><tr><td>created_at</td><td>false</td></tr><tr><td>daily_cost</td><td>false</td></tr><tr><td>deadline</td><td>false</td></tr><tr><td>id</td><td>false</td></tr><tr><td>initiator_by_avatar_url</td><td>false</td></tr><tr><td>initiator_by_username</td><td>false</td></tr><tr><td>initiator_id</td><td>false</td></tr><tr><td>job_id</td><td>false</td></tr><tr><td>max_deadline</td><td>false</td></tr><tr><td>provisioner_state</td><td>false</td></tr><tr><td>reason</td><td>false</td></tr><tr><td>template_version_id</td><td>true</td></tr><tr><td>transition</td><td>false</td></tr><tr><td>updated_at</td><td>false</td></tr><tr><td>workspace_id</td><td>false</td></tr></tbody></table> |
| WorkspaceProxy<br><i></i> | <table><thead><tr><th>Field</th><th>Tracked</th></tr></thead><tbody><tr><td>created_at</td><td>true</td></tr><tr><td>deleted</td><td>false</td></tr><tr><td>derp_enabled</td><td>true</td></tr><tr><td>derp_only</td><td>true</td></tr><tr><td>display_name</td><td>true</td></tr><tr><td>icon</td><td>true</td></tr><tr><td>id</td><td>true</td></tr><tr><td>name</td><td>true</td></tr><tr><td>region_id</td><td>true</td></tr><tr><td>token_hashed_secret</td><td>true</td></tr><tr><td>updated_at</td><td>false</td></tr><tr><td>url</td><td>true</td></tr><tr><td>version</td><td>true</td></tr><tr><td>wildcard_hostname</td><td>true</td></tr></tbody></table> | | WorkspaceProxy<br><i></i> | <table><thead><tr><th>Field</th><th>Tracked</th></tr></thead><tbody> | <tr><td>created_at</td><td>true</td></tr><tr><td>deleted</td><td>false</td></tr><tr><td>derp_enabled</td><td>true</td></tr><tr><td>derp_only</td><td>true</td></tr><tr><td>display_name</td><td>true</td></tr><tr><td>icon</td><td>true</td></tr><tr><td>id</td><td>true</td></tr><tr><td>name</td><td>true</td></tr><tr><td>region_id</td><td>true</td></tr><tr><td>token_hashed_secret</td><td>true</td></tr><tr><td>updated_at</td><td>false</td></tr><tr><td>url</td><td>true</td></tr><tr><td>version</td><td>true</td></tr><tr><td>wildcard_hostname</td><td>true</td></tr></tbody></table> |
| WorkspaceTable<br><i></i> | <table><thead><tr><th>Field</th><th>Tracked</th></tr></thead><tbody><tr><td>automatic_updates</td><td>true</td></tr><tr><td>autostart_schedule</td><td>true</td></tr><tr><td>created_at</td><td>false</td></tr><tr><td>deleted</td><td>false</td></tr><tr><td>deleting_at</td><td>true</td></tr><tr><td>dormant_at</td><td>true</td></tr><tr><td>favorite</td><td>true</td></tr><tr><td>id</td><td>true</td></tr><tr><td>last_used_at</td><td>false</td></tr><tr><td>name</td><td>true</td></tr><tr><td>next_start_at</td><td>true</td></tr><tr><td>organization_id</td><td>false</td></tr><tr><td>owner_id</td><td>true</td></tr><tr><td>template_id</td><td>true</td></tr><tr><td>ttl</td><td>true</td></tr><tr><td>updated_at</td><td>false</td></tr></tbody></table> | | WorkspaceTable<br><i></i> | <table><thead><tr><th>Field</th><th>Tracked</th></tr></thead><tbody> | <tr><td>automatic_updates</td><td>true</td></tr><tr><td>autostart_schedule</td><td>true</td></tr><tr><td>created_at</td><td>false</td></tr><tr><td>deleted</td><td>false</td></tr><tr><td>deleting_at</td><td>true</td></tr><tr><td>dormant_at</td><td>true</td></tr><tr><td>favorite</td><td>true</td></tr><tr><td>id</td><td>true</td></tr><tr><td>last_used_at</td><td>false</td></tr><tr><td>name</td><td>true</td></tr><tr><td>next_start_at</td><td>true</td></tr><tr><td>organization_id</td><td>false</td></tr><tr><td>owner_id</td><td>true</td></tr><tr><td>template_id</td><td>true</td></tr><tr><td>ttl</td><td>true</td></tr><tr><td>updated_at</td><td>false</td></tr></tbody></table> |
<!-- End generated by 'make docs/admin/security/audit-logs.md'. --> <!-- End generated by 'make docs/admin/security/audit-logs.md'. -->

2
docs/admin/security/index.md
View File

@ -23,5 +23,5 @@ vulnerability.
--- ---
| Description | Severity | Fix | Vulnerable Versions | | Description | Severity | Fix | Vulnerable Versions |
| --------------------------------------------------------------------------------------------------------------------------------------------- | -------- | -------------------------------------------------------------- | ------------------- | |-----------------------------------------------------------------------------------------------------------------------------------------------|----------|----------------------------------------------------------------|---------------------|
| [API tokens of deleted users not invalidated](https://github.com/coder/coder/blob/main/docs/admin/security/0001_user_apikeys_invalidation.md) | HIGH | [v0.23.0](https://github.com/coder/coder/releases/tag/v0.23.0) | v0.8.25 - v0.22.2 | | [API tokens of deleted users not invalidated](https://github.com/coder/coder/blob/main/docs/admin/security/0001_user_apikeys_invalidation.md) | HIGH | [v0.23.0](https://github.com/coder/coder/releases/tag/v0.23.0) | v0.8.25 - v0.22.2 |

2
docs/admin/security/secrets.md
View File

@ -9,7 +9,7 @@ This article explains how to use secrets in a workspace. To authenticate the
workspace provisioner, see the workspace provisioner, see the
<a href="../provisioners.md#authentication">provisioners documentation</a>. <a href="../provisioners.md#authentication">provisioners documentation</a>.
## Wait a minute... ## Before you begin
Your first attempt to use secrets with Coder should be your local method. You Your first attempt to use secrets with Coder should be your local method. You
can do everything you can locally and more with your Coder workspace, so can do everything you can locally and more with your Coder workspace, so

2
docs/admin/templates/extending-templates/docker-in-workspaces.md
View File

@ -3,7 +3,7 @@
There are a few ways to run Docker within container-based Coder workspaces. There are a few ways to run Docker within container-based Coder workspaces.
| Method | Description | Limitations | | Method | Description | Limitations |
| ---------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | |------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [Sysbox container runtime](#sysbox-container-runtime) | Install the Sysbox runtime on your Kubernetes nodes or Docker host(s) for secure docker-in-docker and systemd-in-docker. Works with GKE, EKS, AKS, Docker. | Requires [compatible nodes](https://github.com/nestybox/sysbox#host-requirements). [Limitations](https://github.com/nestybox/sysbox/blob/master/docs/user-guide/limitations.md) | | [Sysbox container runtime](#sysbox-container-runtime) | Install the Sysbox runtime on your Kubernetes nodes or Docker host(s) for secure docker-in-docker and systemd-in-docker. Works with GKE, EKS, AKS, Docker. | Requires [compatible nodes](https://github.com/nestybox/sysbox#host-requirements). [Limitations](https://github.com/nestybox/sysbox/blob/master/docs/user-guide/limitations.md) |
| [Envbox](#envbox) | A container image with all the packages necessary to run an inner Sysbox container. Removes the need to setup sysbox-runc on your nodes. Works with GKE, EKS, AKS. | Requires running the outer container as privileged (the inner container that acts as the workspace is locked down). Requires compatible [nodes](https://github.com/nestybox/sysbox/blob/master/docs/distro-compat.md#sysbox-distro-compatibility). | | [Envbox](#envbox) | A container image with all the packages necessary to run an inner Sysbox container. Removes the need to setup sysbox-runc on your nodes. Works with GKE, EKS, AKS. | Requires running the outer container as privileged (the inner container that acts as the workspace is locked down). Requires compatible [nodes](https://github.com/nestybox/sysbox/blob/master/docs/distro-compat.md#sysbox-distro-compatibility). |
| [Rootless Podman](#rootless-podman) | Run Podman inside Coder workspaces. Does not require a custom runtime or privileged containers. Works with GKE, EKS, AKS, RKE, OpenShift | Requires smarter-device-manager for FUSE mounts. [See all](https://github.com/containers/podman/blob/main/rootless.md#shortcomings-of-rootless-podman) | | [Rootless Podman](#rootless-podman) | Run Podman inside Coder workspaces. Does not require a custom runtime or privileged containers. Works with GKE, EKS, AKS, RKE, OpenShift | Requires smarter-device-manager for FUSE mounts. [See all](https://github.com/containers/podman/blob/main/rootless.md#shortcomings-of-rootless-podman) |

2
docs/admin/templates/extending-templates/external-auth.md
View File

@ -52,7 +52,7 @@ coder external-auth access-token <external-auth-id>
Note: Some IDE's override the `GIT_ASKPASS` environment variable and need to be Note: Some IDE's override the `GIT_ASKPASS` environment variable and need to be
configured. configured.
**VSCode** #### VSCode
Use the Use the
[Coder](https://marketplace.visualstudio.com/items?itemName=coder.coder-remote) [Coder](https://marketplace.visualstudio.com/items?itemName=coder.coder-remote)

2
docs/admin/templates/extending-templates/parameters.md
View File

@ -90,7 +90,7 @@ data "coder_parameter" "security_groups" {
> For the above example, to override the default values of the `security_groups` > For the above example, to override the default values of the `security_groups`
> parameter, you will need to pass the following argument to `coder create`: > parameter, you will need to pass the following argument to `coder create`:
> >
> ``` > ```shell
> --parameter "\"security_groups=[\"\"DevOps Security Group\"\",\"\"Backend Security Group\"\"]\"" > --parameter "\"security_groups=[\"\"DevOps Security Group\"\",\"\"Backend Security Group\"\"]\""
> ``` > ```
> >

4
docs/admin/templates/extending-templates/variables.md
View File

@ -57,9 +57,9 @@ variables, you can employ a straightforward solution:
coder_image = newimage:tag coder_image = newimage:tag
``` ```
2. Push the new template revision using Coder CLI: 1. Push the new template revision using Coder CLI:
``` ```shell
coder templates push my-template -y # no need to use --var coder templates push my-template -y # no need to use --var
``` ```

10
docs/admin/templates/extending-templates/workspace-tags.md
View File

@ -26,7 +26,7 @@ data "coder_workspace_tags" "custom_workspace_tags" {
} }
``` ```
**Legend** ### Legend
- `zone` - static tag value set to `developers` - `zone` - static tag value set to `developers`
- `runtime` - supported by the string-type `coder_parameter` to select - `runtime` - supported by the string-type `coder_parameter` to select
@ -55,7 +55,7 @@ raw values from the database and evaluates them using provided template
variables and parameters. This is illustrated in the table below: variables and parameters. This is illustrated in the table below:
| Value Type | Template Import | Workspace Creation | | Value Type | Template Import | Workspace Creation |
| ---------- | -------------------------------------------------- | ----------------------- | |------------|----------------------------------------------------|-------------------------|
| Static | `{"region": "us"}` | `{"region": "us"}` | | Static | `{"region": "us"}` | `{"region": "us"}` |
| Variable | `{"az": var.az}` | `{"region": "us-east"}` | | Variable | `{"az": var.az}` | `{"region": "us-east"}` |
| Parameter | `{"cluster": data.coder_parameter.cluster.value }` | `{"cluster": "dev"}` | | Parameter | `{"cluster": data.coder_parameter.cluster.value }` | `{"cluster": "dev"}` |
@ -98,7 +98,7 @@ as immutable and set only once, during workspace creation.
You may only specify the following as inputs for `coder_workspace_tags`: You may only specify the following as inputs for `coder_workspace_tags`:
| | Example | | | Example |
| :----------------- | :-------------------------------------------- | |:-------------------|:----------------------------------------------|
| Static values | `"developers"` | | Static values | `"developers"` |
| Template variables | `var.az` | | Template variables | `var.az` |
| Coder parameters | `data.coder_parameter.runtime_selector.value` | | Coder parameters | `data.coder_parameter.runtime_selector.value` |
@ -115,7 +115,7 @@ raw queries on-the-fly without processing the entire Terraform template. This
evaluation is simpler but also limited in terms of available functions, evaluation is simpler but also limited in terms of available functions,
variables, and references to other resources. variables, and references to other resources.
**Supported syntax** #### Supported syntax
- Static string: `foobar_tag = "foobaz"` - Static string: `foobar_tag = "foobaz"`
- Formatted string: `foobar_tag = "foobaz ${data.coder_parameter.foobaz.value}"` - Formatted string: `foobar_tag = "foobaz ${data.coder_parameter.foobaz.value}"`
@ -125,7 +125,7 @@ variables, and references to other resources.
- Condition: - Condition:
`cache = data.coder_parameter.feature_cache_enabled.value == "true" ? "with-cache" : "no-cache"` `cache = data.coder_parameter.feature_cache_enabled.value == "true" ? "with-cache" : "no-cache"`
**Not supported** #### Not supported
- Function calls: `try(var.foo, "default")` - Function calls: `try(var.foo, "default")`
- Resources: `compute_instance.dev.name` - Resources: `compute_instance.dev.name`

6
docs/admin/templates/managing-templates/devcontainers/add-devcontainer.md
View File

@ -121,7 +121,7 @@ their development environments:
## Example templates ## Example templates
| Template | Description | | Template | Description |
| ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- | |---------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [Docker dev containers](https://github.com/coder/coder/tree/main/examples/templates/docker-devcontainer) | Docker provisions a development container. | | [Docker dev containers](https://github.com/coder/coder/tree/main/examples/templates/docker-devcontainer) | Docker provisions a development container. |
| [Kubernetes dev containers](https://github.com/coder/coder/tree/main/examples/templates/kubernetes-devcontainer) | Provisions a development container on the Kubernetes cluster. | | [Kubernetes dev containers](https://github.com/coder/coder/tree/main/examples/templates/kubernetes-devcontainer) | Provisions a development container on the Kubernetes cluster. |
| [Google Compute Engine dev container](https://github.com/coder/coder/tree/main/examples/templates/gcp-devcontainer) | Runs a development container inside a single GCP instance. It also mounts the Docker socket from the VM inside the container to enable Docker inside the workspace. | | [Google Compute Engine dev container](https://github.com/coder/coder/tree/main/examples/templates/gcp-devcontainer) | Runs a development container inside a single GCP instance. It also mounts the Docker socket from the VM inside the container to enable Docker inside the workspace. |
@ -144,7 +144,3 @@ Lifecycle scripts are managed by project developers.
## Next steps ## Next steps
- [Dev container security and caching](./devcontainer-security-caching.md) - [Dev container security and caching](./devcontainer-security-caching.md)
```
```

2
docs/admin/templates/managing-templates/devcontainers/devcontainer-security-caching.md
View File

@ -3,7 +3,7 @@
Ensure Envbuilder can only pull pre-approved images and artifacts by configuring Ensure Envbuilder can only pull pre-approved images and artifacts by configuring
it with your existing HTTP proxies, firewalls, and artifact managers. it with your existing HTTP proxies, firewalls, and artifact managers.
### Configure registry authentication ## Configure registry authentication
You may need to authenticate to your container registry, such as Artifactory, or You may need to authenticate to your container registry, such as Artifactory, or
Git provider such as GitLab, to use Envbuilder. See the Git provider such as GitLab, to use Envbuilder. See the

6
docs/admin/users/github-auth.md
View File

@ -1,6 +1,6 @@
## GitHub # GitHub
### Step 1: Configure the OAuth application in GitHub ## Step 1: Configure the OAuth application in GitHub
First, First,
[register a GitHub OAuth app](https://developer.github.com/apps/building-oauth-apps/creating-an-oauth-app/). [register a GitHub OAuth app](https://developer.github.com/apps/building-oauth-apps/creating-an-oauth-app/).
@ -22,7 +22,7 @@ values in the next step.
Coder will need permission to access user email addresses. Find the "Account Coder will need permission to access user email addresses. Find the "Account
Permissions" settings for your app and select "read-only" for "Email addresses". Permissions" settings for your app and select "read-only" for "Email addresses".
### Step 2: Configure Coder with the OAuth credentials ## Step 2: Configure Coder with the OAuth credentials
Navigate to your Coder host and run the following command to start up the Coder Navigate to your Coder host and run the following command to start up the Coder
server: server:

2
docs/admin/users/groups-roles.md
View File

@ -17,7 +17,7 @@ which templates developers can use. For example:
Roles determine which actions users can take within the platform. Roles determine which actions users can take within the platform.
| | Auditor | User Admin | Template Admin | Owner | | | Auditor | User Admin | Template Admin | Owner |
| --------------------------------------------------------------- | ------- | ---------- | -------------- | ----- | |-----------------------------------------------------------------|---------|------------|----------------|-------|
| Add and remove Users | | ✅ | | ✅ | | Add and remove Users | | ✅ | | ✅ |
| Manage groups (enterprise) (premium) | | ✅ | | ✅ | | Manage groups (enterprise) (premium) | | ✅ | | ✅ |
| Change User roles | | | | ✅ | | Change User roles | | | | ✅ |

11
docs/admin/users/idp-sync.md
View File

@ -1,3 +1,4 @@
<!-- markdownlint-disable MD024 -->
# IDP Sync # IDP Sync
<blockquote class="info"> <blockquote class="info">
@ -7,6 +8,8 @@ IDP sync is an Enterprise and Premium feature.
</blockquote> </blockquote>
## Group Sync
If your OpenID Connect provider supports group claims, you can configure Coder If your OpenID Connect provider supports group claims, you can configure Coder
to synchronize groups in your auth provider to groups within Coder. To enable to synchronize groups in your auth provider to groups within Coder. To enable
group sync, ensure that the `groups` claim is being sent by your OpenID group sync, ensure that the `groups` claim is being sent by your OpenID
@ -209,7 +212,7 @@ Users who are not in a matching group will see the following error:
<Image height="412px" src="../../images/admin/group-allowlist.png" alt="Unauthorized group error" align="center" /> <Image height="412px" src="../../images/admin/group-allowlist.png" alt="Unauthorized group error" align="center" />
## Role sync ## Role Sync
<blockquote class="info"> <blockquote class="info">
@ -372,7 +375,7 @@ dashboard:
<div class="tabs"> <div class="tabs">
### Dashboard ## Dashboard
1. Confirm that your OIDC provider is sending claims. Log in with OIDC and visit 1. Confirm that your OIDC provider is sending claims. Log in with OIDC and visit
the following URL with an `Owner` account: the following URL with an `Owner` account:
@ -412,7 +415,7 @@ dashboard:
![IdP organization sync](../../images/admin/users/organizations/idp-org-sync.png) ![IdP organization sync](../../images/admin/users/organizations/idp-org-sync.png)
### CLI ## CLI
Use the Coder CLI to show and adjust the settings. Use the Coder CLI to show and adjust the settings.
@ -455,7 +458,7 @@ settings, a user's memberships will update when they log out and log back in.
Analyzing the JSON payload: Analyzing the JSON payload:
| Field | Explanation | | Field | Explanation |
| :-------------------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | |:----------------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| field | If this field is the empty string `""`, then org-sync is disabled. </br> Org memberships must be manually configured through the UI or API. | | field | If this field is the empty string `""`, then org-sync is disabled. </br> Org memberships must be manually configured through the UI or API. |
| mapping | Mapping takes a claim from the IdP, and associates it with 1 or more organizations by UUID. </br> No validation is done, so you can put UUID's of orgs that do not exist (a noop). The UI picker will allow selecting orgs from a drop down, and convert it to a UUID for you. | | mapping | Mapping takes a claim from the IdP, and associates it with 1 or more organizations by UUID. </br> No validation is done, so you can put UUID's of orgs that do not exist (a noop). The UI picker will allow selecting orgs from a drop down, and convert it to a UUID for you. |
| organization_assign_default | This setting exists for maintaining backwards compatibility with single org deployments, either through their upgrade, or in perpetuity. </br> If this is set to 'true', all users will always be assigned to the default organization regardless of the mappings and their IdP claims. | | organization_assign_default | This setting exists for maintaining backwards compatibility with single org deployments, either through their upgrade, or in perpetuity. </br> If this is set to 'true', all users will always be assigned to the default organization regardless of the mappings and their IdP claims. |

4
docs/admin/users/quotas.md
View File

@ -76,7 +76,7 @@ the sum of their allowances.
For example: For example:
| Group Name | Quota Allowance | | Group Name | Quota Allowance |
| ---------- | --------------- | |------------|-----------------|
| Frontend | 10 | | Frontend | 10 |
| Backend | 20 | | Backend | 20 |
| Data | 30 | | Data | 30 |
@ -84,7 +84,7 @@ For example:
<br/> <br/>
| Username | Groups | Effective Budget | | Username | Groups | Effective Budget |
| -------- | ----------------- | ---------------- | |----------|-------------------|------------------|
| jill | Frontend, Backend | 30 | | jill | Frontend, Backend | 30 |
| jack | Backend, Data | 50 | | jack | Backend, Data | 50 |
| sam | Data | 30 | | sam | Data | 30 |

2
docs/changelogs/index.md
View File

@ -1,6 +1,6 @@
# Changelogs # Changelogs
These are the changelogs used by [generate_release_notes.sh]https://github.com/coder/coder/blob/main/scripts/release/generate_release_notes.sh) for a release. These are the changelogs used by [generate_release_notes.sh](https://github.com/coder/coder/blob/main/scripts/release/generate_release_notes.sh) for a release.
These changelogs are currently not kept in sync with GitHub releases. Use [GitHub releases](https://github.com/coder/coder/releases) for the latest information! These changelogs are currently not kept in sync with GitHub releases. Use [GitHub releases](https://github.com/coder/coder/releases) for the latest information!

2
docs/changelogs/v0.25.0.md
View File

@ -23,9 +23,11 @@
[--block-direct-connections](https://coder.com/docs/cli/server#--block-direct-connections) [--block-direct-connections](https://coder.com/docs/cli/server#--block-direct-connections)
(#7936) (#7936)
- Search for workspaces based on last activity (#2658) - Search for workspaces based on last activity (#2658)
```text ```text
last_seen_before:"2023-01-14T23:59:59Z" last_seen_after:"2023-01-08T00:00:00Z" last_seen_before:"2023-01-14T23:59:59Z" last_seen_after:"2023-01-08T00:00:00Z"
``` ```
- Queue position of pending workspace builds are shown in the dashboard (#8244) - Queue position of pending workspace builds are shown in the dashboard (#8244)
<img width="1449" alt="Queue position" src="https://github.com/coder/coder/assets/22407953/44515a19-ddfb-4431-8c2a-203487c4efe8"> <img width="1449" alt="Queue position" src="https://github.com/coder/coder/assets/22407953/44515a19-ddfb-4431-8c2a-203487c4efe8">
- Enable Terraform debug mode via deployment configuration (#8260) - Enable Terraform debug mode via deployment configuration (#8260)

71
docs/changelogs/v0.27.0.md
View File

@ -50,81 +50,12 @@ Agent logs can be pushed after a workspace has started (#8528)
### Documentation ### Documentation
## Changelog
### Breaking changes
Agent logs can be pushed after a workspace has started (#8528)
> ⚠️ **Warning:** You will need to
> [update](https://coder.com/docs/install) your local Coder CLI v0.27
> to connect via `coder ssh`.
### Features
- [Empeheral parameters](https://registry.terraform.io/providers/coder/coder/latest/docs/data-sources/parameter#ephemeral)
allow users to specify a value for a single build (#8415) (#8524)
![Ephemeral parameters](https://github.com/coder/coder/assets/22407953/89df0888-9abc-453a-ac54-f5d0e221b0b9)
> Upgrade to Coder Terraform Provider v0.11.1 to use ephemeral parameters in
> your templates
- Create template, if it doesn't exist with `templates push --create` (#8454)
- Workspaces now appear `unhealthy` in the dashboard and CLI if one or more
agents do not exist (#8541) (#8548)
![Workspace health](https://github.com/coder/coder/assets/22407953/edbb1d70-61b5-4b45-bfe8-51abdab417cc)
- Reverse port-forward with `coder ssh -R` (#8515)
- Helm: custom command arguments in Helm chart (#8567)
- Template version messages (#8435)
<img width="428" alt="252772262-087f1338-f1e2-49fb-81f2-358070a46484" src="https://github.com/coder/coder/assets/22407953/5f6e5e47-e61b-41f1-92fe-f624e92f8bd3">
- TTL and max TTL validation increased to 30 days (#8258)
- [Self-hosted docs](https://coder.com/docs/install/offline#offline-docs):
Host your own copy of Coder's documentation in your own environment (#8527)
(#8601)
- Add custom coder bin path for `config-ssh` (#8425)
- Admins can create workspaces for other users via the CLI (#8481)
- `coder_app` supports localhost apps running https (#8585)
- Base container image contains [jq](https://github.com/coder/coder/pull/8563)
for parsing mounted JSON secrets
### Bug fixes
- Check agent metadata every second instead of minute (#8614)
- `coder stat` fixes
- Read from alternate cgroup path (#8591)
- Improve detection of container environment (#8643)
- Unskip TestStatCPUCmd/JSON and explicitly set --host in test cmd invocation
(#8558)
- Avoid initial license reconfig if feature isn't enabled (#8586)
- Audit log records delete workspace action properly (#8494)
- Audit logs are properly paginated (#8513)
- Fix bottom border on build logs (#8554)
- Don't mark metadata with `interval: 0` as stale (#8627)
- Add some missing workspace updates (#7790)
### Documentation
- Custom API use cases (custom agent logs, CI/CD pipelines) (#8445) - Custom API use cases (custom agent logs, CI/CD pipelines) (#8445)
- Docs on using remote Docker hosts (#8479) - Docs on using remote Docker hosts (#8479)
- Added kubernetes option to workspace proxies (#8533) - Added kubernetes option to workspace proxies (#8533)
Compare: Compare:
[`v0.26.1...v0.26.2`](https://github.com/coder/coder/compare/v0.26.1...v0.27.0) [`v0.26.2...v0.27.0`](https://github.com/coder/coder/compare/v0.26.2...v0.27.0)
## Container image
- `docker pull ghcr.io/coder/coder:v0.26.2`
## Install/upgrade
Refer to our docs to [install](https://coder.com/docs/install) or
[upgrade](https://coder.com/docs/admin/upgrade) Coder, or use a
release asset below.
- Custom API use cases (custom agent logs, CI/CD pipelines) (#8445)
- Docs on using remote Docker hosts (#8479)
- Added kubernetes option to workspace proxies (#8533)
Compare:
[`v0.26.1...v0.26.2`](https://github.com/coder/coder/compare/v0.26.1...v0.27.0)
## Container image ## Container image

4
docs/changelogs/v2.0.0.md
View File

@ -18,7 +18,7 @@ While Coder v1 is being sunset, we still wanted to avoid versioning conflicts.
What is not changing: What is not changing:
- Our feature roadmap: See what we have planned at https://coder.com/roadmap - Our feature roadmap: See what we have planned at <https://coder.com/roadmap>
- Your upgrade path: You can safely upgrade from previous coder/coder releases - Your upgrade path: You can safely upgrade from previous coder/coder releases
to v2.x releases! to v2.x releases!
- Our release cadence: We want features out as quickly as possible and feature - Our release cadence: We want features out as quickly as possible and feature
@ -33,7 +33,7 @@ What is changing:
dashboard ] dashboard ]
Questions? Feel free to ask in [our Discord](https://discord.gg/coder) or email Questions? Feel free to ask in [our Discord](https://discord.gg/coder) or email
ben@coder.com! <ben@coder.com>!
## Changelog ## Changelog

2
docs/changelogs/v2.1.1.md
View File

@ -7,7 +7,7 @@
![Last used](https://user-images.githubusercontent.com/22407953/262407146-06cded4e-684e-4cff-86b7-4388270e7d03.png) ![Last used](https://user-images.githubusercontent.com/22407953/262407146-06cded4e-684e-4cff-86b7-4388270e7d03.png)
> You can use `last_used_before` and `last_used_after` in the workspaces > You can use `last_used_before` and `last_used_after` in the workspaces
> search with [RFC3339Nano](https://www.rfc-editor.org/rfc/rfc3339) datetime > search with [RFC3339Nano](https://www.rfc-editor.org/rfc/rfc3339) datetime
- Add `daily_cost`` to `coder ls` to show - Add `daily_cost` to `coder ls` to show
[quota](https://coder.com/docs/admin/quotas) consumption (#9200) [quota](https://coder.com/docs/admin/quotas) consumption (#9200)
(@ammario) (@ammario)
- Added `coder_app` usage to template insights (#9138) (@mafredri) - Added `coder_app` usage to template insights (#9138) (@mafredri)

2
docs/changelogs/v2.1.5.md
View File

@ -17,11 +17,13 @@
[display apps](https://registry.terraform.io/providers/coder/coder/latest/docs/resources/agent#nested-schema-for-display_apps) [display apps](https://registry.terraform.io/providers/coder/coder/latest/docs/resources/agent#nested-schema-for-display_apps)
in your template, such as VS Code (Insiders), web terminal, SSH, etc. (#9100) in your template, such as VS Code (Insiders), web terminal, SSH, etc. (#9100)
(@sreya) To add VS Code insiders into your template, you can set: (@sreya) To add VS Code insiders into your template, you can set:
```tf ```tf
display_apps { display_apps {
vscode_insiders = true vscode_insiders = true
} }
``` ```
![Add insiders](https://user-images.githubusercontent.com/4856196/263852602-94a5cb56-b7c3-48cb-928a-3b5e0f4e964b.png) ![Add insiders](https://user-images.githubusercontent.com/4856196/263852602-94a5cb56-b7c3-48cb-928a-3b5e0f4e964b.png)
- Create a workspace from any template version (#9471) (@aslilac) - Create a workspace from any template version (#9471) (@aslilac)
- Add DataDog Go tracer (#9411) (@ammario) - Add DataDog Go tracer (#9411) (@ammario)

6
docs/contributing/CODE_OF_CONDUCT.md
View File

@ -55,7 +55,7 @@ further defined and clarified by project maintainers.
## Enforcement ## Enforcement
Instances of abusive, harassing, or otherwise unacceptable behavior may be Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported by contacting the project team at opensource@coder.com. All complaints reported by contacting the project team at <opensource@coder.com>. All complaints
will be reviewed and investigated and will result in a response that is deemed will be reviewed and investigated and will result in a response that is deemed
necessary and appropriate to the circumstances. The project team is obligated to necessary and appropriate to the circumstances. The project team is obligated to
maintain confidentiality with regard to the reporter of an incident. Further maintain confidentiality with regard to the reporter of an incident. Further
@ -69,9 +69,9 @@ members of the project's leadership.
This Code of Conduct is adapted from the [Contributor Covenant][homepage], This Code of Conduct is adapted from the [Contributor Covenant][homepage],
version 1.4, available at version 1.4, available at
https://www.contributor-covenant.org/version/1/4/code-of-conduct.html <https://www.contributor-covenant.org/version/1/4/code-of-conduct.html>
[homepage]: https://www.contributor-covenant.org [homepage]: https://www.contributor-covenant.org
For answers to common questions about this code of conduct, see For answers to common questions about this code of conduct, see
https://www.contributor-covenant.org/faq <https://www.contributor-covenant.org/faq>

2
docs/contributing/SECURITY.md
View File

@ -1,4 +1,4 @@
# Security Policy # Security Policy
If you find a vulnerability, **DO NOT FILE AN ISSUE**. Instead, send an email to If you find a vulnerability, **DO NOT FILE AN ISSUE**. Instead, send an email to
security@coder.com. <security@coder.com>.

2
docs/contributing/documentation.md
View File

@ -25,7 +25,7 @@ If you have questions that aren't explicitly covered by this guide, consult the
following third-party references: following third-party references:
| **Type of guidance** | **Third-party reference** | | **Type of guidance** | **Third-party reference** |
| -------------------- | -------------------------------------------------------------------------------------- | |----------------------|----------------------------------------------------------------------------------------|
| Spelling | [Merriam-Webster.com](https://www.merriam-webster.com/) | | Spelling | [Merriam-Webster.com](https://www.merriam-webster.com/) |
| Style - nontechnical | [The Chicago Manual of Style](https://www.chicagomanualofstyle.org/home.html) | | Style - nontechnical | [The Chicago Manual of Style](https://www.chicagomanualofstyle.org/home.html) |
| Style - technical | [Microsoft Writing Style Guide](https://docs.microsoft.com/en-us/style-guide/welcome/) | | Style - technical | [Microsoft Writing Style Guide](https://docs.microsoft.com/en-us/style-guide/welcome/) |

2
docs/contributing/feature-stages.md
View File

@ -46,7 +46,7 @@ coder server --experiments=feature1,feature2
<!-- BEGIN: available-experimental-features --> <!-- BEGIN: available-experimental-features -->
| Feature | Description | Available in | | Feature | Description | Available in |
| --------------- | ------------------------------------------------------------------- | ------------ | |-----------------|---------------------------------------------------------------------|--------------|
| `notifications` | Sends notifications via SMTP and webhooks following certain events. | stable | | `notifications` | Sends notifications via SMTP and webhooks following certain events. | stable |
<!-- END: available-experimental-features --> <!-- END: available-experimental-features -->

4
docs/contributing/frontend.md
View File

@ -332,8 +332,8 @@ One thing we figured out that was slowing down our tests was the use of `ByRole`
queries because of how it calculates the role attribute for every element on the queries because of how it calculates the role attribute for every element on the
`screen`. You can read more about it on the links below: `screen`. You can read more about it on the links below:
- https://stackoverflow.com/questions/69711888/react-testing-library-getbyrole-is-performing-extremely-slowly - <https://stackoverflow.com/questions/69711888/react-testing-library-getbyrole-is-performing-extremely-slowly>
- https://github.com/testing-library/dom-testing-library/issues/552#issuecomment-625172052 - <https://github.com/testing-library/dom-testing-library/issues/552#issuecomment-625172052>
Even with `ByRole` having performance issues we still want to use it but for Even with `ByRole` having performance issues we still want to use it but for
that, we have to scope the "querying" area by using the `within` command. So that, we have to scope the "querying" area by using the `within` command. So

16
docs/install/cloud/azure-vm.md
View File

@ -12,7 +12,7 @@ This guide assumes you have full administrator privileges on Azure.
From the Azure Portal, navigate to the Virtual Machines Dashboard. Click Create, From the Azure Portal, navigate to the Virtual Machines Dashboard. Click Create,
and select creating a new Azure Virtual machine . and select creating a new Azure Virtual machine .
<img src="../../images/platforms/azure/azure1.jpg"> <img src="../../images/platforms/azure/azure1.jpg" alt="Azure VM creation page">
This will bring you to the `Create a virtual machine` page. Select the This will bring you to the `Create a virtual machine` page. Select the
subscription group of your choice, or create one if necessary. subscription group of your choice, or create one if necessary.
@ -22,14 +22,14 @@ of your choice. Change the region to something more appropriate for your current
location. For this tutorial, we will use the base selection of the Ubuntu Gen2 location. For this tutorial, we will use the base selection of the Ubuntu Gen2
Image and keep the rest of the base settings for this image the same. Image and keep the rest of the base settings for this image the same.
<img src="../../images/platforms/azure/azure2.png"> <img src="../../images/platforms/azure/azure2.png" alt="Azure VM instance details">
<img src="../../images/platforms/azure/azure3.png"> <img src="../../images/platforms/azure/azure3.png" alt="Azure VM size selection">
Up next, under `Inbound port rules` modify the Select `inbound ports` to also Up next, under `Inbound port rules` modify the Select `inbound ports` to also
take in `HTTPS` and `HTTP`. take in `HTTPS` and `HTTP`.
<img src="../../images/platforms/azure/azure4.png"> <img src="../../images/platforms/azure/azure4.png" alt="Azure VM inbound port rules">
The set up for the image is complete at this stage. Click `Review and Create` - The set up for the image is complete at this stage. Click `Review and Create` -
review the information and click `Create`. A popup will appear asking you to review the information and click `Create`. A popup will appear asking you to
@ -37,11 +37,11 @@ download the key pair for the server. Click
`Download private key and create resource` and place it into a folder of your `Download private key and create resource` and place it into a folder of your
choice on your local system. choice on your local system.
<img src="../../images/platforms/azure/azure5.png"> <img src="../../images/platforms/azure/azure5.png" alt="Azure VM key pair generation">
Click `Return to create a virtual machine`. Your VM will start up! Click `Return to create a virtual machine`. Your VM will start up!
<img src="../../images/platforms/azure/azure6.png"> <img src="../../images/platforms/azure/azure6.png" alt="Azure VM deployment complete">
Click `Go to resource` in the virtual machine and copy the public IP address. Click `Go to resource` in the virtual machine and copy the public IP address.
You will need it to SSH into the virtual machine via your local machine. You will need it to SSH into the virtual machine via your local machine.
@ -100,12 +100,12 @@ First, run `coder template init` to create your first template. You’ll be give
a list of possible templates to use. This tutorial will show you how to set up a list of possible templates to use. This tutorial will show you how to set up
your Coder instance to create a Linux based machine on Azure. your Coder instance to create a Linux based machine on Azure.
<img src="../../images/platforms/azure/azure9.png"> <img src="../../images/platforms/azure/azure9.png" alt="Coder CLI template init">
Press `enter` to select `Develop in Linux on Azure` template. This will return Press `enter` to select `Develop in Linux on Azure` template. This will return
the following: the following:
<img src="../../images/platforms/azure/azure10.png"> <img src="../../images/platforms/azure/azure10.png" alt="Coder CLI template init">
To get started using the Azure template, install the Azure CLI by following the To get started using the Azure template, install the Azure CLI by following the
instructions instructions

2
docs/install/offline.md
View File

@ -7,7 +7,7 @@ environments. However, some changes to your configuration are necessary.
> offline with Kubernetes or Docker. > offline with Kubernetes or Docker.
| | Public deployments | Offline deployments | | | Public deployments | Offline deployments |
| ------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | |--------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| Terraform binary | By default, Coder downloads Terraform binary from [releases.hashicorp.com](https://releases.hashicorp.com) | Terraform binary must be included in `PATH` for the VM or container image. [Supported versions](https://github.com/coder/coder/blob/main/provisioner/terraform/install.go#L23-L24) | | Terraform binary | By default, Coder downloads Terraform binary from [releases.hashicorp.com](https://releases.hashicorp.com) | Terraform binary must be included in `PATH` for the VM or container image. [Supported versions](https://github.com/coder/coder/blob/main/provisioner/terraform/install.go#L23-L24) |
| Terraform registry | Coder templates will attempt to download providers from [registry.terraform.io](https://registry.terraform.io) or [custom source addresses](https://developer.hashicorp.com/terraform/language/providers/requirements#source-addresses) specified in each template | [Custom source addresses](https://developer.hashicorp.com/terraform/language/providers/requirements#source-addresses) can be specified in each Coder template, or a custom registry/mirror can be used. More details below | | Terraform registry | Coder templates will attempt to download providers from [registry.terraform.io](https://registry.terraform.io) or [custom source addresses](https://developer.hashicorp.com/terraform/language/providers/requirements#source-addresses) specified in each template | [Custom source addresses](https://developer.hashicorp.com/terraform/language/providers/requirements#source-addresses) can be specified in each Coder template, or a custom registry/mirror can be used. More details below |
| STUN | By default, Coder uses Google's public STUN server for direct workspace connections | STUN can be safely [disabled](../reference/cli/server.md#--derp-server-stun-addresses) users can still connect via [relayed connections](../admin/networking/index.md#-geo-distribution). Alternatively, you can set a [custom DERP server](../reference/cli/server.md#--derp-server-stun-addresses) | | STUN | By default, Coder uses Google's public STUN server for direct workspace connections | STUN can be safely [disabled](../reference/cli/server.md#--derp-server-stun-addresses) users can still connect via [relayed connections](../admin/networking/index.md#-geo-distribution). Alternatively, you can set a [custom DERP server](../reference/cli/server.md#--derp-server-stun-addresses) |

2
docs/install/openshift.md
View File

@ -1,3 +1,5 @@
# OpenShift
## Requirements ## Requirements
- OpenShift cluster running K8s 1.19+ (OpenShift 4.7+) - OpenShift cluster running K8s 1.19+ (OpenShift 4.7+)

2
docs/install/other/index.md
View File

@ -4,7 +4,7 @@ Coder has a number of alternate unofficial install methods. Contributions are
welcome! welcome!
| Platform Name | Status | Documentation | | Platform Name | Status | Documentation |
| --------------------------------------------------------------------------------- | ---------- | -------------------------------------------------------------------------------------------- | |-----------------------------------------------------------------------------------|------------|----------------------------------------------------------------------------------------------|
| AWS EC2 | Official | [Guide: AWS](../cloud/ec2.md) | | AWS EC2 | Official | [Guide: AWS](../cloud/ec2.md) |
| Google Compute Engine | Official | [Guide: Google Compute Engine](../cloud/compute-engine.md) | | Google Compute Engine | Official | [Guide: Google Compute Engine](../cloud/compute-engine.md) |
| Azure AKS | Unofficial | [GitHub: coder-aks](https://github.com/ericpaulsen/coder-aks) | | Azure AKS | Unofficial | [GitHub: coder-aks](https://github.com/ericpaulsen/coder-aks) |

4
docs/install/releases.md
View File

@ -7,6 +7,8 @@ We recommend enterprise customers test the compatibility of new releases with
their infrastructure on a staging environment before upgrading a production their infrastructure on a staging environment before upgrading a production
deployment. deployment.
## Release channels
We support two release channels: We support two release channels:
[mainline](https://github.com/coder/coder/releases/tag/v2.16.0) for the bleeding [mainline](https://github.com/coder/coder/releases/tag/v2.16.0) for the bleeding
edge version of Coder and edge version of Coder and
@ -53,7 +55,7 @@ pages.
## Release schedule ## Release schedule
| Release name | Release Date | Status | | Release name | Release Date | Status |
| ------------ | ------------------ | ---------------- | |--------------|--------------------|------------------|
| 2.12.x | June 04, 2024 | Not Supported | | 2.12.x | June 04, 2024 | Not Supported |
| 2.13.x | July 02, 2024 | Not Supported | | 2.13.x | July 02, 2024 | Not Supported |
| 2.14.x | August 06, 2024 | Not Supported | | 2.14.x | August 06, 2024 | Not Supported |

10
docs/install/uninstall.md
View File

@ -1,15 +1,10 @@
<!-- markdownlint-disable MD024 -->
# Uninstall # Uninstall
This article walks you through how to uninstall your Coder server. This article walks you through how to uninstall your Coder server.
To uninstall your Coder server, delete the following directories. To uninstall your Coder server, delete the following directories.
## Cached Coder releases
```shell
rm -rf ~/.cache/coder
```
## The Coder server binary and CLI ## The Coder server binary and CLI
<div class="tabs"> <div class="tabs">
@ -71,7 +66,7 @@ winget uninstall Coder.Coder
sudo rm /etc/coder.d/coder.env sudo rm /etc/coder.d/coder.env
``` ```
## Coder settings and the optional built-in PostgreSQL database ## Coder settings, cache, and the optional built-in PostgreSQL database
> There is a `postgres` directory within the `coderv2` directory that has the > There is a `postgres` directory within the `coderv2` directory that has the
> database engine and database. If you want to reuse the database, consider not > database engine and database. If you want to reuse the database, consider not
@ -89,6 +84,7 @@ rm -rf ~/Library/Application\ Support/coderv2
```shell ```shell
rm -rf ~/.config/coderv2 rm -rf ~/.config/coderv2
rm -rf ~/.cache/coder
``` ```
## Windows ## Windows

8
docs/reference/agent-api/debug.md
View File

@ -15,7 +15,7 @@ Get the first 10MiB of data from `$CODER_AGENT_LOG_DIR/coder-agent.log`.
### Responses ### Responses
| Status | Meaning | Description | Schema | | Status | Meaning | Description | Schema |
| ------ | ------------------------------------------------------- | ----------- | ------ | |--------|---------------------------------------------------------|-------------|--------|
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | | | 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | |
## Get debug info for magicsock ## Get debug info for magicsock
@ -48,13 +48,13 @@ for more information.
### Parameters ### Parameters
| Name | In | Type | Required | Description | | Name | In | Type | Required | Description |
| ------- | ---- | ------- | -------- | ------------------- | |---------|------|---------|----------|---------------------|
| `state` | path | boolean | true | Debug logging state | | `state` | path | boolean | true | Debug logging state |
### Responses ### Responses
| Status | Meaning | Description | Schema | | Status | Meaning | Description | Schema |
| ------ | ------------------------------------------------------- | ----------- | ------ | |--------|---------------------------------------------------------|-------------|--------|
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | | | 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | |
## Get debug manifest ## Get debug manifest
@ -72,5 +72,5 @@ Get the manifest the agent fetched from `coderd` upon startup.
### Responses ### Responses
| Status | Meaning | Description | Schema | | Status | Meaning | Description | Schema |
| ------ | ------------------------------------------------------- | ----------- | -------------------------------------------------- | |--------|---------------------------------------------------------|-------------|----------------------------------------------------|
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [agentsdk.Manifest](./schemas.md#agentsdkmanifest) | | 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [agentsdk.Manifest](./schemas.md#agentsdkmanifest) |

2
docs/reference/agent-api/index.md
View File

@ -1,4 +1,4 @@
## Sections # Sections
<children> <children>
This page is rendered on https://coder.com/docs/reference/agent-api. Refer to the other documents in the `agent-api/` directory. This page is rendered on https://coder.com/docs/reference/agent-api. Refer to the other documents in the `agent-api/` directory.

4
docs/reference/agent-api/schemas.md
View File

@ -83,7 +83,7 @@
### Properties ### Properties
| Name | Type | Required | Restrictions | Description | | Name | Type | Required | Restrictions | Description |
| ---------------------------- | ------------------------------------------------------------------------------------------------- | -------- | ------------ | ----------- | |------------------------------|---------------------------------------------------------------------------------------------------|----------|--------------|-------------|
| `agent_id` | string | true | | | | `agent_id` | string | true | | |
| `agent_name` | string | true | | | | `agent_name` | string | true | | |
| `owner_name` | string | true | | | | `owner_name` | string | true | | |
@ -116,7 +116,7 @@
### Properties ### Properties
| Name | Type | Required | Restrictions | Description | | Name | Type | Required | Restrictions | Description |
| -------------- | ------- | -------- | ------------ | ----------- | |----------------|---------|----------|--------------|-------------|
| `display_name` | string | true | | | | `display_name` | string | true | | |
| `key` | string | true | | | | `key` | string | true | | |
| `script` | string | true | | | | `script` | string | true | | |

78
docs/reference/api/agents.md generated
View File

@ -15,7 +15,7 @@ curl -X GET http://coder-server:8080/api/v2/derp-map \
### Responses ### Responses
| Status | Meaning | Description | Schema | | Status | Meaning | Description | Schema |
| ------ | ------------------------------------------------------------------------ | ------------------- | ------ | |--------|--------------------------------------------------------------------------|---------------------|--------|
| 101 | [Switching Protocols](https://tools.ietf.org/html/rfc7231#section-6.2.2) | Switching Protocols | | | 101 | [Switching Protocols](https://tools.ietf.org/html/rfc7231#section-6.2.2) | Switching Protocols | |
To perform this operation, you must be authenticated. [Learn more](authentication.md). To perform this operation, you must be authenticated. [Learn more](authentication.md).
@ -35,7 +35,7 @@ curl -X GET http://coder-server:8080/api/v2/tailnet \
### Responses ### Responses
| Status | Meaning | Description | Schema | | Status | Meaning | Description | Schema |
| ------ | ------------------------------------------------------------------------ | ------------------- | ------ | |--------|--------------------------------------------------------------------------|---------------------|--------|
| 101 | [Switching Protocols](https://tools.ietf.org/html/rfc7231#section-6.2.2) | Switching Protocols | | | 101 | [Switching Protocols](https://tools.ietf.org/html/rfc7231#section-6.2.2) | Switching Protocols | |
To perform this operation, you must be authenticated. [Learn more](authentication.md). To perform this operation, you must be authenticated. [Learn more](authentication.md).
@ -66,7 +66,7 @@ curl -X POST http://coder-server:8080/api/v2/workspaceagents/aws-instance-identi
### Parameters ### Parameters
| Name | In | Type | Required | Description | | Name | In | Type | Required | Description |
| ------ | ---- | -------------------------------------------------------------------------------- | -------- | ----------------------- | |--------|------|----------------------------------------------------------------------------------|----------|-------------------------|
| `body` | body | [agentsdk.AWSInstanceIdentityToken](schemas.md#agentsdkawsinstanceidentitytoken) | true | Instance identity token | | `body` | body | [agentsdk.AWSInstanceIdentityToken](schemas.md#agentsdkawsinstanceidentitytoken) | true | Instance identity token |
### Example responses ### Example responses
@ -82,7 +82,7 @@ curl -X POST http://coder-server:8080/api/v2/workspaceagents/aws-instance-identi
### Responses ### Responses
| Status | Meaning | Description | Schema | | Status | Meaning | Description | Schema |
| ------ | ------------------------------------------------------- | ----------- | ------------------------------------------------------------------------ | |--------|---------------------------------------------------------|-------------|--------------------------------------------------------------------------|
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [agentsdk.AuthenticateResponse](schemas.md#agentsdkauthenticateresponse) | | 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [agentsdk.AuthenticateResponse](schemas.md#agentsdkauthenticateresponse) |
To perform this operation, you must be authenticated. [Learn more](authentication.md). To perform this operation, you must be authenticated. [Learn more](authentication.md).
@ -113,7 +113,7 @@ curl -X POST http://coder-server:8080/api/v2/workspaceagents/azure-instance-iden
### Parameters ### Parameters
| Name | In | Type | Required | Description | | Name | In | Type | Required | Description |
| ------ | ---- | ------------------------------------------------------------------------------------ | -------- | ----------------------- | |--------|------|--------------------------------------------------------------------------------------|----------|-------------------------|
| `body` | body | [agentsdk.AzureInstanceIdentityToken](schemas.md#agentsdkazureinstanceidentitytoken) | true | Instance identity token | | `body` | body | [agentsdk.AzureInstanceIdentityToken](schemas.md#agentsdkazureinstanceidentitytoken) | true | Instance identity token |
### Example responses ### Example responses
@ -129,7 +129,7 @@ curl -X POST http://coder-server:8080/api/v2/workspaceagents/azure-instance-iden
### Responses ### Responses
| Status | Meaning | Description | Schema | | Status | Meaning | Description | Schema |
| ------ | ------------------------------------------------------- | ----------- | ------------------------------------------------------------------------ | |--------|---------------------------------------------------------|-------------|--------------------------------------------------------------------------|
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [agentsdk.AuthenticateResponse](schemas.md#agentsdkauthenticateresponse) | | 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [agentsdk.AuthenticateResponse](schemas.md#agentsdkauthenticateresponse) |
To perform this operation, you must be authenticated. [Learn more](authentication.md). To perform this operation, you must be authenticated. [Learn more](authentication.md).
@ -159,7 +159,7 @@ curl -X POST http://coder-server:8080/api/v2/workspaceagents/google-instance-ide
### Parameters ### Parameters
| Name | In | Type | Required | Description | | Name | In | Type | Required | Description |
| ------ | ---- | -------------------------------------------------------------------------------------- | -------- | ----------------------- | |--------|------|----------------------------------------------------------------------------------------|----------|-------------------------|
| `body` | body | [agentsdk.GoogleInstanceIdentityToken](schemas.md#agentsdkgoogleinstanceidentitytoken) | true | Instance identity token | | `body` | body | [agentsdk.GoogleInstanceIdentityToken](schemas.md#agentsdkgoogleinstanceidentitytoken) | true | Instance identity token |
### Example responses ### Example responses
@ -175,7 +175,7 @@ curl -X POST http://coder-server:8080/api/v2/workspaceagents/google-instance-ide
### Responses ### Responses
| Status | Meaning | Description | Schema | | Status | Meaning | Description | Schema |
| ------ | ------------------------------------------------------- | ----------- | ------------------------------------------------------------------------ | |--------|---------------------------------------------------------|-------------|--------------------------------------------------------------------------|
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [agentsdk.AuthenticateResponse](schemas.md#agentsdkauthenticateresponse) | | 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [agentsdk.AuthenticateResponse](schemas.md#agentsdkauthenticateresponse) |
To perform this operation, you must be authenticated. [Learn more](authentication.md). To perform this operation, you must be authenticated. [Learn more](authentication.md).
@ -196,7 +196,7 @@ curl -X GET http://coder-server:8080/api/v2/workspaceagents/me/external-auth?mat
### Parameters ### Parameters
| Name | In | Type | Required | Description | | Name | In | Type | Required | Description |
| -------- | ----- | ------- | -------- | --------------------------------- | |----------|-------|---------|----------|-----------------------------------|
| `match` | query | string | true | Match | | `match` | query | string | true | Match |
| `id` | query | string | true | Provider ID | | `id` | query | string | true | Provider ID |
| `listen` | query | boolean | false | Wait for a new token to be issued | | `listen` | query | boolean | false | Wait for a new token to be issued |
@ -219,7 +219,7 @@ curl -X GET http://coder-server:8080/api/v2/workspaceagents/me/external-auth?mat
### Responses ### Responses
| Status | Meaning | Description | Schema | | Status | Meaning | Description | Schema |
| ------ | ------------------------------------------------------- | ----------- | ------------------------------------------------------------------------ | |--------|---------------------------------------------------------|-------------|--------------------------------------------------------------------------|
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [agentsdk.ExternalAuthResponse](schemas.md#agentsdkexternalauthresponse) | | 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [agentsdk.ExternalAuthResponse](schemas.md#agentsdkexternalauthresponse) |
To perform this operation, you must be authenticated. [Learn more](authentication.md). To perform this operation, you must be authenticated. [Learn more](authentication.md).
@ -240,7 +240,7 @@ curl -X GET http://coder-server:8080/api/v2/workspaceagents/me/gitauth?match=str
### Parameters ### Parameters
| Name | In | Type | Required | Description | | Name | In | Type | Required | Description |
| -------- | ----- | ------- | -------- | --------------------------------- | |----------|-------|---------|----------|-----------------------------------|
| `match` | query | string | true | Match | | `match` | query | string | true | Match |
| `id` | query | string | true | Provider ID | | `id` | query | string | true | Provider ID |
| `listen` | query | boolean | false | Wait for a new token to be issued | | `listen` | query | boolean | false | Wait for a new token to be issued |
@ -263,7 +263,7 @@ curl -X GET http://coder-server:8080/api/v2/workspaceagents/me/gitauth?match=str
### Responses ### Responses
| Status | Meaning | Description | Schema | | Status | Meaning | Description | Schema |
| ------ | ------------------------------------------------------- | ----------- | ------------------------------------------------------------------------ | |--------|---------------------------------------------------------|-------------|--------------------------------------------------------------------------|
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [agentsdk.ExternalAuthResponse](schemas.md#agentsdkexternalauthresponse) | | 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [agentsdk.ExternalAuthResponse](schemas.md#agentsdkexternalauthresponse) |
To perform this operation, you must be authenticated. [Learn more](authentication.md). To perform this operation, you must be authenticated. [Learn more](authentication.md).
@ -295,7 +295,7 @@ curl -X GET http://coder-server:8080/api/v2/workspaceagents/me/gitsshkey \
### Responses ### Responses
| Status | Meaning | Description | Schema | | Status | Meaning | Description | Schema |
| ------ | ------------------------------------------------------- | ----------- | -------------------------------------------------- | |--------|---------------------------------------------------------|-------------|----------------------------------------------------|
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [agentsdk.GitSSHKey](schemas.md#agentsdkgitsshkey) | | 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [agentsdk.GitSSHKey](schemas.md#agentsdkgitsshkey) |
To perform this operation, you must be authenticated. [Learn more](authentication.md). To perform this operation, you must be authenticated. [Learn more](authentication.md).
@ -327,7 +327,7 @@ curl -X POST http://coder-server:8080/api/v2/workspaceagents/me/log-source \
### Parameters ### Parameters
| Name | In | Type | Required | Description | | Name | In | Type | Required | Description |
| ------ | ---- | ------------------------------------------------------------------------ | -------- | ------------------ | |--------|------|--------------------------------------------------------------------------|----------|--------------------|
| `body` | body | [agentsdk.PostLogSourceRequest](schemas.md#agentsdkpostlogsourcerequest) | true | Log source request | | `body` | body | [agentsdk.PostLogSourceRequest](schemas.md#agentsdkpostlogsourcerequest) | true | Log source request |
### Example responses ### Example responses
@ -347,7 +347,7 @@ curl -X POST http://coder-server:8080/api/v2/workspaceagents/me/log-source \
### Responses ### Responses
| Status | Meaning | Description | Schema | | Status | Meaning | Description | Schema |
| ------ | ------------------------------------------------------- | ----------- | ------------------------------------------------------------------------------ | |--------|---------------------------------------------------------|-------------|--------------------------------------------------------------------------------|
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.WorkspaceAgentLogSource](schemas.md#codersdkworkspaceagentlogsource) | | 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.WorkspaceAgentLogSource](schemas.md#codersdkworkspaceagentlogsource) |
To perform this operation, you must be authenticated. [Learn more](authentication.md). To perform this operation, you must be authenticated. [Learn more](authentication.md).
@ -384,7 +384,7 @@ curl -X PATCH http://coder-server:8080/api/v2/workspaceagents/me/logs \
### Parameters ### Parameters
| Name | In | Type | Required | Description | | Name | In | Type | Required | Description |
| ------ | ---- | -------------------------------------------------- | -------- | ----------- | |--------|------|----------------------------------------------------|----------|-------------|
| `body` | body | [agentsdk.PatchLogs](schemas.md#agentsdkpatchlogs) | true | logs | | `body` | body | [agentsdk.PatchLogs](schemas.md#agentsdkpatchlogs) | true | logs |
### Example responses ### Example responses
@ -407,7 +407,7 @@ curl -X PATCH http://coder-server:8080/api/v2/workspaceagents/me/logs \
### Responses ### Responses
| Status | Meaning | Description | Schema | | Status | Meaning | Description | Schema |
| ------ | ------------------------------------------------------- | ----------- | ------------------------------------------------ | |--------|---------------------------------------------------------|-------------|--------------------------------------------------|
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.Response](schemas.md#codersdkresponse) | | 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.Response](schemas.md#codersdkresponse) |
To perform this operation, you must be authenticated. [Learn more](authentication.md). To perform this operation, you must be authenticated. [Learn more](authentication.md).
@ -428,7 +428,7 @@ curl -X GET http://coder-server:8080/api/v2/workspaceagents/{workspaceagent} \
### Parameters ### Parameters
| Name | In | Type | Required | Description | | Name | In | Type | Required | Description |
| ---------------- | ---- | ------------ | -------- | ------------------ | |------------------|------|--------------|----------|--------------------|
| `workspaceagent` | path | string(uuid) | true | Workspace agent ID | | `workspaceagent` | path | string(uuid) | true | Workspace agent ID |
### Example responses ### Example responses
@ -465,7 +465,9 @@ curl -X GET http://coder-server:8080/api/v2/workspaceagents/{workspaceagent} \
"created_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z",
"directory": "string", "directory": "string",
"disconnected_at": "2019-08-24T14:15:22Z", "disconnected_at": "2019-08-24T14:15:22Z",
"display_apps": ["vscode"], "display_apps": [
"vscode"
],
"environment_variables": { "environment_variables": {
"property1": "string", "property1": "string",
"property2": "string" "property2": "string"
@ -522,7 +524,9 @@ curl -X GET http://coder-server:8080/api/v2/workspaceagents/{workspaceagent} \
"started_at": "2019-08-24T14:15:22Z", "started_at": "2019-08-24T14:15:22Z",
"startup_script_behavior": "blocking", "startup_script_behavior": "blocking",
"status": "connecting", "status": "connecting",
"subsystems": ["envbox"], "subsystems": [
"envbox"
],
"troubleshooting_url": "string", "troubleshooting_url": "string",
"updated_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z",
"version": "string" "version": "string"
@ -532,7 +536,7 @@ curl -X GET http://coder-server:8080/api/v2/workspaceagents/{workspaceagent} \
### Responses ### Responses
| Status | Meaning | Description | Schema | | Status | Meaning | Description | Schema |
| ------ | ------------------------------------------------------- | ----------- | ------------------------------------------------------------ | |--------|---------------------------------------------------------|-------------|--------------------------------------------------------------|
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.WorkspaceAgent](schemas.md#codersdkworkspaceagent) | | 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.WorkspaceAgent](schemas.md#codersdkworkspaceagent) |
To perform this operation, you must be authenticated. [Learn more](authentication.md). To perform this operation, you must be authenticated. [Learn more](authentication.md).
@ -553,7 +557,7 @@ curl -X GET http://coder-server:8080/api/v2/workspaceagents/{workspaceagent}/con
### Parameters ### Parameters
| Name | In | Type | Required | Description | | Name | In | Type | Required | Description |
| ---------------- | ---- | ------------ | -------- | ------------------ | |------------------|------|--------------|----------|--------------------|
| `workspaceagent` | path | string(uuid) | true | Workspace agent ID | | `workspaceagent` | path | string(uuid) | true | Workspace agent ID |
### Example responses ### Example responses
@ -629,7 +633,7 @@ curl -X GET http://coder-server:8080/api/v2/workspaceagents/{workspaceagent}/con
### Responses ### Responses
| Status | Meaning | Description | Schema | | Status | Meaning | Description | Schema |
| ------ | ------------------------------------------------------- | ----------- | ------------------------------------------------------------------------------ | |--------|---------------------------------------------------------|-------------|--------------------------------------------------------------------------------|
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [workspacesdk.AgentConnectionInfo](schemas.md#workspacesdkagentconnectioninfo) | | 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [workspacesdk.AgentConnectionInfo](schemas.md#workspacesdkagentconnectioninfo) |
To perform this operation, you must be authenticated. [Learn more](authentication.md). To perform this operation, you must be authenticated. [Learn more](authentication.md).
@ -649,13 +653,13 @@ curl -X GET http://coder-server:8080/api/v2/workspaceagents/{workspaceagent}/coo
### Parameters ### Parameters
| Name | In | Type | Required | Description | | Name | In | Type | Required | Description |
| ---------------- | ---- | ------------ | -------- | ------------------ | |------------------|------|--------------|----------|--------------------|
| `workspaceagent` | path | string(uuid) | true | Workspace agent ID | | `workspaceagent` | path | string(uuid) | true | Workspace agent ID |
### Responses ### Responses
| Status | Meaning | Description | Schema | | Status | Meaning | Description | Schema |
| ------ | ------------------------------------------------------------------------ | ------------------- | ------ | |--------|--------------------------------------------------------------------------|---------------------|--------|
| 101 | [Switching Protocols](https://tools.ietf.org/html/rfc7231#section-6.2.2) | Switching Protocols | | | 101 | [Switching Protocols](https://tools.ietf.org/html/rfc7231#section-6.2.2) | Switching Protocols | |
To perform this operation, you must be authenticated. [Learn more](authentication.md). To perform this operation, you must be authenticated. [Learn more](authentication.md).
@ -676,7 +680,7 @@ curl -X GET http://coder-server:8080/api/v2/workspaceagents/{workspaceagent}/lis
### Parameters ### Parameters
| Name | In | Type | Required | Description | | Name | In | Type | Required | Description |
| ---------------- | ---- | ------------ | -------- | ------------------ | |------------------|------|--------------|----------|--------------------|
| `workspaceagent` | path | string(uuid) | true | Workspace agent ID | | `workspaceagent` | path | string(uuid) | true | Workspace agent ID |
### Example responses ### Example responses
@ -698,7 +702,7 @@ curl -X GET http://coder-server:8080/api/v2/workspaceagents/{workspaceagent}/lis
### Responses ### Responses
| Status | Meaning | Description | Schema | | Status | Meaning | Description | Schema |
| ------ | ------------------------------------------------------- | ----------- | -------------------------------------------------------------------------------------------------------- | |--------|---------------------------------------------------------|-------------|----------------------------------------------------------------------------------------------------------|
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.WorkspaceAgentListeningPortsResponse](schemas.md#codersdkworkspaceagentlisteningportsresponse) | | 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.WorkspaceAgentListeningPortsResponse](schemas.md#codersdkworkspaceagentlisteningportsresponse) |
To perform this operation, you must be authenticated. [Learn more](authentication.md). To perform this operation, you must be authenticated. [Learn more](authentication.md).
@ -719,7 +723,7 @@ curl -X GET http://coder-server:8080/api/v2/workspaceagents/{workspaceagent}/log
### Parameters ### Parameters
| Name | In | Type | Required | Description | | Name | In | Type | Required | Description |
| ---------------- | ----- | ------------ | -------- | -------------------------------------------- | |------------------|-------|--------------|----------|----------------------------------------------|
| `workspaceagent` | path | string(uuid) | true | Workspace agent ID | | `workspaceagent` | path | string(uuid) | true | Workspace agent ID |
| `before` | query | integer | false | Before log id | | `before` | query | integer | false | Before log id |
| `after` | query | integer | false | After log id | | `after` | query | integer | false | After log id |
@ -745,7 +749,7 @@ curl -X GET http://coder-server:8080/api/v2/workspaceagents/{workspaceagent}/log
### Responses ### Responses
| Status | Meaning | Description | Schema | | Status | Meaning | Description | Schema |
| ------ | ------------------------------------------------------- | ----------- | --------------------------------------------------------------------------- | |--------|---------------------------------------------------------|-------------|-----------------------------------------------------------------------------|
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | array of [codersdk.WorkspaceAgentLog](schemas.md#codersdkworkspaceagentlog) | | 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | array of [codersdk.WorkspaceAgentLog](schemas.md#codersdkworkspaceagentlog) |
<h3 id="get-logs-by-workspace-agent-responseschema">Response Schema</h3> <h3 id="get-logs-by-workspace-agent-responseschema">Response Schema</h3>
@ -753,7 +757,7 @@ curl -X GET http://coder-server:8080/api/v2/workspaceagents/{workspaceagent}/log
Status Code **200** Status Code **200**
| Name | Type | Required | Restrictions | Description | | Name | Type | Required | Restrictions | Description |
| -------------- | ------------------------------------------------ | -------- | ------------ | ----------- | |----------------|--------------------------------------------------|----------|--------------|-------------|
| `[array item]` | array | false | | | | `[array item]` | array | false | | |
| `» created_at` | string(date-time) | false | | | | `» created_at` | string(date-time) | false | | |
| `» id` | integer | false | | | | `» id` | integer | false | | |
@ -764,7 +768,7 @@ Status Code **200**
#### Enumerated Values #### Enumerated Values
| Property | Value | | Property | Value |
| -------- | ------- | |----------|---------|
| `level` | `trace` | | `level` | `trace` |
| `level` | `debug` | | `level` | `debug` |
| `level` | `info` | | `level` | `info` |
@ -788,13 +792,13 @@ curl -X GET http://coder-server:8080/api/v2/workspaceagents/{workspaceagent}/pty
### Parameters ### Parameters
| Name | In | Type | Required | Description | | Name | In | Type | Required | Description |
| ---------------- | ---- | ------------ | -------- | ------------------ | |------------------|------|--------------|----------|--------------------|
| `workspaceagent` | path | string(uuid) | true | Workspace agent ID | | `workspaceagent` | path | string(uuid) | true | Workspace agent ID |
### Responses ### Responses
| Status | Meaning | Description | Schema | | Status | Meaning | Description | Schema |
| ------ | ------------------------------------------------------------------------ | ------------------- | ------ | |--------|--------------------------------------------------------------------------|---------------------|--------|
| 101 | [Switching Protocols](https://tools.ietf.org/html/rfc7231#section-6.2.2) | Switching Protocols | | | 101 | [Switching Protocols](https://tools.ietf.org/html/rfc7231#section-6.2.2) | Switching Protocols | |
To perform this operation, you must be authenticated. [Learn more](authentication.md). To perform this operation, you must be authenticated. [Learn more](authentication.md).
@ -815,7 +819,7 @@ curl -X GET http://coder-server:8080/api/v2/workspaceagents/{workspaceagent}/sta
### Parameters ### Parameters
| Name | In | Type | Required | Description | | Name | In | Type | Required | Description |
| ---------------- | ----- | ------------ | -------- | -------------------------------------------- | |------------------|-------|--------------|----------|----------------------------------------------|
| `workspaceagent` | path | string(uuid) | true | Workspace agent ID | | `workspaceagent` | path | string(uuid) | true | Workspace agent ID |
| `before` | query | integer | false | Before log id | | `before` | query | integer | false | Before log id |
| `after` | query | integer | false | After log id | | `after` | query | integer | false | After log id |
@ -841,7 +845,7 @@ curl -X GET http://coder-server:8080/api/v2/workspaceagents/{workspaceagent}/sta
### Responses ### Responses
| Status | Meaning | Description | Schema | | Status | Meaning | Description | Schema |
| ------ | ------------------------------------------------------- | ----------- | --------------------------------------------------------------------------- | |--------|---------------------------------------------------------|-------------|-----------------------------------------------------------------------------|
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | array of [codersdk.WorkspaceAgentLog](schemas.md#codersdkworkspaceagentlog) | | 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | array of [codersdk.WorkspaceAgentLog](schemas.md#codersdkworkspaceagentlog) |
<h3 id="removed:-get-logs-by-workspace-agent-responseschema">Response Schema</h3> <h3 id="removed:-get-logs-by-workspace-agent-responseschema">Response Schema</h3>
@ -849,7 +853,7 @@ curl -X GET http://coder-server:8080/api/v2/workspaceagents/{workspaceagent}/sta
Status Code **200** Status Code **200**
| Name | Type | Required | Restrictions | Description | | Name | Type | Required | Restrictions | Description |
| -------------- | ------------------------------------------------ | -------- | ------------ | ----------- | |----------------|--------------------------------------------------|----------|--------------|-------------|
| `[array item]` | array | false | | | | `[array item]` | array | false | | |
| `» created_at` | string(date-time) | false | | | | `» created_at` | string(date-time) | false | | |
| `» id` | integer | false | | | | `» id` | integer | false | | |
@ -860,7 +864,7 @@ Status Code **200**
#### Enumerated Values #### Enumerated Values
| Property | Value | | Property | Value |
| -------- | ------- | |----------|---------|
| `level` | `trace` | | `level` | `trace` |
| `level` | `debug` | | `level` | `debug` |
| `level` | `info` | | `level` | `info` |

6
docs/reference/api/applications.md generated
View File

@ -15,13 +15,13 @@ curl -X GET http://coder-server:8080/api/v2/applications/auth-redirect \
### Parameters ### Parameters
| Name | In | Type | Required | Description | | Name | In | Type | Required | Description |
| -------------- | ----- | ------ | -------- | -------------------- | |----------------|-------|--------|----------|----------------------|
| `redirect_uri` | query | string | false | Redirect destination | | `redirect_uri` | query | string | false | Redirect destination |
### Responses ### Responses
| Status | Meaning | Description | Schema | | Status | Meaning | Description | Schema |
| ------ | ----------------------------------------------------------------------- | ------------------ | ------ | |--------|-------------------------------------------------------------------------|--------------------|--------|
| 307 | [Temporary Redirect](https://tools.ietf.org/html/rfc7231#section-6.4.7) | Temporary Redirect | | | 307 | [Temporary Redirect](https://tools.ietf.org/html/rfc7231#section-6.4.7) | Temporary Redirect | |
To perform this operation, you must be authenticated. [Learn more](authentication.md). To perform this operation, you must be authenticated. [Learn more](authentication.md).
@ -52,7 +52,7 @@ curl -X GET http://coder-server:8080/api/v2/applications/host \
### Responses ### Responses
| Status | Meaning | Description | Schema | | Status | Meaning | Description | Schema |
| ------ | ------------------------------------------------------- | ----------- | -------------------------------------------------------------- | |--------|---------------------------------------------------------|-------------|----------------------------------------------------------------|
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.AppHostResponse](schemas.md#codersdkapphostresponse) | | 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.AppHostResponse](schemas.md#codersdkapphostresponse) |
To perform this operation, you must be authenticated. [Learn more](authentication.md). To perform this operation, you must be authenticated. [Learn more](authentication.md).

12
docs/reference/api/audit.md generated
View File

@ -16,7 +16,7 @@ curl -X GET http://coder-server:8080/api/v2/audit?limit=0 \
### Parameters ### Parameters
| Name | In | Type | Required | Description | | Name | In | Type | Required | Description |
| -------- | ----- | ------- | -------- | ------------ | |----------|-------|---------|----------|--------------|
| `q` | query | string | false | Search query | | `q` | query | string | false | Search query |
| `limit` | query | integer | true | Page limit | | `limit` | query | integer | true | Page limit |
| `offset` | query | integer | false | Page offset | | `offset` | query | integer | false | Page offset |
@ -30,7 +30,9 @@ curl -X GET http://coder-server:8080/api/v2/audit?limit=0 \
"audit_logs": [ "audit_logs": [
{ {
"action": "create", "action": "create",
"additional_fields": [0], "additional_fields": [
0
],
"description": "string", "description": "string",
"diff": { "diff": {
"property1": { "property1": {
@ -70,7 +72,9 @@ curl -X GET http://coder-server:8080/api/v2/audit?limit=0 \
"last_seen_at": "2019-08-24T14:15:22Z", "last_seen_at": "2019-08-24T14:15:22Z",
"login_type": "", "login_type": "",
"name": "string", "name": "string",
"organization_ids": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"], "organization_ids": [
"497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"roles": [ "roles": [
{ {
"display_name": "string", "display_name": "string",
@ -93,7 +97,7 @@ curl -X GET http://coder-server:8080/api/v2/audit?limit=0 \
### Responses ### Responses
| Status | Meaning | Description | Schema | | Status | Meaning | Description | Schema |
| ------ | ------------------------------------------------------- | ----------- | ---------------------------------------------------------------- | |--------|---------------------------------------------------------|-------------|------------------------------------------------------------------|
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.AuditLogResponse](schemas.md#codersdkauditlogresponse) | | 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.AuditLogResponse](schemas.md#codersdkauditlogresponse) |
To perform this operation, you must be authenticated. [Learn more](authentication.md). To perform this operation, you must be authenticated. [Learn more](authentication.md).

24
docs/reference/api/authorization.md generated
View File

@ -46,7 +46,7 @@ curl -X POST http://coder-server:8080/api/v2/authcheck \
### Parameters ### Parameters
| Name | In | Type | Required | Description | | Name | In | Type | Required | Description |
| ------ | ---- | ------------------------------------------------------------------------ | -------- | --------------------- | |--------|------|--------------------------------------------------------------------------|----------|-----------------------|
| `body` | body | [codersdk.AuthorizationRequest](schemas.md#codersdkauthorizationrequest) | true | Authorization request | | `body` | body | [codersdk.AuthorizationRequest](schemas.md#codersdkauthorizationrequest) | true | Authorization request |
### Example responses ### Example responses
@ -63,7 +63,7 @@ curl -X POST http://coder-server:8080/api/v2/authcheck \
### Responses ### Responses
| Status | Meaning | Description | Schema | | Status | Meaning | Description | Schema |
| ------ | ------------------------------------------------------- | ----------- | -------------------------------------------------------------------------- | |--------|---------------------------------------------------------|-------------|----------------------------------------------------------------------------|
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.AuthorizationResponse](schemas.md#codersdkauthorizationresponse) | | 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.AuthorizationResponse](schemas.md#codersdkauthorizationresponse) |
To perform this operation, you must be authenticated. [Learn more](authentication.md). To perform this operation, you must be authenticated. [Learn more](authentication.md).
@ -93,7 +93,7 @@ curl -X POST http://coder-server:8080/api/v2/users/login \
### Parameters ### Parameters
| Name | In | Type | Required | Description | | Name | In | Type | Required | Description |
| ------ | ---- | -------------------------------------------------------------------------------- | -------- | ------------- | |--------|------|----------------------------------------------------------------------------------|----------|---------------|
| `body` | body | [codersdk.LoginWithPasswordRequest](schemas.md#codersdkloginwithpasswordrequest) | true | Login request | | `body` | body | [codersdk.LoginWithPasswordRequest](schemas.md#codersdkloginwithpasswordrequest) | true | Login request |
### Example responses ### Example responses
@ -109,7 +109,7 @@ curl -X POST http://coder-server:8080/api/v2/users/login \
### Responses ### Responses
| Status | Meaning | Description | Schema | | Status | Meaning | Description | Schema |
| ------ | ------------------------------------------------------------ | ----------- | ---------------------------------------------------------------------------------- | |--------|--------------------------------------------------------------|-------------|------------------------------------------------------------------------------------|
| 201 | [Created](https://tools.ietf.org/html/rfc7231#section-6.3.2) | Created | [codersdk.LoginWithPasswordResponse](schemas.md#codersdkloginwithpasswordresponse) | | 201 | [Created](https://tools.ietf.org/html/rfc7231#section-6.3.2) | Created | [codersdk.LoginWithPasswordResponse](schemas.md#codersdkloginwithpasswordresponse) |
## Change password with a one-time passcode ## Change password with a one-time passcode
@ -137,13 +137,13 @@ curl -X POST http://coder-server:8080/api/v2/users/otp/change-password \
### Parameters ### Parameters
| Name | In | Type | Required | Description | | Name | In | Type | Required | Description |
| ------ | ---- | ---------------------------------------------------------------------------------------------------------------- | -------- | ----------------------- | |--------|------|------------------------------------------------------------------------------------------------------------------|----------|-------------------------|
| `body` | body | [codersdk.ChangePasswordWithOneTimePasscodeRequest](schemas.md#codersdkchangepasswordwithonetimepasscoderequest) | true | Change password request | | `body` | body | [codersdk.ChangePasswordWithOneTimePasscodeRequest](schemas.md#codersdkchangepasswordwithonetimepasscoderequest) | true | Change password request |
### Responses ### Responses
| Status | Meaning | Description | Schema | | Status | Meaning | Description | Schema |
| ------ | --------------------------------------------------------------- | ----------- | ------ | |--------|-----------------------------------------------------------------|-------------|--------|
| 204 | [No Content](https://tools.ietf.org/html/rfc7231#section-6.3.5) | No Content | | | 204 | [No Content](https://tools.ietf.org/html/rfc7231#section-6.3.5) | No Content | |
## Request one-time passcode ## Request one-time passcode
@ -169,13 +169,13 @@ curl -X POST http://coder-server:8080/api/v2/users/otp/request \
### Parameters ### Parameters
| Name | In | Type | Required | Description | | Name | In | Type | Required | Description |
| ------ | ---- | ------------------------------------------------------------------------------------------ | -------- | ------------------------- | |--------|------|--------------------------------------------------------------------------------------------|----------|---------------------------|
| `body` | body | [codersdk.RequestOneTimePasscodeRequest](schemas.md#codersdkrequestonetimepasscoderequest) | true | One-time passcode request | | `body` | body | [codersdk.RequestOneTimePasscodeRequest](schemas.md#codersdkrequestonetimepasscoderequest) | true | One-time passcode request |
### Responses ### Responses
| Status | Meaning | Description | Schema | | Status | Meaning | Description | Schema |
| ------ | --------------------------------------------------------------- | ----------- | ------ | |--------|-----------------------------------------------------------------|-------------|--------|
| 204 | [No Content](https://tools.ietf.org/html/rfc7231#section-6.3.5) | No Content | | | 204 | [No Content](https://tools.ietf.org/html/rfc7231#section-6.3.5) | No Content | |
## Validate user password ## Validate user password
@ -203,7 +203,7 @@ curl -X POST http://coder-server:8080/api/v2/users/validate-password \
### Parameters ### Parameters
| Name | In | Type | Required | Description | | Name | In | Type | Required | Description |
| ------ | ---- | -------------------------------------------------------------------------------------- | -------- | ------------------------------ | |--------|------|----------------------------------------------------------------------------------------|----------|--------------------------------|
| `body` | body | [codersdk.ValidateUserPasswordRequest](schemas.md#codersdkvalidateuserpasswordrequest) | true | Validate user password request | | `body` | body | [codersdk.ValidateUserPasswordRequest](schemas.md#codersdkvalidateuserpasswordrequest) | true | Validate user password request |
### Example responses ### Example responses
@ -220,7 +220,7 @@ curl -X POST http://coder-server:8080/api/v2/users/validate-password \
### Responses ### Responses
| Status | Meaning | Description | Schema | | Status | Meaning | Description | Schema |
| ------ | ------------------------------------------------------- | ----------- | ---------------------------------------------------------------------------------------- | |--------|---------------------------------------------------------|-------------|------------------------------------------------------------------------------------------|
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.ValidateUserPasswordResponse](schemas.md#codersdkvalidateuserpasswordresponse) | | 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.ValidateUserPasswordResponse](schemas.md#codersdkvalidateuserpasswordresponse) |
To perform this operation, you must be authenticated. [Learn more](authentication.md). To perform this operation, you must be authenticated. [Learn more](authentication.md).
@ -251,7 +251,7 @@ curl -X POST http://coder-server:8080/api/v2/users/{user}/convert-login \
### Parameters ### Parameters
| Name | In | Type | Required | Description | | Name | In | Type | Required | Description |
| ------ | ---- | ---------------------------------------------------------------------- | -------- | -------------------- | |--------|------|------------------------------------------------------------------------|----------|----------------------|
| `user` | path | string | true | User ID, name, or me | | `user` | path | string | true | User ID, name, or me |
| `body` | body | [codersdk.ConvertLoginRequest](schemas.md#codersdkconvertloginrequest) | true | Convert request | | `body` | body | [codersdk.ConvertLoginRequest](schemas.md#codersdkconvertloginrequest) | true | Convert request |
@ -271,7 +271,7 @@ curl -X POST http://coder-server:8080/api/v2/users/{user}/convert-login \
### Responses ### Responses
| Status | Meaning | Description | Schema | | Status | Meaning | Description | Schema |
| ------ | ------------------------------------------------------------ | ----------- | ------------------------------------------------------------------------------ | |--------|--------------------------------------------------------------|-------------|--------------------------------------------------------------------------------|
| 201 | [Created](https://tools.ietf.org/html/rfc7231#section-6.3.2) | Created | [codersdk.OAuthConversionResponse](schemas.md#codersdkoauthconversionresponse) | | 201 | [Created](https://tools.ietf.org/html/rfc7231#section-6.3.2) | Created | [codersdk.OAuthConversionResponse](schemas.md#codersdkoauthconversionresponse) |
To perform this operation, you must be authenticated. [Learn more](authentication.md). To perform this operation, you must be authenticated. [Learn more](authentication.md).

106
docs/reference/api/builds.md generated
View File

@ -16,7 +16,7 @@ curl -X GET http://coder-server:8080/api/v2/users/{user}/workspace/{workspacenam
### Parameters ### Parameters
| Name | In | Type | Required | Description | | Name | In | Type | Required | Description |
| --------------- | ---- | -------------- | -------- | -------------------- | |-----------------|------|----------------|----------|----------------------|
| `user` | path | string | true | User ID, name, or me | | `user` | path | string | true | User ID, name, or me |
| `workspacename` | path | string | true | Workspace name | | `workspacename` | path | string | true | Workspace name |
| `buildnumber` | path | string(number) | true | Build number | | `buildnumber` | path | string(number) | true | Build number |
@ -91,7 +91,9 @@ curl -X GET http://coder-server:8080/api/v2/users/{user}/workspace/{workspacenam
"created_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z",
"directory": "string", "directory": "string",
"disconnected_at": "2019-08-24T14:15:22Z", "disconnected_at": "2019-08-24T14:15:22Z",
"display_apps": ["vscode"], "display_apps": [
"vscode"
],
"environment_variables": { "environment_variables": {
"property1": "string", "property1": "string",
"property2": "string" "property2": "string"
@ -148,7 +150,9 @@ curl -X GET http://coder-server:8080/api/v2/users/{user}/workspace/{workspacenam
"started_at": "2019-08-24T14:15:22Z", "started_at": "2019-08-24T14:15:22Z",
"startup_script_behavior": "blocking", "startup_script_behavior": "blocking",
"status": "connecting", "status": "connecting",
"subsystems": ["envbox"], "subsystems": [
"envbox"
],
"troubleshooting_url": "string", "troubleshooting_url": "string",
"updated_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z",
"version": "string" "version": "string"
@ -188,7 +192,7 @@ curl -X GET http://coder-server:8080/api/v2/users/{user}/workspace/{workspacenam
### Responses ### Responses
| Status | Meaning | Description | Schema | | Status | Meaning | Description | Schema |
| ------ | ------------------------------------------------------- | ----------- | ------------------------------------------------------------ | |--------|---------------------------------------------------------|-------------|--------------------------------------------------------------|
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.WorkspaceBuild](schemas.md#codersdkworkspacebuild) | | 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.WorkspaceBuild](schemas.md#codersdkworkspacebuild) |
To perform this operation, you must be authenticated. [Learn more](authentication.md). To perform this operation, you must be authenticated. [Learn more](authentication.md).
@ -209,7 +213,7 @@ curl -X GET http://coder-server:8080/api/v2/workspacebuilds/{workspacebuild} \
### Parameters ### Parameters
| Name | In | Type | Required | Description | | Name | In | Type | Required | Description |
| ---------------- | ---- | ------ | -------- | ------------------ | |------------------|------|--------|----------|--------------------|
| `workspacebuild` | path | string | true | Workspace build ID | | `workspacebuild` | path | string | true | Workspace build ID |
### Example responses ### Example responses
@ -282,7 +286,9 @@ curl -X GET http://coder-server:8080/api/v2/workspacebuilds/{workspacebuild} \
"created_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z",
"directory": "string", "directory": "string",
"disconnected_at": "2019-08-24T14:15:22Z", "disconnected_at": "2019-08-24T14:15:22Z",
"display_apps": ["vscode"], "display_apps": [
"vscode"
],
"environment_variables": { "environment_variables": {
"property1": "string", "property1": "string",
"property2": "string" "property2": "string"
@ -339,7 +345,9 @@ curl -X GET http://coder-server:8080/api/v2/workspacebuilds/{workspacebuild} \
"started_at": "2019-08-24T14:15:22Z", "started_at": "2019-08-24T14:15:22Z",
"startup_script_behavior": "blocking", "startup_script_behavior": "blocking",
"status": "connecting", "status": "connecting",
"subsystems": ["envbox"], "subsystems": [
"envbox"
],
"troubleshooting_url": "string", "troubleshooting_url": "string",
"updated_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z",
"version": "string" "version": "string"
@ -379,7 +387,7 @@ curl -X GET http://coder-server:8080/api/v2/workspacebuilds/{workspacebuild} \
### Responses ### Responses
| Status | Meaning | Description | Schema | | Status | Meaning | Description | Schema |
| ------ | ------------------------------------------------------- | ----------- | ------------------------------------------------------------ | |--------|---------------------------------------------------------|-------------|--------------------------------------------------------------|
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.WorkspaceBuild](schemas.md#codersdkworkspacebuild) | | 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.WorkspaceBuild](schemas.md#codersdkworkspacebuild) |
To perform this operation, you must be authenticated. [Learn more](authentication.md). To perform this operation, you must be authenticated. [Learn more](authentication.md).
@ -400,7 +408,7 @@ curl -X PATCH http://coder-server:8080/api/v2/workspacebuilds/{workspacebuild}/c
### Parameters ### Parameters
| Name | In | Type | Required | Description | | Name | In | Type | Required | Description |
| ---------------- | ---- | ------ | -------- | ------------------ | |------------------|------|--------|----------|--------------------|
| `workspacebuild` | path | string | true | Workspace build ID | | `workspacebuild` | path | string | true | Workspace build ID |
### Example responses ### Example responses
@ -423,7 +431,7 @@ curl -X PATCH http://coder-server:8080/api/v2/workspacebuilds/{workspacebuild}/c
### Responses ### Responses
| Status | Meaning | Description | Schema | | Status | Meaning | Description | Schema |
| ------ | ------------------------------------------------------- | ----------- | ------------------------------------------------ | |--------|---------------------------------------------------------|-------------|--------------------------------------------------|
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.Response](schemas.md#codersdkresponse) | | 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.Response](schemas.md#codersdkresponse) |
To perform this operation, you must be authenticated. [Learn more](authentication.md). To perform this operation, you must be authenticated. [Learn more](authentication.md).
@ -444,7 +452,7 @@ curl -X GET http://coder-server:8080/api/v2/workspacebuilds/{workspacebuild}/log
### Parameters ### Parameters
| Name | In | Type | Required | Description | | Name | In | Type | Required | Description |
| ---------------- | ----- | ------- | -------- | --------------------- | |------------------|-------|---------|----------|-----------------------|
| `workspacebuild` | path | string | true | Workspace build ID | | `workspacebuild` | path | string | true | Workspace build ID |
| `before` | query | integer | false | Before Unix timestamp | | `before` | query | integer | false | Before Unix timestamp |
| `after` | query | integer | false | After Unix timestamp | | `after` | query | integer | false | After Unix timestamp |
@ -470,7 +478,7 @@ curl -X GET http://coder-server:8080/api/v2/workspacebuilds/{workspacebuild}/log
### Responses ### Responses
| Status | Meaning | Description | Schema | | Status | Meaning | Description | Schema |
| ------ | ------------------------------------------------------- | ----------- | --------------------------------------------------------------------------- | |--------|---------------------------------------------------------|-------------|-----------------------------------------------------------------------------|
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | array of [codersdk.ProvisionerJobLog](schemas.md#codersdkprovisionerjoblog) | | 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | array of [codersdk.ProvisionerJobLog](schemas.md#codersdkprovisionerjoblog) |
<h3 id="get-workspace-build-logs-responseschema">Response Schema</h3> <h3 id="get-workspace-build-logs-responseschema">Response Schema</h3>
@ -478,7 +486,7 @@ curl -X GET http://coder-server:8080/api/v2/workspacebuilds/{workspacebuild}/log
Status Code **200** Status Code **200**
| Name | Type | Required | Restrictions | Description | | Name | Type | Required | Restrictions | Description |
| -------------- | -------------------------------------------------- | -------- | ------------ | ----------- | |----------------|----------------------------------------------------|----------|--------------|-------------|
| `[array item]` | array | false | | | | `[array item]` | array | false | | |
| `» created_at` | string(date-time) | false | | | | `» created_at` | string(date-time) | false | | |
| `» id` | integer | false | | | | `» id` | integer | false | | |
@ -490,7 +498,7 @@ Status Code **200**
#### Enumerated Values #### Enumerated Values
| Property | Value | | Property | Value |
| ------------ | -------------------- | |--------------|----------------------|
| `log_level` | `trace` | | `log_level` | `trace` |
| `log_level` | `debug` | | `log_level` | `debug` |
| `log_level` | `info` | | `log_level` | `info` |
@ -517,7 +525,7 @@ curl -X GET http://coder-server:8080/api/v2/workspacebuilds/{workspacebuild}/par
### Parameters ### Parameters
| Name | In | Type | Required | Description | | Name | In | Type | Required | Description |
| ---------------- | ---- | ------ | -------- | ------------------ | |------------------|------|--------|----------|--------------------|
| `workspacebuild` | path | string | true | Workspace build ID | | `workspacebuild` | path | string | true | Workspace build ID |
### Example responses ### Example responses
@ -536,7 +544,7 @@ curl -X GET http://coder-server:8080/api/v2/workspacebuilds/{workspacebuild}/par
### Responses ### Responses
| Status | Meaning | Description | Schema | | Status | Meaning | Description | Schema |
| ------ | ------------------------------------------------------- | ----------- | --------------------------------------------------------------------------------------- | |--------|---------------------------------------------------------|-------------|-----------------------------------------------------------------------------------------|
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | array of [codersdk.WorkspaceBuildParameter](schemas.md#codersdkworkspacebuildparameter) | | 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | array of [codersdk.WorkspaceBuildParameter](schemas.md#codersdkworkspacebuildparameter) |
<h3 id="get-build-parameters-for-workspace-build-responseschema">Response Schema</h3> <h3 id="get-build-parameters-for-workspace-build-responseschema">Response Schema</h3>
@ -544,7 +552,7 @@ curl -X GET http://coder-server:8080/api/v2/workspacebuilds/{workspacebuild}/par
Status Code **200** Status Code **200**
| Name | Type | Required | Restrictions | Description | | Name | Type | Required | Restrictions | Description |
| -------------- | ------ | -------- | ------------ | ----------- | |----------------|--------|----------|--------------|-------------|
| `[array item]` | array | false | | | | `[array item]` | array | false | | |
| `» name` | string | false | | | | `» name` | string | false | | |
| `» value` | string | false | | | | `» value` | string | false | | |
@ -567,7 +575,7 @@ curl -X GET http://coder-server:8080/api/v2/workspacebuilds/{workspacebuild}/res
### Parameters ### Parameters
| Name | In | Type | Required | Description | | Name | In | Type | Required | Description |
| ---------------- | ---- | ------ | -------- | ------------------ | |------------------|------|--------|----------|--------------------|
| `workspacebuild` | path | string | true | Workspace build ID | | `workspacebuild` | path | string | true | Workspace build ID |
### Example responses ### Example responses
@ -607,7 +615,9 @@ curl -X GET http://coder-server:8080/api/v2/workspacebuilds/{workspacebuild}/res
"created_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z",
"directory": "string", "directory": "string",
"disconnected_at": "2019-08-24T14:15:22Z", "disconnected_at": "2019-08-24T14:15:22Z",
"display_apps": ["vscode"], "display_apps": [
"vscode"
],
"environment_variables": { "environment_variables": {
"property1": "string", "property1": "string",
"property2": "string" "property2": "string"
@ -664,7 +674,9 @@ curl -X GET http://coder-server:8080/api/v2/workspacebuilds/{workspacebuild}/res
"started_at": "2019-08-24T14:15:22Z", "started_at": "2019-08-24T14:15:22Z",
"startup_script_behavior": "blocking", "startup_script_behavior": "blocking",
"status": "connecting", "status": "connecting",
"subsystems": ["envbox"], "subsystems": [
"envbox"
],
"troubleshooting_url": "string", "troubleshooting_url": "string",
"updated_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z",
"version": "string" "version": "string"
@ -693,7 +705,7 @@ curl -X GET http://coder-server:8080/api/v2/workspacebuilds/{workspacebuild}/res
### Responses ### Responses
| Status | Meaning | Description | Schema | | Status | Meaning | Description | Schema |
| ------ | ------------------------------------------------------- | ----------- | --------------------------------------------------------------------------- | |--------|---------------------------------------------------------|-------------|-----------------------------------------------------------------------------|
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | array of [codersdk.WorkspaceResource](schemas.md#codersdkworkspaceresource) | | 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | array of [codersdk.WorkspaceResource](schemas.md#codersdkworkspaceresource) |
<h3 id="removed:-get-workspace-resources-for-workspace-build-responseschema">Response Schema</h3> <h3 id="removed:-get-workspace-resources-for-workspace-build-responseschema">Response Schema</h3>
@ -701,7 +713,7 @@ curl -X GET http://coder-server:8080/api/v2/workspacebuilds/{workspacebuild}/res
Status Code **200** Status Code **200**
| Name | Type | Required | Restrictions | Description | | Name | Type | Required | Restrictions | Description |
| ------------------------------- | ------------------------------------------------------------------------------------------------------ | -------- | ------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | |---------------------------------|--------------------------------------------------------------------------------------------------------|----------|--------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `[array item]` | array | false | | | | `[array item]` | array | false | | |
| `» agents` | array | false | | | | `» agents` | array | false | | |
| `»» api_version` | string | false | | | | `»» api_version` | string | false | | |
@ -791,7 +803,7 @@ Status Code **200**
#### Enumerated Values #### Enumerated Values
| Property | Value | | Property | Value |
| ------------------------- | ------------------ | |---------------------------|--------------------|
| `health` | `disabled` | | `health` | `disabled` |
| `health` | `initializing` | | `health` | `initializing` |
| `health` | `healthy` | | `health` | `healthy` |
@ -836,7 +848,7 @@ curl -X GET http://coder-server:8080/api/v2/workspacebuilds/{workspacebuild}/sta
### Parameters ### Parameters
| Name | In | Type | Required | Description | | Name | In | Type | Required | Description |
| ---------------- | ---- | ------ | -------- | ------------------ | |------------------|------|--------|----------|--------------------|
| `workspacebuild` | path | string | true | Workspace build ID | | `workspacebuild` | path | string | true | Workspace build ID |
### Example responses ### Example responses
@ -909,7 +921,9 @@ curl -X GET http://coder-server:8080/api/v2/workspacebuilds/{workspacebuild}/sta
"created_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z",
"directory": "string", "directory": "string",
"disconnected_at": "2019-08-24T14:15:22Z", "disconnected_at": "2019-08-24T14:15:22Z",
"display_apps": ["vscode"], "display_apps": [
"vscode"
],
"environment_variables": { "environment_variables": {
"property1": "string", "property1": "string",
"property2": "string" "property2": "string"
@ -966,7 +980,9 @@ curl -X GET http://coder-server:8080/api/v2/workspacebuilds/{workspacebuild}/sta
"started_at": "2019-08-24T14:15:22Z", "started_at": "2019-08-24T14:15:22Z",
"startup_script_behavior": "blocking", "startup_script_behavior": "blocking",
"status": "connecting", "status": "connecting",
"subsystems": ["envbox"], "subsystems": [
"envbox"
],
"troubleshooting_url": "string", "troubleshooting_url": "string",
"updated_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z",
"version": "string" "version": "string"
@ -1006,7 +1022,7 @@ curl -X GET http://coder-server:8080/api/v2/workspacebuilds/{workspacebuild}/sta
### Responses ### Responses
| Status | Meaning | Description | Schema | | Status | Meaning | Description | Schema |
| ------ | ------------------------------------------------------- | ----------- | ------------------------------------------------------------ | |--------|---------------------------------------------------------|-------------|--------------------------------------------------------------|
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.WorkspaceBuild](schemas.md#codersdkworkspacebuild) | | 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.WorkspaceBuild](schemas.md#codersdkworkspacebuild) |
To perform this operation, you must be authenticated. [Learn more](authentication.md). To perform this operation, you must be authenticated. [Learn more](authentication.md).
@ -1027,7 +1043,7 @@ curl -X GET http://coder-server:8080/api/v2/workspacebuilds/{workspacebuild}/tim
### Parameters ### Parameters
| Name | In | Type | Required | Description | | Name | In | Type | Required | Description |
| ---------------- | ---- | ------------ | -------- | ------------------ | |------------------|------|--------------|----------|--------------------|
| `workspacebuild` | path | string(uuid) | true | Workspace build ID | | `workspacebuild` | path | string(uuid) | true | Workspace build ID |
### Example responses ### Example responses
@ -1074,7 +1090,7 @@ curl -X GET http://coder-server:8080/api/v2/workspacebuilds/{workspacebuild}/tim
### Responses ### Responses
| Status | Meaning | Description | Schema | | Status | Meaning | Description | Schema |
| ------ | ------------------------------------------------------- | ----------- | -------------------------------------------------------------------------- | |--------|---------------------------------------------------------|-------------|----------------------------------------------------------------------------|
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.WorkspaceBuildTimings](schemas.md#codersdkworkspacebuildtimings) | | 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.WorkspaceBuildTimings](schemas.md#codersdkworkspacebuildtimings) |
To perform this operation, you must be authenticated. [Learn more](authentication.md). To perform this operation, you must be authenticated. [Learn more](authentication.md).
@ -1095,7 +1111,7 @@ curl -X GET http://coder-server:8080/api/v2/workspaces/{workspace}/builds \
### Parameters ### Parameters
| Name | In | Type | Required | Description | | Name | In | Type | Required | Description |
| ----------- | ----- | ----------------- | -------- | --------------- | |-------------|-------|-------------------|----------|-----------------|
| `workspace` | path | string(uuid) | true | Workspace ID | | `workspace` | path | string(uuid) | true | Workspace ID |
| `after_id` | query | string(uuid) | false | After ID | | `after_id` | query | string(uuid) | false | After ID |
| `limit` | query | integer | false | Page limit | | `limit` | query | integer | false | Page limit |
@ -1173,7 +1189,9 @@ curl -X GET http://coder-server:8080/api/v2/workspaces/{workspace}/builds \
"created_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z",
"directory": "string", "directory": "string",
"disconnected_at": "2019-08-24T14:15:22Z", "disconnected_at": "2019-08-24T14:15:22Z",
"display_apps": ["vscode"], "display_apps": [
"vscode"
],
"environment_variables": { "environment_variables": {
"property1": "string", "property1": "string",
"property2": "string" "property2": "string"
@ -1230,7 +1248,9 @@ curl -X GET http://coder-server:8080/api/v2/workspaces/{workspace}/builds \
"started_at": "2019-08-24T14:15:22Z", "started_at": "2019-08-24T14:15:22Z",
"startup_script_behavior": "blocking", "startup_script_behavior": "blocking",
"status": "connecting", "status": "connecting",
"subsystems": ["envbox"], "subsystems": [
"envbox"
],
"troubleshooting_url": "string", "troubleshooting_url": "string",
"updated_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z",
"version": "string" "version": "string"
@ -1271,7 +1291,7 @@ curl -X GET http://coder-server:8080/api/v2/workspaces/{workspace}/builds \
### Responses ### Responses
| Status | Meaning | Description | Schema | | Status | Meaning | Description | Schema |
| ------ | ------------------------------------------------------- | ----------- | --------------------------------------------------------------------- | |--------|---------------------------------------------------------|-------------|-----------------------------------------------------------------------|
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | array of [codersdk.WorkspaceBuild](schemas.md#codersdkworkspacebuild) | | 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | array of [codersdk.WorkspaceBuild](schemas.md#codersdkworkspacebuild) |
<h3 id="get-workspace-builds-by-workspace-id-responseschema">Response Schema</h3> <h3 id="get-workspace-builds-by-workspace-id-responseschema">Response Schema</h3>
@ -1279,7 +1299,7 @@ curl -X GET http://coder-server:8080/api/v2/workspaces/{workspace}/builds \
Status Code **200** Status Code **200**
| Name | Type | Required | Restrictions | Description | | Name | Type | Required | Restrictions | Description |
| -------------------------------- | ------------------------------------------------------------------------------------------------------ | -------- | ------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | |----------------------------------|--------------------------------------------------------------------------------------------------------|----------|--------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `[array item]` | array | false | | | | `[array item]` | array | false | | |
| `» build_number` | integer | false | | | | `» build_number` | integer | false | | |
| `» created_at` | string(date-time) | false | | | | `» created_at` | string(date-time) | false | | |
@ -1408,7 +1428,7 @@ Status Code **200**
#### Enumerated Values #### Enumerated Values
| Property | Value | | Property | Value |
| ------------------------- | ----------------------------- | |---------------------------|-------------------------------|
| `error_code` | `REQUIRED_TEMPLATE_VARIABLES` | | `error_code` | `REQUIRED_TEMPLATE_VARIABLES` |
| `status` | `pending` | | `status` | `pending` |
| `status` | `running` | | `status` | `running` |
@ -1487,7 +1507,9 @@ curl -X POST http://coder-server:8080/api/v2/workspaces/{workspace}/builds \
"value": "string" "value": "string"
} }
], ],
"state": [0], "state": [
0
],
"template_version_id": "0ba39c92-1f1b-4c32-aa3e-9925d7713eb1", "template_version_id": "0ba39c92-1f1b-4c32-aa3e-9925d7713eb1",
"transition": "start" "transition": "start"
} }
@ -1496,7 +1518,7 @@ curl -X POST http://coder-server:8080/api/v2/workspaces/{workspace}/builds \
### Parameters ### Parameters
| Name | In | Type | Required | Description | | Name | In | Type | Required | Description |
| ----------- | ---- | -------------------------------------------------------------------------------------- | -------- | ------------------------------ | |-------------|------|----------------------------------------------------------------------------------------|----------|--------------------------------|
| `workspace` | path | string(uuid) | true | Workspace ID | | `workspace` | path | string(uuid) | true | Workspace ID |
| `body` | body | [codersdk.CreateWorkspaceBuildRequest](schemas.md#codersdkcreateworkspacebuildrequest) | true | Create workspace build request | | `body` | body | [codersdk.CreateWorkspaceBuildRequest](schemas.md#codersdkcreateworkspacebuildrequest) | true | Create workspace build request |
@ -1570,7 +1592,9 @@ curl -X POST http://coder-server:8080/api/v2/workspaces/{workspace}/builds \
"created_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z",
"directory": "string", "directory": "string",
"disconnected_at": "2019-08-24T14:15:22Z", "disconnected_at": "2019-08-24T14:15:22Z",
"display_apps": ["vscode"], "display_apps": [
"vscode"
],
"environment_variables": { "environment_variables": {
"property1": "string", "property1": "string",
"property2": "string" "property2": "string"
@ -1627,7 +1651,9 @@ curl -X POST http://coder-server:8080/api/v2/workspaces/{workspace}/builds \
"started_at": "2019-08-24T14:15:22Z", "started_at": "2019-08-24T14:15:22Z",
"startup_script_behavior": "blocking", "startup_script_behavior": "blocking",
"status": "connecting", "status": "connecting",
"subsystems": ["envbox"], "subsystems": [
"envbox"
],
"troubleshooting_url": "string", "troubleshooting_url": "string",
"updated_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z",
"version": "string" "version": "string"
@ -1667,7 +1693,7 @@ curl -X POST http://coder-server:8080/api/v2/workspaces/{workspace}/builds \
### Responses ### Responses
| Status | Meaning | Description | Schema | | Status | Meaning | Description | Schema |
| ------ | ------------------------------------------------------- | ----------- | ------------------------------------------------------------ | |--------|---------------------------------------------------------|-------------|--------------------------------------------------------------|
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.WorkspaceBuild](schemas.md#codersdkworkspacebuild) | | 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.WorkspaceBuild](schemas.md#codersdkworkspacebuild) |
To perform this operation, you must be authenticated. [Learn more](authentication.md). To perform this operation, you must be authenticated. [Learn more](authentication.md).

66
docs/reference/api/debug.md generated
View File

@ -15,7 +15,7 @@ curl -X GET http://coder-server:8080/api/v2/debug/coordinator \
### Responses ### Responses
| Status | Meaning | Description | Schema | | Status | Meaning | Description | Schema |
| ------ | ------------------------------------------------------- | ----------- | ------ | |--------|---------------------------------------------------------|-------------|--------|
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | | | 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | |
To perform this operation, you must be authenticated. [Learn more](authentication.md). To perform this operation, you must be authenticated. [Learn more](authentication.md).
@ -36,7 +36,7 @@ curl -X GET http://coder-server:8080/api/v2/debug/health \
### Parameters ### Parameters
| Name | In | Type | Required | Description | | Name | In | Type | Required | Description |
| ------- | ----- | ------- | -------- | -------------------------- | |---------|-------|---------|----------|----------------------------|
| `force` | query | boolean | false | Force a healthcheck to run | | `force` | query | boolean | false | Force a healthcheck to run |
### Example responses ### Example responses
@ -113,7 +113,9 @@ curl -X GET http://coder-server:8080/api/v2/debug/health \
"upnP": "string" "upnP": "string"
}, },
"netcheck_err": "string", "netcheck_err": "string",
"netcheck_logs": ["string"], "netcheck_logs": [
"string"
],
"regions": { "regions": {
"property1": { "property1": {
"error": "string", "error": "string",
@ -121,8 +123,16 @@ curl -X GET http://coder-server:8080/api/v2/debug/health \
"node_reports": [ "node_reports": [
{ {
"can_exchange_messages": true, "can_exchange_messages": true,
"client_errs": [["string"]], "client_errs": [
"client_logs": [["string"]], [
"string"
]
],
"client_logs": [
[
"string"
]
],
"error": "string", "error": "string",
"healthy": true, "healthy": true,
"node": { "node": {
@ -199,8 +209,16 @@ curl -X GET http://coder-server:8080/api/v2/debug/health \
"node_reports": [ "node_reports": [
{ {
"can_exchange_messages": true, "can_exchange_messages": true,
"client_errs": [["string"]], "client_errs": [
"client_logs": [["string"]], [
"string"
]
],
"client_logs": [
[
"string"
]
],
"error": "string", "error": "string",
"healthy": true, "healthy": true,
"node": { "node": {
@ -294,7 +312,9 @@ curl -X GET http://coder-server:8080/api/v2/debug/health \
"last_seen_at": "2019-08-24T14:15:22Z", "last_seen_at": "2019-08-24T14:15:22Z",
"name": "string", "name": "string",
"organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6", "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
"provisioners": ["string"], "provisioners": [
"string"
],
"tags": { "tags": {
"property1": "string", "property1": "string",
"property2": "string" "property2": "string"
@ -360,8 +380,12 @@ curl -X GET http://coder-server:8080/api/v2/debug/health \
"status": { "status": {
"checked_at": "2019-08-24T14:15:22Z", "checked_at": "2019-08-24T14:15:22Z",
"report": { "report": {
"errors": ["string"], "errors": [
"warnings": ["string"] "string"
],
"warnings": [
"string"
]
}, },
"status": "ok" "status": "ok"
}, },
@ -378,7 +402,7 @@ curl -X GET http://coder-server:8080/api/v2/debug/health \
### Responses ### Responses
| Status | Meaning | Description | Schema | | Status | Meaning | Description | Schema |
| ------ | ------------------------------------------------------- | ----------- | -------------------------------------------------------------------- | |--------|---------------------------------------------------------|-------------|----------------------------------------------------------------------|
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [healthsdk.HealthcheckReport](schemas.md#healthsdkhealthcheckreport) | | 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [healthsdk.HealthcheckReport](schemas.md#healthsdkhealthcheckreport) |
To perform this operation, you must be authenticated. [Learn more](authentication.md). To perform this operation, you must be authenticated. [Learn more](authentication.md).
@ -402,14 +426,16 @@ curl -X GET http://coder-server:8080/api/v2/debug/health/settings \
```json ```json
{ {
"dismissed_healthchecks": ["DERP"] "dismissed_healthchecks": [
"DERP"
]
} }
``` ```
### Responses ### Responses
| Status | Meaning | Description | Schema | | Status | Meaning | Description | Schema |
| ------ | ------------------------------------------------------- | ----------- | -------------------------------------------------------------- | |--------|---------------------------------------------------------|-------------|----------------------------------------------------------------|
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [healthsdk.HealthSettings](schemas.md#healthsdkhealthsettings) | | 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [healthsdk.HealthSettings](schemas.md#healthsdkhealthsettings) |
To perform this operation, you must be authenticated. [Learn more](authentication.md). To perform this operation, you must be authenticated. [Learn more](authentication.md).
@ -432,14 +458,16 @@ curl -X PUT http://coder-server:8080/api/v2/debug/health/settings \
```json ```json
{ {
"dismissed_healthchecks": ["DERP"] "dismissed_healthchecks": [
"DERP"
]
} }
``` ```
### Parameters ### Parameters
| Name | In | Type | Required | Description | | Name | In | Type | Required | Description |
| ------ | ---- | -------------------------------------------------------------------------- | -------- | ---------------------- | |--------|------|----------------------------------------------------------------------------|----------|------------------------|
| `body` | body | [healthsdk.UpdateHealthSettings](schemas.md#healthsdkupdatehealthsettings) | true | Update health settings | | `body` | body | [healthsdk.UpdateHealthSettings](schemas.md#healthsdkupdatehealthsettings) | true | Update health settings |
### Example responses ### Example responses
@ -448,14 +476,16 @@ curl -X PUT http://coder-server:8080/api/v2/debug/health/settings \
```json ```json
{ {
"dismissed_healthchecks": ["DERP"] "dismissed_healthchecks": [
"DERP"
]
} }
``` ```
### Responses ### Responses
| Status | Meaning | Description | Schema | | Status | Meaning | Description | Schema |
| ------ | ------------------------------------------------------- | ----------- | -------------------------------------------------------------------------- | |--------|---------------------------------------------------------|-------------|----------------------------------------------------------------------------|
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [healthsdk.UpdateHealthSettings](schemas.md#healthsdkupdatehealthsettings) | | 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [healthsdk.UpdateHealthSettings](schemas.md#healthsdkupdatehealthsettings) |
To perform this operation, you must be authenticated. [Learn more](authentication.md). To perform this operation, you must be authenticated. [Learn more](authentication.md).
@ -475,7 +505,7 @@ curl -X GET http://coder-server:8080/api/v2/debug/tailnet \
### Responses ### Responses
| Status | Meaning | Description | Schema | | Status | Meaning | Description | Schema |
| ------ | ------------------------------------------------------- | ----------- | ------ | |--------|---------------------------------------------------------|-------------|--------|
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | | | 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | |
To perform this operation, you must be authenticated. [Learn more](authentication.md). To perform this operation, you must be authenticated. [Learn more](authentication.md).

477
docs/reference/api/enterprise.md generated
View File

File diff suppressed because it is too large Load Diff

9
docs/reference/api/files.md generated
View File

@ -18,12 +18,13 @@ curl -X POST http://coder-server:8080/api/v2/files \
```yaml ```yaml
file: string file: string
``` ```
### Parameters ### Parameters
| Name | In | Type | Required | Description | | Name | In | Type | Required | Description |
| -------------- | ------ | ------ | -------- | ---------------------------------------------------------------------------------------------- | |----------------|--------|--------|----------|------------------------------------------------------------------------------------------------|
| `Content-Type` | header | string | true | Content-Type must be `application/x-tar` or `application/zip` | | `Content-Type` | header | string | true | Content-Type must be `application/x-tar` or `application/zip` |
| `body` | body | object | true | | | `body` | body | object | true | |
| `» file` | body | binary | true | File to be uploaded. If using tar format, file must conform to ustar (pax may cause problems). | | `» file` | body | binary | true | File to be uploaded. If using tar format, file must conform to ustar (pax may cause problems). |
@ -41,7 +42,7 @@ file: string
### Responses ### Responses
| Status | Meaning | Description | Schema | | Status | Meaning | Description | Schema |
| ------ | ------------------------------------------------------------ | ----------- | ------------------------------------------------------------ | |--------|--------------------------------------------------------------|-------------|--------------------------------------------------------------|
| 201 | [Created](https://tools.ietf.org/html/rfc7231#section-6.3.2) | Created | [codersdk.UploadResponse](schemas.md#codersdkuploadresponse) | | 201 | [Created](https://tools.ietf.org/html/rfc7231#section-6.3.2) | Created | [codersdk.UploadResponse](schemas.md#codersdkuploadresponse) |
To perform this operation, you must be authenticated. [Learn more](authentication.md). To perform this operation, you must be authenticated. [Learn more](authentication.md).
@ -61,13 +62,13 @@ curl -X GET http://coder-server:8080/api/v2/files/{fileID} \
### Parameters ### Parameters
| Name | In | Type | Required | Description | | Name | In | Type | Required | Description |
| -------- | ---- | ------------ | -------- | ----------- | |----------|------|--------------|----------|-------------|
| `fileID` | path | string(uuid) | true | File ID | | `fileID` | path | string(uuid) | true | File ID |
### Responses ### Responses
| Status | Meaning | Description | Schema | | Status | Meaning | Description | Schema |
| ------ | ------------------------------------------------------- | ----------- | ------ | |--------|---------------------------------------------------------|-------------|--------|
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | | | 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | |
To perform this operation, you must be authenticated. [Learn more](authentication.md). To perform this operation, you must be authenticated. [Learn more](authentication.md).

124
docs/reference/api/general.md generated
View File

@ -32,7 +32,7 @@ curl -X GET http://coder-server:8080/api/v2/ \
### Responses ### Responses
| Status | Meaning | Description | Schema | | Status | Meaning | Description | Schema |
| ------ | ------------------------------------------------------- | ----------- | ------------------------------------------------ | |--------|---------------------------------------------------------|-------------|--------------------------------------------------|
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.Response](schemas.md#codersdkresponse) | | 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.Response](schemas.md#codersdkresponse) |
## Build info ## Build info
@ -68,7 +68,7 @@ curl -X GET http://coder-server:8080/api/v2/buildinfo \
### Responses ### Responses
| Status | Meaning | Description | Schema | | Status | Meaning | Description | Schema |
| ------ | ------------------------------------------------------- | ----------- | ------------------------------------------------------------------ | |--------|---------------------------------------------------------|-------------|--------------------------------------------------------------------|
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.BuildInfoResponse](schemas.md#codersdkbuildinforesponse) | | 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.BuildInfoResponse](schemas.md#codersdkbuildinforesponse) |
## Report CSP violations ## Report CSP violations
@ -95,13 +95,13 @@ curl -X POST http://coder-server:8080/api/v2/csp/reports \
### Parameters ### Parameters
| Name | In | Type | Required | Description | | Name | In | Type | Required | Description |
| ------ | ---- | ---------------------------------------------------- | -------- | ---------------- | |--------|------|------------------------------------------------------|----------|------------------|
| `body` | body | [coderd.cspViolation](schemas.md#coderdcspviolation) | true | Violation report | | `body` | body | [coderd.cspViolation](schemas.md#coderdcspviolation) | true | Violation report |
### Responses ### Responses
| Status | Meaning | Description | Schema | | Status | Meaning | Description | Schema |
| ------ | ------------------------------------------------------- | ----------- | ------ | |--------|---------------------------------------------------------|-------------|--------|
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | | | 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | |
To perform this operation, you must be authenticated. [Learn more](authentication.md). To perform this operation, you must be authenticated. [Learn more](authentication.md).
@ -139,7 +139,9 @@ curl -X GET http://coder-server:8080/api/v2/deployment/config \
"scheme": "string", "scheme": "string",
"user": {} "user": {}
}, },
"additional_csp_policy": ["string"], "additional_csp_policy": [
"string"
],
"address": { "address": {
"host": "string", "host": "string",
"port": "string" "port": "string"
@ -166,7 +168,9 @@ curl -X GET http://coder-server:8080/api/v2/deployment/config \
"config": "string", "config": "string",
"config_ssh": { "config_ssh": {
"deploymentName": "string", "deploymentName": "string",
"sshconfigOptions": ["string"] "sshconfigOptions": [
"string"
]
}, },
"dangerous": { "dangerous": {
"allow_all_cors": true, "allow_all_cors": true,
@ -198,7 +202,9 @@ curl -X GET http://coder-server:8080/api/v2/deployment/config \
"scheme": "string", "scheme": "string",
"user": {} "user": {}
}, },
"stun_addresses": ["string"] "stun_addresses": [
"string"
]
} }
}, },
"disable_owner_workspace_exec": true, "disable_owner_workspace_exec": true,
@ -218,7 +224,9 @@ curl -X GET http://coder-server:8080/api/v2/deployment/config \
"user": {} "user": {}
}, },
"enable_terraform_debug_mode": true, "enable_terraform_debug_mode": true,
"experiments": ["string"], "experiments": [
"string"
],
"external_auth": { "external_auth": {
"value": [ "value": [
{ {
@ -233,14 +241,18 @@ curl -X GET http://coder-server:8080/api/v2/deployment/config \
"id": "string", "id": "string",
"no_refresh": true, "no_refresh": true,
"regex": "string", "regex": "string",
"scopes": ["string"], "scopes": [
"string"
],
"token_url": "string", "token_url": "string",
"type": "string", "type": "string",
"validate_url": "string" "validate_url": "string"
} }
] ]
}, },
"external_token_encryption_keys": ["string"], "external_token_encryption_keys": [
"string"
],
"healthcheck": { "healthcheck": {
"refresh": 0, "refresh": 0,
"threshold_database": 0 "threshold_database": 0
@ -251,7 +263,9 @@ curl -X GET http://coder-server:8080/api/v2/deployment/config \
"logging": { "logging": {
"human": "string", "human": "string",
"json": "string", "json": "string",
"log_filter": ["string"], "log_filter": [
"string"
],
"stackdriver": "string" "stackdriver": "string"
}, },
"metrics_cache_refresh_interval": 0, "metrics_cache_refresh_interval": 0,
@ -305,8 +319,12 @@ curl -X GET http://coder-server:8080/api/v2/deployment/config \
"github": { "github": {
"allow_everyone": true, "allow_everyone": true,
"allow_signups": true, "allow_signups": true,
"allowed_orgs": ["string"], "allowed_orgs": [
"allowed_teams": ["string"], "string"
],
"allowed_teams": [
"string"
],
"client_id": "string", "client_id": "string",
"client_secret": "string", "client_secret": "string",
"enterprise_base_url": "string" "enterprise_base_url": "string"
@ -319,9 +337,13 @@ curl -X GET http://coder-server:8080/api/v2/deployment/config \
"client_id": "string", "client_id": "string",
"client_key_file": "string", "client_key_file": "string",
"client_secret": "string", "client_secret": "string",
"email_domain": ["string"], "email_domain": [
"string"
],
"email_field": "string", "email_field": "string",
"group_allow_list": ["string"], "group_allow_list": [
"string"
],
"group_auto_create": true, "group_auto_create": true,
"group_mapping": {}, "group_mapping": {},
"group_regex_filter": {}, "group_regex_filter": {},
@ -346,13 +368,17 @@ curl -X GET http://coder-server:8080/api/v2/deployment/config \
"organization_assign_default": true, "organization_assign_default": true,
"organization_field": "string", "organization_field": "string",
"organization_mapping": {}, "organization_mapping": {},
"scopes": ["string"], "scopes": [
"string"
],
"sign_in_text": "string", "sign_in_text": "string",
"signups_disabled_text": "string", "signups_disabled_text": "string",
"skip_issuer_checks": true, "skip_issuer_checks": true,
"user_role_field": "string", "user_role_field": "string",
"user_role_mapping": {}, "user_role_mapping": {},
"user_roles_default": ["string"], "user_roles_default": [
"string"
],
"username_field": "string" "username_field": "string"
}, },
"pg_auth": "string", "pg_auth": "string",
@ -369,7 +395,9 @@ curl -X GET http://coder-server:8080/api/v2/deployment/config \
"host": "string", "host": "string",
"port": "string" "port": "string"
}, },
"aggregate_agent_stats_by": ["string"], "aggregate_agent_stats_by": [
"string"
],
"collect_agent_stats": true, "collect_agent_stats": true,
"collect_db_metrics": true, "collect_db_metrics": true,
"enable": true "enable": true
@ -378,13 +406,19 @@ curl -X GET http://coder-server:8080/api/v2/deployment/config \
"daemon_poll_interval": 0, "daemon_poll_interval": 0,
"daemon_poll_jitter": 0, "daemon_poll_jitter": 0,
"daemon_psk": "string", "daemon_psk": "string",
"daemon_types": ["string"], "daemon_types": [
"string"
],
"daemons": 0, "daemons": 0,
"force_cancel_interval": 0 "force_cancel_interval": 0
}, },
"proxy_health_status_interval": 0, "proxy_health_status_interval": 0,
"proxy_trusted_headers": ["string"], "proxy_trusted_headers": [
"proxy_trusted_origins": ["string"], "string"
],
"proxy_trusted_origins": [
"string"
],
"rate_limit": { "rate_limit": {
"api": 0, "api": 0,
"disable_all": true "disable_all": true
@ -400,7 +434,9 @@ curl -X GET http://coder-server:8080/api/v2/deployment/config \
}, },
"ssh_keygen_algorithm": "string", "ssh_keygen_algorithm": "string",
"strict_transport_security": 0, "strict_transport_security": 0,
"strict_transport_security_options": ["string"], "strict_transport_security_options": [
"string"
],
"support": { "support": {
"links": { "links": {
"value": [ "value": [
@ -439,16 +475,22 @@ curl -X GET http://coder-server:8080/api/v2/deployment/config \
"port": "string" "port": "string"
}, },
"allow_insecure_ciphers": true, "allow_insecure_ciphers": true,
"cert_file": ["string"], "cert_file": [
"string"
],
"client_auth": "string", "client_auth": "string",
"client_ca_file": "string", "client_ca_file": "string",
"client_cert_file": "string", "client_cert_file": "string",
"client_key_file": "string", "client_key_file": "string",
"enable": true, "enable": true,
"key_file": ["string"], "key_file": [
"string"
],
"min_version": "string", "min_version": "string",
"redirect_http": true, "redirect_http": true,
"supported_ciphers": ["string"] "supported_ciphers": [
"string"
]
}, },
"trace": { "trace": {
"capture_logs": true, "capture_logs": true,
@ -492,7 +534,9 @@ curl -X GET http://coder-server:8080/api/v2/deployment/config \
"hidden": true, "hidden": true,
"name": "string", "name": "string",
"required": true, "required": true,
"use_instead": [{}], "use_instead": [
{}
],
"value": null, "value": null,
"value_source": "", "value_source": "",
"yaml": "string" "yaml": "string"
@ -504,7 +548,7 @@ curl -X GET http://coder-server:8080/api/v2/deployment/config \
### Responses ### Responses
| Status | Meaning | Description | Schema | | Status | Meaning | Description | Schema |
| ------ | ------------------------------------------------------- | ----------- | ---------------------------------------------------------------- | |--------|---------------------------------------------------------|-------------|------------------------------------------------------------------|
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.DeploymentConfig](schemas.md#codersdkdeploymentconfig) | | 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.DeploymentConfig](schemas.md#codersdkdeploymentconfig) |
To perform this operation, you must be authenticated. [Learn more](authentication.md). To perform this operation, you must be authenticated. [Learn more](authentication.md).
@ -539,7 +583,7 @@ curl -X GET http://coder-server:8080/api/v2/deployment/ssh \
### Responses ### Responses
| Status | Meaning | Description | Schema | | Status | Meaning | Description | Schema |
| ------ | ------------------------------------------------------- | ----------- | ------------------------------------------------------------------ | |--------|---------------------------------------------------------|-------------|--------------------------------------------------------------------|
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.SSHConfigResponse](schemas.md#codersdksshconfigresponse) | | 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.SSHConfigResponse](schemas.md#codersdksshconfigresponse) |
To perform this operation, you must be authenticated. [Learn more](authentication.md). To perform this operation, you must be authenticated. [Learn more](authentication.md).
@ -591,7 +635,7 @@ curl -X GET http://coder-server:8080/api/v2/deployment/stats \
### Responses ### Responses
| Status | Meaning | Description | Schema | | Status | Meaning | Description | Schema |
| ------ | ------------------------------------------------------- | ----------- | -------------------------------------------------------------- | |--------|---------------------------------------------------------|-------------|----------------------------------------------------------------|
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.DeploymentStats](schemas.md#codersdkdeploymentstats) | | 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.DeploymentStats](schemas.md#codersdkdeploymentstats) |
To perform this operation, you must be authenticated. [Learn more](authentication.md). To perform this operation, you must be authenticated. [Learn more](authentication.md).
@ -614,13 +658,15 @@ curl -X GET http://coder-server:8080/api/v2/experiments \
> 200 Response > 200 Response
```json ```json
["example"] [
"example"
]
``` ```
### Responses ### Responses
| Status | Meaning | Description | Schema | | Status | Meaning | Description | Schema |
| ------ | ------------------------------------------------------- | ----------- | ------------------------------------------------------------- | |--------|---------------------------------------------------------|-------------|---------------------------------------------------------------|
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | array of [codersdk.Experiment](schemas.md#codersdkexperiment) | | 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | array of [codersdk.Experiment](schemas.md#codersdkexperiment) |
<h3 id="get-enabled-experiments-responseschema">Response Schema</h3> <h3 id="get-enabled-experiments-responseschema">Response Schema</h3>
@ -628,7 +674,7 @@ curl -X GET http://coder-server:8080/api/v2/experiments \
Status Code **200** Status Code **200**
| Name | Type | Required | Restrictions | Description | | Name | Type | Required | Restrictions | Description |
| -------------- | ----- | -------- | ------------ | ----------- | |----------------|-------|----------|--------------|-------------|
| `[array item]` | array | false | | | | `[array item]` | array | false | | |
To perform this operation, you must be authenticated. [Learn more](authentication.md). To perform this operation, you must be authenticated. [Learn more](authentication.md).
@ -651,13 +697,15 @@ curl -X GET http://coder-server:8080/api/v2/experiments/available \
> 200 Response > 200 Response
```json ```json
["example"] [
"example"
]
``` ```
### Responses ### Responses
| Status | Meaning | Description | Schema | | Status | Meaning | Description | Schema |
| ------ | ------------------------------------------------------- | ----------- | ------------------------------------------------------------- | |--------|---------------------------------------------------------|-------------|---------------------------------------------------------------|
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | array of [codersdk.Experiment](schemas.md#codersdkexperiment) | | 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | array of [codersdk.Experiment](schemas.md#codersdkexperiment) |
<h3 id="get-safe-experiments-responseschema">Response Schema</h3> <h3 id="get-safe-experiments-responseschema">Response Schema</h3>
@ -665,7 +713,7 @@ curl -X GET http://coder-server:8080/api/v2/experiments/available \
Status Code **200** Status Code **200**
| Name | Type | Required | Restrictions | Description | | Name | Type | Required | Restrictions | Description |
| -------------- | ----- | -------- | ------------ | ----------- | |----------------|-------|----------|--------------|-------------|
| `[array item]` | array | false | | | | `[array item]` | array | false | | |
To perform this operation, you must be authenticated. [Learn more](authentication.md). To perform this operation, you must be authenticated. [Learn more](authentication.md).
@ -697,7 +745,7 @@ curl -X GET http://coder-server:8080/api/v2/updatecheck \
### Responses ### Responses
| Status | Meaning | Description | Schema | | Status | Meaning | Description | Schema |
| ------ | ------------------------------------------------------- | ----------- | ---------------------------------------------------------------------- | |--------|---------------------------------------------------------|-------------|------------------------------------------------------------------------|
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.UpdateCheckResponse](schemas.md#codersdkupdatecheckresponse) | | 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.UpdateCheckResponse](schemas.md#codersdkupdatecheckresponse) |
## Get token config ## Get token config
@ -716,7 +764,7 @@ curl -X GET http://coder-server:8080/api/v2/users/{user}/keys/tokens/tokenconfig
### Parameters ### Parameters
| Name | In | Type | Required | Description | | Name | In | Type | Required | Description |
| ------ | ---- | ------ | -------- | -------------------- | |--------|------|--------|----------|----------------------|
| `user` | path | string | true | User ID, name, or me | | `user` | path | string | true | User ID, name, or me |
### Example responses ### Example responses
@ -732,7 +780,7 @@ curl -X GET http://coder-server:8080/api/v2/users/{user}/keys/tokens/tokenconfig
### Responses ### Responses
| Status | Meaning | Description | Schema | | Status | Meaning | Description | Schema |
| ------ | ------------------------------------------------------- | ----------- | ------------------------------------------------------ | |--------|---------------------------------------------------------|-------------|--------------------------------------------------------|
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.TokenConfig](schemas.md#codersdktokenconfig) | | 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.TokenConfig](schemas.md#codersdktokenconfig) |
To perform this operation, you must be authenticated. [Learn more](authentication.md). To perform this operation, you must be authenticated. [Learn more](authentication.md).

20
docs/reference/api/git.md generated
View File

@ -32,7 +32,7 @@ curl -X GET http://coder-server:8080/api/v2/external-auth \
### Responses ### Responses
| Status | Meaning | Description | Schema | | Status | Meaning | Description | Schema |
| ------ | ------------------------------------------------------- | ----------- | ---------------------------------------------------------------- | |--------|---------------------------------------------------------|-------------|------------------------------------------------------------------|
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.ExternalAuthLink](schemas.md#codersdkexternalauthlink) | | 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.ExternalAuthLink](schemas.md#codersdkexternalauthlink) |
To perform this operation, you must be authenticated. [Learn more](authentication.md). To perform this operation, you must be authenticated. [Learn more](authentication.md).
@ -53,7 +53,7 @@ curl -X GET http://coder-server:8080/api/v2/external-auth/{externalauth} \
### Parameters ### Parameters
| Name | In | Type | Required | Description | | Name | In | Type | Required | Description |
| -------------- | ---- | -------------- | -------- | --------------- | |----------------|------|----------------|----------|-----------------|
| `externalauth` | path | string(string) | true | Git Provider ID | | `externalauth` | path | string(string) | true | Git Provider ID |
### Example responses ### Example responses
@ -93,7 +93,7 @@ curl -X GET http://coder-server:8080/api/v2/external-auth/{externalauth} \
### Responses ### Responses
| Status | Meaning | Description | Schema | | Status | Meaning | Description | Schema |
| ------ | ------------------------------------------------------- | ----------- | -------------------------------------------------------- | |--------|---------------------------------------------------------|-------------|----------------------------------------------------------|
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.ExternalAuth](schemas.md#codersdkexternalauth) | | 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.ExternalAuth](schemas.md#codersdkexternalauth) |
To perform this operation, you must be authenticated. [Learn more](authentication.md). To perform this operation, you must be authenticated. [Learn more](authentication.md).
@ -113,18 +113,18 @@ curl -X DELETE http://coder-server:8080/api/v2/external-auth/{externalauth} \
### Parameters ### Parameters
| Name | In | Type | Required | Description | | Name | In | Type | Required | Description |
| -------------- | ---- | -------------- | -------- | --------------- | |----------------|------|----------------|----------|-----------------|
| `externalauth` | path | string(string) | true | Git Provider ID | | `externalauth` | path | string(string) | true | Git Provider ID |
### Responses ### Responses
| Status | Meaning | Description | Schema | | Status | Meaning | Description | Schema |
| ------ | ------------------------------------------------------- | ----------- | ------ | |--------|---------------------------------------------------------|-------------|--------|
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | | | 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | |
To perform this operation, you must be authenticated. [Learn more](authentication.md). To perform this operation, you must be authenticated. [Learn more](authentication.md).
## Get external auth device by ID. ## Get external auth device by ID
### Code samples ### Code samples
@ -140,7 +140,7 @@ curl -X GET http://coder-server:8080/api/v2/external-auth/{externalauth}/device
### Parameters ### Parameters
| Name | In | Type | Required | Description | | Name | In | Type | Required | Description |
| -------------- | ---- | -------------- | -------- | --------------- | |----------------|------|----------------|----------|-----------------|
| `externalauth` | path | string(string) | true | Git Provider ID | | `externalauth` | path | string(string) | true | Git Provider ID |
### Example responses ### Example responses
@ -160,7 +160,7 @@ curl -X GET http://coder-server:8080/api/v2/external-auth/{externalauth}/device
### Responses ### Responses
| Status | Meaning | Description | Schema | | Status | Meaning | Description | Schema |
| ------ | ------------------------------------------------------- | ----------- | -------------------------------------------------------------------- | |--------|---------------------------------------------------------|-------------|----------------------------------------------------------------------|
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.ExternalAuthDevice](schemas.md#codersdkexternalauthdevice) | | 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.ExternalAuthDevice](schemas.md#codersdkexternalauthdevice) |
To perform this operation, you must be authenticated. [Learn more](authentication.md). To perform this operation, you must be authenticated. [Learn more](authentication.md).
@ -180,13 +180,13 @@ curl -X POST http://coder-server:8080/api/v2/external-auth/{externalauth}/device
### Parameters ### Parameters
| Name | In | Type | Required | Description | | Name | In | Type | Required | Description |
| -------------- | ---- | -------------- | -------- | -------------------- | |----------------|------|----------------|----------|----------------------|
| `externalauth` | path | string(string) | true | External Provider ID | | `externalauth` | path | string(string) | true | External Provider ID |
### Responses ### Responses
| Status | Meaning | Description | Schema | | Status | Meaning | Description | Schema |
| ------ | --------------------------------------------------------------- | ----------- | ------ | |--------|-----------------------------------------------------------------|-------------|--------|
| 204 | [No Content](https://tools.ietf.org/html/rfc7231#section-6.3.5) | No Content | | | 204 | [No Content](https://tools.ietf.org/html/rfc7231#section-6.3.5) | No Content | |
To perform this operation, you must be authenticated. [Learn more](authentication.md). To perform this operation, you must be authenticated. [Learn more](authentication.md).

10
docs/reference/api/index.md generated
View File

@ -1,20 +1,22 @@
# API
Get started with the Coder API: Get started with the Coder API:
## Quickstart ## Quickstart
Generate a token on your Coder deployment by visiting: Generate a token on your Coder deployment by visiting:
```shell ````shell
https://coder.example.com/settings/tokens https://coder.example.com/settings/tokens
``` ````
List your workspaces List your workspaces
```shell ````shell
# CLI # CLI
curl https://coder.example.com/api/v2/workspaces?q=owner:me \ curl https://coder.example.com/api/v2/workspaces?q=owner:me \
-H "Coder-Session-Token: <your-token>" -H "Coder-Session-Token: <your-token>"
``` ````
## Use cases ## Use cases

50
docs/reference/api/insights.md generated
View File

@ -16,7 +16,7 @@ curl -X GET http://coder-server:8080/api/v2/insights/daus?tz_offset=0 \
### Parameters ### Parameters
| Name | In | Type | Required | Description | | Name | In | Type | Required | Description |
| ----------- | ----- | ------- | -------- | -------------------------- | |-------------|-------|---------|----------|----------------------------|
| `tz_offset` | query | integer | true | Time-zone offset (e.g. -2) | | `tz_offset` | query | integer | true | Time-zone offset (e.g. -2) |
### Example responses ### Example responses
@ -38,7 +38,7 @@ curl -X GET http://coder-server:8080/api/v2/insights/daus?tz_offset=0 \
### Responses ### Responses
| Status | Meaning | Description | Schema | | Status | Meaning | Description | Schema |
| ------ | ------------------------------------------------------- | ----------- | -------------------------------------------------------- | |--------|---------------------------------------------------------|-------------|----------------------------------------------------------|
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.DAUsResponse](schemas.md#codersdkdausresponse) | | 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.DAUsResponse](schemas.md#codersdkdausresponse) |
To perform this operation, you must be authenticated. [Learn more](authentication.md). To perform this operation, you must be authenticated. [Learn more](authentication.md).
@ -59,7 +59,7 @@ curl -X GET http://coder-server:8080/api/v2/insights/templates?start_time=2019-0
### Parameters ### Parameters
| Name | In | Type | Required | Description | | Name | In | Type | Required | Description |
| -------------- | ----- | ----------------- | -------- | ------------ | |----------------|-------|-------------------|----------|--------------|
| `start_time` | query | string(date-time) | true | Start time | | `start_time` | query | string(date-time) | true | Start time |
| `end_time` | query | string(date-time) | true | End time | | `end_time` | query | string(date-time) | true | End time |
| `interval` | query | string | true | Interval | | `interval` | query | string | true | Interval |
@ -68,7 +68,7 @@ curl -X GET http://coder-server:8080/api/v2/insights/templates?start_time=2019-0
#### Enumerated Values #### Enumerated Values
| Parameter | Value | | Parameter | Value |
| ---------- | ------ | |------------|--------|
| `interval` | `week` | | `interval` | `week` |
| `interval` | `day` | | `interval` | `day` |
@ -84,7 +84,9 @@ curl -X GET http://coder-server:8080/api/v2/insights/templates?start_time=2019-0
"end_time": "2019-08-24T14:15:22Z", "end_time": "2019-08-24T14:15:22Z",
"interval": "week", "interval": "week",
"start_time": "2019-08-24T14:15:22Z", "start_time": "2019-08-24T14:15:22Z",
"template_ids": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"] "template_ids": [
"497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
} }
], ],
"report": { "report": {
@ -95,7 +97,9 @@ curl -X GET http://coder-server:8080/api/v2/insights/templates?start_time=2019-0
"icon": "string", "icon": "string",
"seconds": 80500, "seconds": 80500,
"slug": "vscode", "slug": "vscode",
"template_ids": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"], "template_ids": [
"497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"times_used": 2, "times_used": 2,
"type": "builtin" "type": "builtin"
} }
@ -114,7 +118,9 @@ curl -X GET http://coder-server:8080/api/v2/insights/templates?start_time=2019-0
"value": "string" "value": "string"
} }
], ],
"template_ids": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"], "template_ids": [
"497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"type": "string", "type": "string",
"values": [ "values": [
{ {
@ -125,7 +131,9 @@ curl -X GET http://coder-server:8080/api/v2/insights/templates?start_time=2019-0
} }
], ],
"start_time": "2019-08-24T14:15:22Z", "start_time": "2019-08-24T14:15:22Z",
"template_ids": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"] "template_ids": [
"497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
} }
} }
``` ```
@ -133,7 +141,7 @@ curl -X GET http://coder-server:8080/api/v2/insights/templates?start_time=2019-0
### Responses ### Responses
| Status | Meaning | Description | Schema | | Status | Meaning | Description | Schema |
| ------ | ------------------------------------------------------- | ----------- | -------------------------------------------------------------------------------- | |--------|---------------------------------------------------------|-------------|----------------------------------------------------------------------------------|
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.TemplateInsightsResponse](schemas.md#codersdktemplateinsightsresponse) | | 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.TemplateInsightsResponse](schemas.md#codersdktemplateinsightsresponse) |
To perform this operation, you must be authenticated. [Learn more](authentication.md). To perform this operation, you must be authenticated. [Learn more](authentication.md).
@ -154,7 +162,7 @@ curl -X GET http://coder-server:8080/api/v2/insights/user-activity?start_time=20
### Parameters ### Parameters
| Name | In | Type | Required | Description | | Name | In | Type | Required | Description |
| -------------- | ----- | ----------------- | -------- | ------------ | |----------------|-------|-------------------|----------|--------------|
| `start_time` | query | string(date-time) | true | Start time | | `start_time` | query | string(date-time) | true | Start time |
| `end_time` | query | string(date-time) | true | End time | | `end_time` | query | string(date-time) | true | End time |
| `template_ids` | query | array[string] | false | Template IDs | | `template_ids` | query | array[string] | false | Template IDs |
@ -168,12 +176,16 @@ curl -X GET http://coder-server:8080/api/v2/insights/user-activity?start_time=20
"report": { "report": {
"end_time": "2019-08-24T14:15:22Z", "end_time": "2019-08-24T14:15:22Z",
"start_time": "2019-08-24T14:15:22Z", "start_time": "2019-08-24T14:15:22Z",
"template_ids": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"], "template_ids": [
"497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"users": [ "users": [
{ {
"avatar_url": "http://example.com", "avatar_url": "http://example.com",
"seconds": 80500, "seconds": 80500,
"template_ids": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"], "template_ids": [
"497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"user_id": "a169451c-8525-4352-b8ca-070dd449a1a5", "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
"username": "string" "username": "string"
} }
@ -185,7 +197,7 @@ curl -X GET http://coder-server:8080/api/v2/insights/user-activity?start_time=20
### Responses ### Responses
| Status | Meaning | Description | Schema | | Status | Meaning | Description | Schema |
| ------ | ------------------------------------------------------- | ----------- | ---------------------------------------------------------------------------------------- | |--------|---------------------------------------------------------|-------------|------------------------------------------------------------------------------------------|
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.UserActivityInsightsResponse](schemas.md#codersdkuseractivityinsightsresponse) | | 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.UserActivityInsightsResponse](schemas.md#codersdkuseractivityinsightsresponse) |
To perform this operation, you must be authenticated. [Learn more](authentication.md). To perform this operation, you must be authenticated. [Learn more](authentication.md).
@ -206,7 +218,7 @@ curl -X GET http://coder-server:8080/api/v2/insights/user-latency?start_time=201
### Parameters ### Parameters
| Name | In | Type | Required | Description | | Name | In | Type | Required | Description |
| -------------- | ----- | ----------------- | -------- | ------------ | |----------------|-------|-------------------|----------|--------------|
| `start_time` | query | string(date-time) | true | Start time | | `start_time` | query | string(date-time) | true | Start time |
| `end_time` | query | string(date-time) | true | End time | | `end_time` | query | string(date-time) | true | End time |
| `template_ids` | query | array[string] | false | Template IDs | | `template_ids` | query | array[string] | false | Template IDs |
@ -220,7 +232,9 @@ curl -X GET http://coder-server:8080/api/v2/insights/user-latency?start_time=201
"report": { "report": {
"end_time": "2019-08-24T14:15:22Z", "end_time": "2019-08-24T14:15:22Z",
"start_time": "2019-08-24T14:15:22Z", "start_time": "2019-08-24T14:15:22Z",
"template_ids": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"], "template_ids": [
"497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"users": [ "users": [
{ {
"avatar_url": "http://example.com", "avatar_url": "http://example.com",
@ -228,7 +242,9 @@ curl -X GET http://coder-server:8080/api/v2/insights/user-latency?start_time=201
"p50": 31.312, "p50": 31.312,
"p95": 119.832 "p95": 119.832
}, },
"template_ids": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"], "template_ids": [
"497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"user_id": "a169451c-8525-4352-b8ca-070dd449a1a5", "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
"username": "string" "username": "string"
} }
@ -240,7 +256,7 @@ curl -X GET http://coder-server:8080/api/v2/insights/user-latency?start_time=201
### Responses ### Responses
| Status | Meaning | Description | Schema | | Status | Meaning | Description | Schema |
| ------ | ------------------------------------------------------- | ----------- | -------------------------------------------------------------------------------------- | |--------|---------------------------------------------------------|-------------|----------------------------------------------------------------------------------------|
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.UserLatencyInsightsResponse](schemas.md#codersdkuserlatencyinsightsresponse) | | 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.UserLatencyInsightsResponse](schemas.md#codersdkuserlatencyinsightsresponse) |
To perform this operation, you must be authenticated. [Learn more](authentication.md). To perform this operation, you must be authenticated. [Learn more](authentication.md).

60
docs/reference/api/members.md generated
View File

@ -16,7 +16,7 @@ curl -X GET http://coder-server:8080/api/v2/organizations/{organization}/members
### Parameters ### Parameters
| Name | In | Type | Required | Description | | Name | In | Type | Required | Description |
| -------------- | ---- | ------ | -------- | --------------- | |----------------|------|--------|----------|-----------------|
| `organization` | path | string | true | Organization ID | | `organization` | path | string | true | Organization ID |
### Example responses ### Example responses
@ -55,7 +55,7 @@ curl -X GET http://coder-server:8080/api/v2/organizations/{organization}/members
### Responses ### Responses
| Status | Meaning | Description | Schema | | Status | Meaning | Description | Schema |
| ------ | ------------------------------------------------------- | ----------- | ----------------------------------------------------------------------------------------------------- | |--------|---------------------------------------------------------|-------------|-------------------------------------------------------------------------------------------------------|
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | array of [codersdk.OrganizationMemberWithUserData](schemas.md#codersdkorganizationmemberwithuserdata) | | 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | array of [codersdk.OrganizationMemberWithUserData](schemas.md#codersdkorganizationmemberwithuserdata) |
<h3 id="list-organization-members-responseschema">Response Schema</h3> <h3 id="list-organization-members-responseschema">Response Schema</h3>
@ -63,7 +63,7 @@ curl -X GET http://coder-server:8080/api/v2/organizations/{organization}/members
Status Code **200** Status Code **200**
| Name | Type | Required | Restrictions | Description | | Name | Type | Required | Restrictions | Description |
| -------------------- | ----------------- | -------- | ------------ | ----------- | |----------------------|-------------------|----------|--------------|-------------|
| `[array item]` | array | false | | | | `[array item]` | array | false | | |
| `» avatar_url` | string | false | | | | `» avatar_url` | string | false | | |
| `» created_at` | string(date-time) | false | | | | `» created_at` | string(date-time) | false | | |
@ -97,7 +97,7 @@ curl -X GET http://coder-server:8080/api/v2/organizations/{organization}/members
### Parameters ### Parameters
| Name | In | Type | Required | Description | | Name | In | Type | Required | Description |
| -------------- | ---- | ------------ | -------- | --------------- | |----------------|------|--------------|----------|-----------------|
| `organization` | path | string(uuid) | true | Organization ID | | `organization` | path | string(uuid) | true | Organization ID |
### Example responses ### Example responses
@ -140,7 +140,7 @@ curl -X GET http://coder-server:8080/api/v2/organizations/{organization}/members
### Responses ### Responses
| Status | Meaning | Description | Schema | | Status | Meaning | Description | Schema |
| ------ | ------------------------------------------------------- | ----------- | ----------------------------------------------------------------------- | |--------|---------------------------------------------------------|-------------|-------------------------------------------------------------------------|
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | array of [codersdk.AssignableRoles](schemas.md#codersdkassignableroles) | | 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | array of [codersdk.AssignableRoles](schemas.md#codersdkassignableroles) |
<h3 id="get-member-roles-by-organization-responseschema">Response Schema</h3> <h3 id="get-member-roles-by-organization-responseschema">Response Schema</h3>
@ -148,7 +148,7 @@ curl -X GET http://coder-server:8080/api/v2/organizations/{organization}/members
Status Code **200** Status Code **200**
| Name | Type | Required | Restrictions | Description | | Name | Type | Required | Restrictions | Description |
| ---------------------------- | -------------------------------------------------------- | -------- | ------------ | ----------------------------------------------------------------------------------------------- | |------------------------------|----------------------------------------------------------|----------|--------------|-------------------------------------------------------------------------------------------------|
| `[array item]` | array | false | | | | `[array item]` | array | false | | |
| `» assignable` | boolean | false | | | | `» assignable` | boolean | false | | |
| `» built_in` | boolean | false | | Built in roles are immutable | | `» built_in` | boolean | false | | Built in roles are immutable |
@ -165,7 +165,7 @@ Status Code **200**
#### Enumerated Values #### Enumerated Values
| Property | Value | | Property | Value |
| --------------- | ------------------------- | |-----------------|---------------------------|
| `action` | `application_connect` | | `action` | `application_connect` |
| `action` | `assign` | | `action` | `assign` |
| `action` | `create` | | `action` | `create` |
@ -261,7 +261,7 @@ curl -X PUT http://coder-server:8080/api/v2/organizations/{organization}/members
### Parameters ### Parameters
| Name | In | Type | Required | Description | | Name | In | Type | Required | Description |
| -------------- | ---- | ------------------------------------------------------------------ | -------- | ------------------- | |----------------|------|--------------------------------------------------------------------|----------|---------------------|
| `organization` | path | string(uuid) | true | Organization ID | | `organization` | path | string(uuid) | true | Organization ID |
| `body` | body | [codersdk.CustomRoleRequest](schemas.md#codersdkcustomrolerequest) | true | Upsert role request | | `body` | body | [codersdk.CustomRoleRequest](schemas.md#codersdkcustomrolerequest) | true | Upsert role request |
@ -303,7 +303,7 @@ curl -X PUT http://coder-server:8080/api/v2/organizations/{organization}/members
### Responses ### Responses
| Status | Meaning | Description | Schema | | Status | Meaning | Description | Schema |
| ------ | ------------------------------------------------------- | ----------- | ------------------------------------------------- | |--------|---------------------------------------------------------|-------------|---------------------------------------------------|
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | array of [codersdk.Role](schemas.md#codersdkrole) | | 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | array of [codersdk.Role](schemas.md#codersdkrole) |
<h3 id="upsert-a-custom-organization-role-responseschema">Response Schema</h3> <h3 id="upsert-a-custom-organization-role-responseschema">Response Schema</h3>
@ -311,7 +311,7 @@ curl -X PUT http://coder-server:8080/api/v2/organizations/{organization}/members
Status Code **200** Status Code **200**
| Name | Type | Required | Restrictions | Description | | Name | Type | Required | Restrictions | Description |
| ---------------------------- | -------------------------------------------------------- | -------- | ------------ | ----------------------------------------------------------------------------------------------- | |------------------------------|----------------------------------------------------------|----------|--------------|-------------------------------------------------------------------------------------------------|
| `[array item]` | array | false | | | | `[array item]` | array | false | | |
| `» display_name` | string | false | | | | `» display_name` | string | false | | |
| `» name` | string | false | | | | `» name` | string | false | | |
@ -326,7 +326,7 @@ Status Code **200**
#### Enumerated Values #### Enumerated Values
| Property | Value | | Property | Value |
| --------------- | ------------------------- | |-----------------|---------------------------|
| `action` | `application_connect` | | `action` | `application_connect` |
| `action` | `assign` | | `action` | `assign` |
| `action` | `create` | | `action` | `create` |
@ -422,7 +422,7 @@ curl -X POST http://coder-server:8080/api/v2/organizations/{organization}/member
### Parameters ### Parameters
| Name | In | Type | Required | Description | | Name | In | Type | Required | Description |
| -------------- | ---- | ------------------------------------------------------------------ | -------- | ------------------- | |----------------|------|--------------------------------------------------------------------|----------|---------------------|
| `organization` | path | string(uuid) | true | Organization ID | | `organization` | path | string(uuid) | true | Organization ID |
| `body` | body | [codersdk.CustomRoleRequest](schemas.md#codersdkcustomrolerequest) | true | Insert role request | | `body` | body | [codersdk.CustomRoleRequest](schemas.md#codersdkcustomrolerequest) | true | Insert role request |
@ -464,7 +464,7 @@ curl -X POST http://coder-server:8080/api/v2/organizations/{organization}/member
### Responses ### Responses
| Status | Meaning | Description | Schema | | Status | Meaning | Description | Schema |
| ------ | ------------------------------------------------------- | ----------- | ------------------------------------------------- | |--------|---------------------------------------------------------|-------------|---------------------------------------------------|
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | array of [codersdk.Role](schemas.md#codersdkrole) | | 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | array of [codersdk.Role](schemas.md#codersdkrole) |
<h3 id="insert-a-custom-organization-role-responseschema">Response Schema</h3> <h3 id="insert-a-custom-organization-role-responseschema">Response Schema</h3>
@ -472,7 +472,7 @@ curl -X POST http://coder-server:8080/api/v2/organizations/{organization}/member
Status Code **200** Status Code **200**
| Name | Type | Required | Restrictions | Description | | Name | Type | Required | Restrictions | Description |
| ---------------------------- | -------------------------------------------------------- | -------- | ------------ | ----------------------------------------------------------------------------------------------- | |------------------------------|----------------------------------------------------------|----------|--------------|-------------------------------------------------------------------------------------------------|
| `[array item]` | array | false | | | | `[array item]` | array | false | | |
| `» display_name` | string | false | | | | `» display_name` | string | false | | |
| `» name` | string | false | | | | `» name` | string | false | | |
@ -487,7 +487,7 @@ Status Code **200**
#### Enumerated Values #### Enumerated Values
| Property | Value | | Property | Value |
| --------------- | ------------------------- | |-----------------|---------------------------|
| `action` | `application_connect` | | `action` | `application_connect` |
| `action` | `assign` | | `action` | `assign` |
| `action` | `create` | | `action` | `create` |
@ -552,7 +552,7 @@ curl -X DELETE http://coder-server:8080/api/v2/organizations/{organization}/memb
### Parameters ### Parameters
| Name | In | Type | Required | Description | | Name | In | Type | Required | Description |
| -------------- | ---- | ------------ | -------- | --------------- | |----------------|------|--------------|----------|-----------------|
| `organization` | path | string(uuid) | true | Organization ID | | `organization` | path | string(uuid) | true | Organization ID |
| `roleName` | path | string | true | Role name | | `roleName` | path | string | true | Role name |
@ -594,7 +594,7 @@ curl -X DELETE http://coder-server:8080/api/v2/organizations/{organization}/memb
### Responses ### Responses
| Status | Meaning | Description | Schema | | Status | Meaning | Description | Schema |
| ------ | ------------------------------------------------------- | ----------- | ------------------------------------------------- | |--------|---------------------------------------------------------|-------------|---------------------------------------------------|
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | array of [codersdk.Role](schemas.md#codersdkrole) | | 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | array of [codersdk.Role](schemas.md#codersdkrole) |
<h3 id="delete-a-custom-organization-role-responseschema">Response Schema</h3> <h3 id="delete-a-custom-organization-role-responseschema">Response Schema</h3>
@ -602,7 +602,7 @@ curl -X DELETE http://coder-server:8080/api/v2/organizations/{organization}/memb
Status Code **200** Status Code **200**
| Name | Type | Required | Restrictions | Description | | Name | Type | Required | Restrictions | Description |
| ---------------------------- | -------------------------------------------------------- | -------- | ------------ | ----------------------------------------------------------------------------------------------- | |------------------------------|----------------------------------------------------------|----------|--------------|-------------------------------------------------------------------------------------------------|
| `[array item]` | array | false | | | | `[array item]` | array | false | | |
| `» display_name` | string | false | | | | `» display_name` | string | false | | |
| `» name` | string | false | | | | `» name` | string | false | | |
@ -617,7 +617,7 @@ Status Code **200**
#### Enumerated Values #### Enumerated Values
| Property | Value | | Property | Value |
| --------------- | ------------------------- | |-----------------|---------------------------|
| `action` | `application_connect` | | `action` | `application_connect` |
| `action` | `assign` | | `action` | `assign` |
| `action` | `create` | | `action` | `create` |
@ -682,7 +682,7 @@ curl -X POST http://coder-server:8080/api/v2/organizations/{organization}/member
### Parameters ### Parameters
| Name | In | Type | Required | Description | | Name | In | Type | Required | Description |
| -------------- | ---- | ------ | -------- | -------------------- | |----------------|------|--------|----------|----------------------|
| `organization` | path | string | true | Organization ID | | `organization` | path | string | true | Organization ID |
| `user` | path | string | true | User ID, name, or me | | `user` | path | string | true | User ID, name, or me |
@ -709,7 +709,7 @@ curl -X POST http://coder-server:8080/api/v2/organizations/{organization}/member
### Responses ### Responses
| Status | Meaning | Description | Schema | | Status | Meaning | Description | Schema |
| ------ | ------------------------------------------------------- | ----------- | -------------------------------------------------------------------- | |--------|---------------------------------------------------------|-------------|----------------------------------------------------------------------|
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.OrganizationMember](schemas.md#codersdkorganizationmember) | | 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.OrganizationMember](schemas.md#codersdkorganizationmember) |
To perform this operation, you must be authenticated. [Learn more](authentication.md). To perform this operation, you must be authenticated. [Learn more](authentication.md).
@ -729,14 +729,14 @@ curl -X DELETE http://coder-server:8080/api/v2/organizations/{organization}/memb
### Parameters ### Parameters
| Name | In | Type | Required | Description | | Name | In | Type | Required | Description |
| -------------- | ---- | ------ | -------- | -------------------- | |----------------|------|--------|----------|----------------------|
| `organization` | path | string | true | Organization ID | | `organization` | path | string | true | Organization ID |
| `user` | path | string | true | User ID, name, or me | | `user` | path | string | true | User ID, name, or me |
### Responses ### Responses
| Status | Meaning | Description | Schema | | Status | Meaning | Description | Schema |
| ------ | --------------------------------------------------------------- | ----------- | ------ | |--------|-----------------------------------------------------------------|-------------|--------|
| 204 | [No Content](https://tools.ietf.org/html/rfc7231#section-6.3.5) | No Content | | | 204 | [No Content](https://tools.ietf.org/html/rfc7231#section-6.3.5) | No Content | |
To perform this operation, you must be authenticated. [Learn more](authentication.md). To perform this operation, you must be authenticated. [Learn more](authentication.md).
@ -759,14 +759,16 @@ curl -X PUT http://coder-server:8080/api/v2/organizations/{organization}/members
```json ```json
{ {
"roles": ["string"] "roles": [
"string"
]
} }
``` ```
### Parameters ### Parameters
| Name | In | Type | Required | Description | | Name | In | Type | Required | Description |
| -------------- | ---- | ------------------------------------------------------ | -------- | -------------------- | |----------------|------|--------------------------------------------------------|----------|----------------------|
| `organization` | path | string | true | Organization ID | | `organization` | path | string | true | Organization ID |
| `user` | path | string | true | User ID, name, or me | | `user` | path | string | true | User ID, name, or me |
| `body` | body | [codersdk.UpdateRoles](schemas.md#codersdkupdateroles) | true | Update roles request | | `body` | body | [codersdk.UpdateRoles](schemas.md#codersdkupdateroles) | true | Update roles request |
@ -794,7 +796,7 @@ curl -X PUT http://coder-server:8080/api/v2/organizations/{organization}/members
### Responses ### Responses
| Status | Meaning | Description | Schema | | Status | Meaning | Description | Schema |
| ------ | ------------------------------------------------------- | ----------- | -------------------------------------------------------------------- | |--------|---------------------------------------------------------|-------------|----------------------------------------------------------------------|
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.OrganizationMember](schemas.md#codersdkorganizationmember) | | 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.OrganizationMember](schemas.md#codersdkorganizationmember) |
To perform this operation, you must be authenticated. [Learn more](authentication.md). To perform this operation, you must be authenticated. [Learn more](authentication.md).
@ -852,7 +854,7 @@ curl -X GET http://coder-server:8080/api/v2/users/roles \
### Responses ### Responses
| Status | Meaning | Description | Schema | | Status | Meaning | Description | Schema |
| ------ | ------------------------------------------------------- | ----------- | ----------------------------------------------------------------------- | |--------|---------------------------------------------------------|-------------|-------------------------------------------------------------------------|
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | array of [codersdk.AssignableRoles](schemas.md#codersdkassignableroles) | | 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | array of [codersdk.AssignableRoles](schemas.md#codersdkassignableroles) |
<h3 id="get-site-member-roles-responseschema">Response Schema</h3> <h3 id="get-site-member-roles-responseschema">Response Schema</h3>
@ -860,7 +862,7 @@ curl -X GET http://coder-server:8080/api/v2/users/roles \
Status Code **200** Status Code **200**
| Name | Type | Required | Restrictions | Description | | Name | Type | Required | Restrictions | Description |
| ---------------------------- | -------------------------------------------------------- | -------- | ------------ | ----------------------------------------------------------------------------------------------- | |------------------------------|----------------------------------------------------------|----------|--------------|-------------------------------------------------------------------------------------------------|
| `[array item]` | array | false | | | | `[array item]` | array | false | | |
| `» assignable` | boolean | false | | | | `» assignable` | boolean | false | | |
| `» built_in` | boolean | false | | Built in roles are immutable | | `» built_in` | boolean | false | | Built in roles are immutable |
@ -877,7 +879,7 @@ Status Code **200**
#### Enumerated Values #### Enumerated Values
| Property | Value | | Property | Value |
| --------------- | ------------------------- | |-----------------|---------------------------|
| `action` | `application_connect` | | `action` | `application_connect` |
| `action` | `assign` | | `action` | `assign` |
| `action` | `create` | | `action` | `create` |

30
docs/reference/api/notifications.md generated
View File

@ -20,7 +20,9 @@ curl -X GET http://coder-server:8080/api/v2/notifications/dispatch-methods \
```json ```json
[ [
{ {
"available": ["string"], "available": [
"string"
],
"default": "string" "default": "string"
} }
] ]
@ -29,7 +31,7 @@ curl -X GET http://coder-server:8080/api/v2/notifications/dispatch-methods \
### Responses ### Responses
| Status | Meaning | Description | Schema | | Status | Meaning | Description | Schema |
| ------ | ------------------------------------------------------- | ----------- | ----------------------------------------------------------------------------------------------- | |--------|---------------------------------------------------------|-------------|-------------------------------------------------------------------------------------------------|
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | array of [codersdk.NotificationMethodsResponse](schemas.md#codersdknotificationmethodsresponse) | | 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | array of [codersdk.NotificationMethodsResponse](schemas.md#codersdknotificationmethodsresponse) |
<h3 id="get-notification-dispatch-methods-responseschema">Response Schema</h3> <h3 id="get-notification-dispatch-methods-responseschema">Response Schema</h3>
@ -37,7 +39,7 @@ curl -X GET http://coder-server:8080/api/v2/notifications/dispatch-methods \
Status Code **200** Status Code **200**
| Name | Type | Required | Restrictions | Description | | Name | Type | Required | Restrictions | Description |
| -------------- | ------ | -------- | ------------ | ----------- | |----------------|--------|----------|--------------|-------------|
| `[array item]` | array | false | | | | `[array item]` | array | false | | |
| `» available` | array | false | | | | `» available` | array | false | | |
| `» default` | string | false | | | | `» default` | string | false | | |
@ -70,7 +72,7 @@ curl -X GET http://coder-server:8080/api/v2/notifications/settings \
### Responses ### Responses
| Status | Meaning | Description | Schema | | Status | Meaning | Description | Schema |
| ------ | ------------------------------------------------------- | ----------- | -------------------------------------------------------------------------- | |--------|---------------------------------------------------------|-------------|----------------------------------------------------------------------------|
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.NotificationsSettings](schemas.md#codersdknotificationssettings) | | 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.NotificationsSettings](schemas.md#codersdknotificationssettings) |
To perform this operation, you must be authenticated. [Learn more](authentication.md). To perform this operation, you must be authenticated. [Learn more](authentication.md).
@ -100,7 +102,7 @@ curl -X PUT http://coder-server:8080/api/v2/notifications/settings \
### Parameters ### Parameters
| Name | In | Type | Required | Description | | Name | In | Type | Required | Description |
| ------ | ---- | -------------------------------------------------------------------------- | -------- | ------------------------------ | |--------|------|----------------------------------------------------------------------------|----------|--------------------------------|
| `body` | body | [codersdk.NotificationsSettings](schemas.md#codersdknotificationssettings) | true | Notifications settings request | | `body` | body | [codersdk.NotificationsSettings](schemas.md#codersdknotificationssettings) | true | Notifications settings request |
### Example responses ### Example responses
@ -116,7 +118,7 @@ curl -X PUT http://coder-server:8080/api/v2/notifications/settings \
### Responses ### Responses
| Status | Meaning | Description | Schema | | Status | Meaning | Description | Schema |
| ------ | --------------------------------------------------------------- | ------------ | -------------------------------------------------------------------------- | |--------|-----------------------------------------------------------------|--------------|----------------------------------------------------------------------------|
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.NotificationsSettings](schemas.md#codersdknotificationssettings) | | 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.NotificationsSettings](schemas.md#codersdknotificationssettings) |
| 304 | [Not Modified](https://tools.ietf.org/html/rfc7232#section-4.1) | Not Modified | | | 304 | [Not Modified](https://tools.ietf.org/html/rfc7232#section-4.1) | Not Modified | |
@ -157,7 +159,7 @@ curl -X GET http://coder-server:8080/api/v2/notifications/templates/system \
### Responses ### Responses
| Status | Meaning | Description | Schema | | Status | Meaning | Description | Schema |
| ------ | ------------------------------------------------------- | ----------- | --------------------------------------------------------------------------------- | |--------|---------------------------------------------------------|-------------|-----------------------------------------------------------------------------------|
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | array of [codersdk.NotificationTemplate](schemas.md#codersdknotificationtemplate) | | 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | array of [codersdk.NotificationTemplate](schemas.md#codersdknotificationtemplate) |
<h3 id="get-system-notification-templates-responseschema">Response Schema</h3> <h3 id="get-system-notification-templates-responseschema">Response Schema</h3>
@ -165,7 +167,7 @@ curl -X GET http://coder-server:8080/api/v2/notifications/templates/system \
Status Code **200** Status Code **200**
| Name | Type | Required | Restrictions | Description | | Name | Type | Required | Restrictions | Description |
| ------------------ | ------------ | -------- | ------------ | ----------- | |--------------------|--------------|----------|--------------|-------------|
| `[array item]` | array | false | | | | `[array item]` | array | false | | |
| `» actions` | string | false | | | | `» actions` | string | false | | |
| `» body_template` | string | false | | | | `» body_template` | string | false | | |
@ -194,7 +196,7 @@ curl -X GET http://coder-server:8080/api/v2/users/{user}/notifications/preferenc
### Parameters ### Parameters
| Name | In | Type | Required | Description | | Name | In | Type | Required | Description |
| ------ | ---- | ------ | -------- | -------------------- | |--------|------|--------|----------|----------------------|
| `user` | path | string | true | User ID, name, or me | | `user` | path | string | true | User ID, name, or me |
### Example responses ### Example responses
@ -214,7 +216,7 @@ curl -X GET http://coder-server:8080/api/v2/users/{user}/notifications/preferenc
### Responses ### Responses
| Status | Meaning | Description | Schema | | Status | Meaning | Description | Schema |
| ------ | ------------------------------------------------------- | ----------- | ------------------------------------------------------------------------------------- | |--------|---------------------------------------------------------|-------------|---------------------------------------------------------------------------------------|
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | array of [codersdk.NotificationPreference](schemas.md#codersdknotificationpreference) | | 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | array of [codersdk.NotificationPreference](schemas.md#codersdknotificationpreference) |
<h3 id="get-user-notification-preferences-responseschema">Response Schema</h3> <h3 id="get-user-notification-preferences-responseschema">Response Schema</h3>
@ -222,7 +224,7 @@ curl -X GET http://coder-server:8080/api/v2/users/{user}/notifications/preferenc
Status Code **200** Status Code **200**
| Name | Type | Required | Restrictions | Description | | Name | Type | Required | Restrictions | Description |
| -------------- | ----------------- | -------- | ------------ | ----------- | |----------------|-------------------|----------|--------------|-------------|
| `[array item]` | array | false | | | | `[array item]` | array | false | | |
| `» disabled` | boolean | false | | | | `» disabled` | boolean | false | | |
| `» id` | string(uuid) | false | | | | `» id` | string(uuid) | false | | |
@ -258,7 +260,7 @@ curl -X PUT http://coder-server:8080/api/v2/users/{user}/notifications/preferenc
### Parameters ### Parameters
| Name | In | Type | Required | Description | | Name | In | Type | Required | Description |
| ------ | ---- | -------------------------------------------------------------------------------------------------- | -------- | -------------------- | |--------|------|----------------------------------------------------------------------------------------------------|----------|----------------------|
| `user` | path | string | true | User ID, name, or me | | `user` | path | string | true | User ID, name, or me |
| `body` | body | [codersdk.UpdateUserNotificationPreferences](schemas.md#codersdkupdateusernotificationpreferences) | true | Preferences | | `body` | body | [codersdk.UpdateUserNotificationPreferences](schemas.md#codersdkupdateusernotificationpreferences) | true | Preferences |
@ -279,7 +281,7 @@ curl -X PUT http://coder-server:8080/api/v2/users/{user}/notifications/preferenc
### Responses ### Responses
| Status | Meaning | Description | Schema | | Status | Meaning | Description | Schema |
| ------ | ------------------------------------------------------- | ----------- | ------------------------------------------------------------------------------------- | |--------|---------------------------------------------------------|-------------|---------------------------------------------------------------------------------------|
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | array of [codersdk.NotificationPreference](schemas.md#codersdknotificationpreference) | | 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | array of [codersdk.NotificationPreference](schemas.md#codersdknotificationpreference) |
<h3 id="update-user-notification-preferences-responseschema">Response Schema</h3> <h3 id="update-user-notification-preferences-responseschema">Response Schema</h3>
@ -287,7 +289,7 @@ curl -X PUT http://coder-server:8080/api/v2/users/{user}/notifications/preferenc
Status Code **200** Status Code **200**
| Name | Type | Required | Restrictions | Description | | Name | Type | Required | Restrictions | Description |
| -------------- | ----------------- | -------- | ------------ | ----------- | |----------------|-------------------|----------|--------------|-------------|
| `[array item]` | array | false | | | | `[array item]` | array | false | | |
| `» disabled` | boolean | false | | | | `» disabled` | boolean | false | | |
| `» id` | string(uuid) | false | | | | `» id` | string(uuid) | false | | |

26
docs/reference/api/organizations.md generated
View File

@ -25,7 +25,7 @@ curl -X POST http://coder-server:8080/api/v2/licenses \
### Parameters ### Parameters
| Name | In | Type | Required | Description | | Name | In | Type | Required | Description |
| ------ | ---- | ------------------------------------------------------------------ | -------- | ------------------- | |--------|------|--------------------------------------------------------------------|----------|---------------------|
| `body` | body | [codersdk.AddLicenseRequest](schemas.md#codersdkaddlicenserequest) | true | Add license request | | `body` | body | [codersdk.AddLicenseRequest](schemas.md#codersdkaddlicenserequest) | true | Add license request |
### Example responses ### Example responses
@ -44,7 +44,7 @@ curl -X POST http://coder-server:8080/api/v2/licenses \
### Responses ### Responses
| Status | Meaning | Description | Schema | | Status | Meaning | Description | Schema |
| ------ | ------------------------------------------------------------ | ----------- | ---------------------------------------------- | |--------|--------------------------------------------------------------|-------------|------------------------------------------------|
| 201 | [Created](https://tools.ietf.org/html/rfc7231#section-6.3.2) | Created | [codersdk.License](schemas.md#codersdklicense) | | 201 | [Created](https://tools.ietf.org/html/rfc7231#section-6.3.2) | Created | [codersdk.License](schemas.md#codersdklicense) |
To perform this operation, you must be authenticated. [Learn more](authentication.md). To perform this operation, you must be authenticated. [Learn more](authentication.md).
@ -82,7 +82,7 @@ curl -X POST http://coder-server:8080/api/v2/licenses/refresh-entitlements \
### Responses ### Responses
| Status | Meaning | Description | Schema | | Status | Meaning | Description | Schema |
| ------ | ------------------------------------------------------------ | ----------- | ------------------------------------------------ | |--------|--------------------------------------------------------------|-------------|--------------------------------------------------|
| 201 | [Created](https://tools.ietf.org/html/rfc7231#section-6.3.2) | Created | [codersdk.Response](schemas.md#codersdkresponse) | | 201 | [Created](https://tools.ietf.org/html/rfc7231#section-6.3.2) | Created | [codersdk.Response](schemas.md#codersdkresponse) |
To perform this operation, you must be authenticated. [Learn more](authentication.md). To perform this operation, you must be authenticated. [Learn more](authentication.md).
@ -122,7 +122,7 @@ curl -X GET http://coder-server:8080/api/v2/organizations \
### Responses ### Responses
| Status | Meaning | Description | Schema | | Status | Meaning | Description | Schema |
| ------ | ------------------------------------------------------- | ----------- | ----------------------------------------------------------------- | |--------|---------------------------------------------------------|-------------|-------------------------------------------------------------------|
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | array of [codersdk.Organization](schemas.md#codersdkorganization) | | 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | array of [codersdk.Organization](schemas.md#codersdkorganization) |
<h3 id="get-organizations-responseschema">Response Schema</h3> <h3 id="get-organizations-responseschema">Response Schema</h3>
@ -130,7 +130,7 @@ curl -X GET http://coder-server:8080/api/v2/organizations \
Status Code **200** Status Code **200**
| Name | Type | Required | Restrictions | Description | | Name | Type | Required | Restrictions | Description |
| ---------------- | ----------------- | -------- | ------------ | ----------- | |------------------|-------------------|----------|--------------|-------------|
| `[array item]` | array | false | | | | `[array item]` | array | false | | |
| `» created_at` | string(date-time) | true | | | | `» created_at` | string(date-time) | true | | |
| `» description` | string | false | | | | `» description` | string | false | | |
@ -171,7 +171,7 @@ curl -X POST http://coder-server:8080/api/v2/organizations \
### Parameters ### Parameters
| Name | In | Type | Required | Description | | Name | In | Type | Required | Description |
| ------ | ---- | ---------------------------------------------------------------------------------- | -------- | --------------------------- | |--------|------|------------------------------------------------------------------------------------|----------|-----------------------------|
| `body` | body | [codersdk.CreateOrganizationRequest](schemas.md#codersdkcreateorganizationrequest) | true | Create organization request | | `body` | body | [codersdk.CreateOrganizationRequest](schemas.md#codersdkcreateorganizationrequest) | true | Create organization request |
### Example responses ### Example responses
@ -194,7 +194,7 @@ curl -X POST http://coder-server:8080/api/v2/organizations \
### Responses ### Responses
| Status | Meaning | Description | Schema | | Status | Meaning | Description | Schema |
| ------ | ------------------------------------------------------------ | ----------- | -------------------------------------------------------- | |--------|--------------------------------------------------------------|-------------|----------------------------------------------------------|
| 201 | [Created](https://tools.ietf.org/html/rfc7231#section-6.3.2) | Created | [codersdk.Organization](schemas.md#codersdkorganization) | | 201 | [Created](https://tools.ietf.org/html/rfc7231#section-6.3.2) | Created | [codersdk.Organization](schemas.md#codersdkorganization) |
To perform this operation, you must be authenticated. [Learn more](authentication.md). To perform this operation, you must be authenticated. [Learn more](authentication.md).
@ -215,7 +215,7 @@ curl -X GET http://coder-server:8080/api/v2/organizations/{organization} \
### Parameters ### Parameters
| Name | In | Type | Required | Description | | Name | In | Type | Required | Description |
| -------------- | ---- | ------------ | -------- | --------------- | |----------------|------|--------------|----------|-----------------|
| `organization` | path | string(uuid) | true | Organization ID | | `organization` | path | string(uuid) | true | Organization ID |
### Example responses ### Example responses
@ -238,7 +238,7 @@ curl -X GET http://coder-server:8080/api/v2/organizations/{organization} \
### Responses ### Responses
| Status | Meaning | Description | Schema | | Status | Meaning | Description | Schema |
| ------ | ------------------------------------------------------- | ----------- | -------------------------------------------------------- | |--------|---------------------------------------------------------|-------------|----------------------------------------------------------|
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.Organization](schemas.md#codersdkorganization) | | 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.Organization](schemas.md#codersdkorganization) |
To perform this operation, you must be authenticated. [Learn more](authentication.md). To perform this operation, you must be authenticated. [Learn more](authentication.md).
@ -259,7 +259,7 @@ curl -X DELETE http://coder-server:8080/api/v2/organizations/{organization} \
### Parameters ### Parameters
| Name | In | Type | Required | Description | | Name | In | Type | Required | Description |
| -------------- | ---- | ------ | -------- | ----------------------- | |----------------|------|--------|----------|-------------------------|
| `organization` | path | string | true | Organization ID or name | | `organization` | path | string | true | Organization ID or name |
### Example responses ### Example responses
@ -282,7 +282,7 @@ curl -X DELETE http://coder-server:8080/api/v2/organizations/{organization} \
### Responses ### Responses
| Status | Meaning | Description | Schema | | Status | Meaning | Description | Schema |
| ------ | ------------------------------------------------------- | ----------- | ------------------------------------------------ | |--------|---------------------------------------------------------|-------------|--------------------------------------------------|
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.Response](schemas.md#codersdkresponse) | | 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.Response](schemas.md#codersdkresponse) |
To perform this operation, you must be authenticated. [Learn more](authentication.md). To perform this operation, you must be authenticated. [Learn more](authentication.md).
@ -315,7 +315,7 @@ curl -X PATCH http://coder-server:8080/api/v2/organizations/{organization} \
### Parameters ### Parameters
| Name | In | Type | Required | Description | | Name | In | Type | Required | Description |
| -------------- | ---- | ---------------------------------------------------------------------------------- | -------- | -------------------------- | |----------------|------|------------------------------------------------------------------------------------|----------|----------------------------|
| `organization` | path | string | true | Organization ID or name | | `organization` | path | string | true | Organization ID or name |
| `body` | body | [codersdk.UpdateOrganizationRequest](schemas.md#codersdkupdateorganizationrequest) | true | Patch organization request | | `body` | body | [codersdk.UpdateOrganizationRequest](schemas.md#codersdkupdateorganizationrequest) | true | Patch organization request |
@ -339,7 +339,7 @@ curl -X PATCH http://coder-server:8080/api/v2/organizations/{organization} \
### Responses ### Responses
| Status | Meaning | Description | Schema | | Status | Meaning | Description | Schema |
| ------ | ------------------------------------------------------- | ----------- | -------------------------------------------------------- | |--------|---------------------------------------------------------|-------------|----------------------------------------------------------|
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.Organization](schemas.md#codersdkorganization) | | 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.Organization](schemas.md#codersdkorganization) |
To perform this operation, you must be authenticated. [Learn more](authentication.md). To perform this operation, you must be authenticated. [Learn more](authentication.md).

8
docs/reference/api/portsharing.md generated
View File

@ -25,14 +25,14 @@ curl -X DELETE http://coder-server:8080/api/v2/workspaces/{workspace}/port-share
### Parameters ### Parameters
| Name | In | Type | Required | Description | | Name | In | Type | Required | Description |
| ----------- | ---- | -------------------------------------------------------------------------------------------------------- | -------- | --------------------------------- | |-------------|------|----------------------------------------------------------------------------------------------------------|----------|-----------------------------------|
| `workspace` | path | string(uuid) | true | Workspace ID | | `workspace` | path | string(uuid) | true | Workspace ID |
| `body` | body | [codersdk.DeleteWorkspaceAgentPortShareRequest](schemas.md#codersdkdeleteworkspaceagentportsharerequest) | true | Delete port sharing level request | | `body` | body | [codersdk.DeleteWorkspaceAgentPortShareRequest](schemas.md#codersdkdeleteworkspaceagentportsharerequest) | true | Delete port sharing level request |
### Responses ### Responses
| Status | Meaning | Description | Schema | | Status | Meaning | Description | Schema |
| ------ | ------------------------------------------------------- | ----------- | ------ | |--------|---------------------------------------------------------|-------------|--------|
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | | | 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | |
To perform this operation, you must be authenticated. [Learn more](authentication.md). To perform this operation, you must be authenticated. [Learn more](authentication.md).
@ -65,7 +65,7 @@ curl -X POST http://coder-server:8080/api/v2/workspaces/{workspace}/port-share \
### Parameters ### Parameters
| Name | In | Type | Required | Description | | Name | In | Type | Required | Description |
| ----------- | ---- | -------------------------------------------------------------------------------------------------------- | -------- | --------------------------------- | |-------------|------|----------------------------------------------------------------------------------------------------------|----------|-----------------------------------|
| `workspace` | path | string(uuid) | true | Workspace ID | | `workspace` | path | string(uuid) | true | Workspace ID |
| `body` | body | [codersdk.UpsertWorkspaceAgentPortShareRequest](schemas.md#codersdkupsertworkspaceagentportsharerequest) | true | Upsert port sharing level request | | `body` | body | [codersdk.UpsertWorkspaceAgentPortShareRequest](schemas.md#codersdkupsertworkspaceagentportsharerequest) | true | Upsert port sharing level request |
@ -86,7 +86,7 @@ curl -X POST http://coder-server:8080/api/v2/workspaces/{workspace}/port-share \
### Responses ### Responses
| Status | Meaning | Description | Schema | | Status | Meaning | Description | Schema |
| ------ | ------------------------------------------------------- | ----------- | ------------------------------------------------------------------------------ | |--------|---------------------------------------------------------|-------------|--------------------------------------------------------------------------------|
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.WorkspaceAgentPortShare](schemas.md#codersdkworkspaceagentportshare) | | 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.WorkspaceAgentPortShare](schemas.md#codersdkworkspaceagentportshare) |
To perform this operation, you must be authenticated. [Learn more](authentication.md). To perform this operation, you must be authenticated. [Learn more](authentication.md).

1416
docs/reference/api/schemas.md generated
View File

File diff suppressed because it is too large Load Diff

298
docs/reference/api/templates.md generated
View File

@ -16,7 +16,7 @@ curl -X GET http://coder-server:8080/api/v2/organizations/{organization}/templat
### Parameters ### Parameters
| Name | In | Type | Required | Description | | Name | In | Type | Required | Description |
| -------------- | ---- | ------------ | -------- | --------------- | |----------------|------|--------------|----------|-----------------|
| `organization` | path | string(uuid) | true | Organization ID | | `organization` | path | string(uuid) | true | Organization ID |
### Example responses ### Example responses
@ -33,10 +33,14 @@ curl -X GET http://coder-server:8080/api/v2/organizations/{organization}/templat
"allow_user_autostop": true, "allow_user_autostop": true,
"allow_user_cancel_workspace_jobs": true, "allow_user_cancel_workspace_jobs": true,
"autostart_requirement": { "autostart_requirement": {
"days_of_week": ["monday"] "days_of_week": [
"monday"
]
}, },
"autostop_requirement": { "autostop_requirement": {
"days_of_week": ["monday"], "days_of_week": [
"monday"
],
"weeks": 0 "weeks": 0
}, },
"build_time_stats": { "build_time_stats": {
@ -78,7 +82,7 @@ curl -X GET http://coder-server:8080/api/v2/organizations/{organization}/templat
### Responses ### Responses
| Status | Meaning | Description | Schema | | Status | Meaning | Description | Schema |
| ------ | ------------------------------------------------------- | ----------- | --------------------------------------------------------- | |--------|---------------------------------------------------------|-------------|-----------------------------------------------------------|
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | array of [codersdk.Template](schemas.md#codersdktemplate) | | 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | array of [codersdk.Template](schemas.md#codersdktemplate) |
<h3 id="get-templates-by-organization-responseschema">Response Schema</h3> <h3 id="get-templates-by-organization-responseschema">Response Schema</h3>
@ -86,7 +90,7 @@ curl -X GET http://coder-server:8080/api/v2/organizations/{organization}/templat
Status Code **200** Status Code **200**
| Name | Type | Required | Restrictions | Description | | Name | Type | Required | Restrictions | Description |
| ------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | -------- | ------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | |--------------------------------------|------------------------------------------------------------------------------------------|----------|--------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `[array item]` | array | false | | | | `[array item]` | array | false | | |
| `» active_user_count` | integer | false | | Active user count is set to -1 when loading. | | `» active_user_count` | integer | false | | Active user count is set to -1 when loading. |
| `» active_version_id` | string(uuid) | false | | | | `» active_version_id` | string(uuid) | false | | |
@ -97,8 +101,8 @@ Status Code **200**
| `» autostart_requirement` | [codersdk.TemplateAutostartRequirement](schemas.md#codersdktemplateautostartrequirement) | false | | | | `» autostart_requirement` | [codersdk.TemplateAutostartRequirement](schemas.md#codersdktemplateautostartrequirement) | 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. | | `»» 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](schemas.md#codersdktemplateautostoprequirement) | 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. | | `» autostop_requirement` | [codersdk.TemplateAutostopRequirement](schemas.md#codersdktemplateautostoprequirement) | 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. | |`»» 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. | 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.| |`»» 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](schemas.md#codersdktemplatebuildtimestats)|false||| |`» build_time_stats`|[codersdk.TemplateBuildTimeStats](schemas.md#codersdktemplatebuildtimestats)|false|||
|`»» [any property]`|[codersdk.TransitionStats](schemas.md#codersdktransitionstats)|false||| |`»» [any property]`|[codersdk.TransitionStats](schemas.md#codersdktransitionstats)|false|||
@ -130,7 +134,7 @@ Status Code **200**
#### Enumerated Values #### Enumerated Values
| Property | Value | | Property | Value |
| ---------------------- | --------------- | |------------------------|-----------------|
| `max_port_share_level` | `owner` | | `max_port_share_level` | `owner` |
| `max_port_share_level` | `authenticated` | | `max_port_share_level` | `authenticated` |
| `max_port_share_level` | `public` | | `max_port_share_level` | `public` |
@ -161,10 +165,14 @@ curl -X POST http://coder-server:8080/api/v2/organizations/{organization}/templa
"allow_user_autostop": true, "allow_user_autostop": true,
"allow_user_cancel_workspace_jobs": true, "allow_user_cancel_workspace_jobs": true,
"autostart_requirement": { "autostart_requirement": {
"days_of_week": ["monday"] "days_of_week": [
"monday"
]
}, },
"autostop_requirement": { "autostop_requirement": {
"days_of_week": ["monday"], "days_of_week": [
"monday"
],
"weeks": 0 "weeks": 0
}, },
"default_ttl_ms": 0, "default_ttl_ms": 0,
@ -185,7 +193,7 @@ curl -X POST http://coder-server:8080/api/v2/organizations/{organization}/templa
### Parameters ### Parameters
| Name | In | Type | Required | Description | | Name | In | Type | Required | Description |
| -------------- | ---- | -------------------------------------------------------------------------- | -------- | --------------- | |----------------|------|----------------------------------------------------------------------------|----------|-----------------|
| `organization` | path | string | true | Organization ID | | `organization` | path | string | true | Organization ID |
| `body` | body | [codersdk.CreateTemplateRequest](schemas.md#codersdkcreatetemplaterequest) | true | Request body | | `body` | body | [codersdk.CreateTemplateRequest](schemas.md#codersdkcreatetemplaterequest) | true | Request body |
@ -202,10 +210,14 @@ curl -X POST http://coder-server:8080/api/v2/organizations/{organization}/templa
"allow_user_autostop": true, "allow_user_autostop": true,
"allow_user_cancel_workspace_jobs": true, "allow_user_cancel_workspace_jobs": true,
"autostart_requirement": { "autostart_requirement": {
"days_of_week": ["monday"] "days_of_week": [
"monday"
]
}, },
"autostop_requirement": { "autostop_requirement": {
"days_of_week": ["monday"], "days_of_week": [
"monday"
],
"weeks": 0 "weeks": 0
}, },
"build_time_stats": { "build_time_stats": {
@ -246,7 +258,7 @@ curl -X POST http://coder-server:8080/api/v2/organizations/{organization}/templa
### Responses ### Responses
| Status | Meaning | Description | Schema | | Status | Meaning | Description | Schema |
| ------ | ------------------------------------------------------- | ----------- | ------------------------------------------------ | |--------|---------------------------------------------------------|-------------|--------------------------------------------------|
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.Template](schemas.md#codersdktemplate) | | 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.Template](schemas.md#codersdktemplate) |
To perform this operation, you must be authenticated. [Learn more](authentication.md). To perform this operation, you must be authenticated. [Learn more](authentication.md).
@ -267,7 +279,7 @@ curl -X GET http://coder-server:8080/api/v2/organizations/{organization}/templat
### Parameters ### Parameters
| Name | In | Type | Required | Description | | Name | In | Type | Required | Description |
| -------------- | ---- | ------------ | -------- | --------------- | |----------------|------|--------------|----------|-----------------|
| `organization` | path | string(uuid) | true | Organization ID | | `organization` | path | string(uuid) | true | Organization ID |
### Example responses ### Example responses
@ -282,7 +294,9 @@ curl -X GET http://coder-server:8080/api/v2/organizations/{organization}/templat
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"markdown": "string", "markdown": "string",
"name": "string", "name": "string",
"tags": ["string"], "tags": [
"string"
],
"url": "string" "url": "string"
} }
] ]
@ -291,7 +305,7 @@ curl -X GET http://coder-server:8080/api/v2/organizations/{organization}/templat
### Responses ### Responses
| Status | Meaning | Description | Schema | | Status | Meaning | Description | Schema |
| ------ | ------------------------------------------------------- | ----------- | ----------------------------------------------------------------------- | |--------|---------------------------------------------------------|-------------|-------------------------------------------------------------------------|
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | array of [codersdk.TemplateExample](schemas.md#codersdktemplateexample) | | 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | array of [codersdk.TemplateExample](schemas.md#codersdktemplateexample) |
<h3 id="get-template-examples-by-organization-responseschema">Response Schema</h3> <h3 id="get-template-examples-by-organization-responseschema">Response Schema</h3>
@ -299,7 +313,7 @@ curl -X GET http://coder-server:8080/api/v2/organizations/{organization}/templat
Status Code **200** Status Code **200**
| Name | Type | Required | Restrictions | Description | | Name | Type | Required | Restrictions | Description |
| --------------- | ------------ | -------- | ------------ | ----------- | |-----------------|--------------|----------|--------------|-------------|
| `[array item]` | array | false | | | | `[array item]` | array | false | | |
| `» description` | string | false | | | | `» description` | string | false | | |
| `» icon` | string | false | | | | `» icon` | string | false | | |
@ -327,7 +341,7 @@ curl -X GET http://coder-server:8080/api/v2/organizations/{organization}/templat
### Parameters ### Parameters
| Name | In | Type | Required | Description | | Name | In | Type | Required | Description |
| -------------- | ---- | ------------ | -------- | --------------- | |----------------|------|--------------|----------|-----------------|
| `organization` | path | string(uuid) | true | Organization ID | | `organization` | path | string(uuid) | true | Organization ID |
| `templatename` | path | string | true | Template name | | `templatename` | path | string | true | Template name |
@ -344,10 +358,14 @@ curl -X GET http://coder-server:8080/api/v2/organizations/{organization}/templat
"allow_user_autostop": true, "allow_user_autostop": true,
"allow_user_cancel_workspace_jobs": true, "allow_user_cancel_workspace_jobs": true,
"autostart_requirement": { "autostart_requirement": {
"days_of_week": ["monday"] "days_of_week": [
"monday"
]
}, },
"autostop_requirement": { "autostop_requirement": {
"days_of_week": ["monday"], "days_of_week": [
"monday"
],
"weeks": 0 "weeks": 0
}, },
"build_time_stats": { "build_time_stats": {
@ -388,7 +406,7 @@ curl -X GET http://coder-server:8080/api/v2/organizations/{organization}/templat
### Responses ### Responses
| Status | Meaning | Description | Schema | | Status | Meaning | Description | Schema |
| ------ | ------------------------------------------------------- | ----------- | ------------------------------------------------ | |--------|---------------------------------------------------------|-------------|--------------------------------------------------|
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.Template](schemas.md#codersdktemplate) | | 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.Template](schemas.md#codersdktemplate) |
To perform this operation, you must be authenticated. [Learn more](authentication.md). To perform this operation, you must be authenticated. [Learn more](authentication.md).
@ -409,7 +427,7 @@ curl -X GET http://coder-server:8080/api/v2/organizations/{organization}/templat
### Parameters ### Parameters
| Name | In | Type | Required | Description | | Name | In | Type | Required | Description |
| --------------------- | ---- | ------------ | -------- | --------------------- | |-----------------------|------|--------------|----------|-----------------------|
| `organization` | path | string(uuid) | true | Organization ID | | `organization` | path | string(uuid) | true | Organization ID |
| `templatename` | path | string | true | Template name | | `templatename` | path | string | true | Template name |
| `templateversionname` | path | string | true | Template version name | | `templateversionname` | path | string | true | Template version name |
@ -457,14 +475,16 @@ curl -X GET http://coder-server:8080/api/v2/organizations/{organization}/templat
"readme": "string", "readme": "string",
"template_id": "c6d67e98-83ea-49f0-8812-e4abae2b68bc", "template_id": "c6d67e98-83ea-49f0-8812-e4abae2b68bc",
"updated_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z",
"warnings": ["UNSUPPORTED_WORKSPACES"] "warnings": [
"UNSUPPORTED_WORKSPACES"
]
} }
``` ```
### Responses ### Responses
| Status | Meaning | Description | Schema | | Status | Meaning | Description | Schema |
| ------ | ------------------------------------------------------- | ----------- | -------------------------------------------------------------- | |--------|---------------------------------------------------------|-------------|----------------------------------------------------------------|
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.TemplateVersion](schemas.md#codersdktemplateversion) | | 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.TemplateVersion](schemas.md#codersdktemplateversion) |
To perform this operation, you must be authenticated. [Learn more](authentication.md). To perform this operation, you must be authenticated. [Learn more](authentication.md).
@ -485,7 +505,7 @@ curl -X GET http://coder-server:8080/api/v2/organizations/{organization}/templat
### Parameters ### Parameters
| Name | In | Type | Required | Description | | Name | In | Type | Required | Description |
| --------------------- | ---- | ------------ | -------- | --------------------- | |-----------------------|------|--------------|----------|-----------------------|
| `organization` | path | string(uuid) | true | Organization ID | | `organization` | path | string(uuid) | true | Organization ID |
| `templatename` | path | string | true | Template name | | `templatename` | path | string | true | Template name |
| `templateversionname` | path | string | true | Template version name | | `templateversionname` | path | string | true | Template version name |
@ -533,14 +553,16 @@ curl -X GET http://coder-server:8080/api/v2/organizations/{organization}/templat
"readme": "string", "readme": "string",
"template_id": "c6d67e98-83ea-49f0-8812-e4abae2b68bc", "template_id": "c6d67e98-83ea-49f0-8812-e4abae2b68bc",
"updated_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z",
"warnings": ["UNSUPPORTED_WORKSPACES"] "warnings": [
"UNSUPPORTED_WORKSPACES"
]
} }
``` ```
### Responses ### Responses
| Status | Meaning | Description | Schema | | Status | Meaning | Description | Schema |
| ------ | ------------------------------------------------------- | ----------- | -------------------------------------------------------------- | |--------|---------------------------------------------------------|-------------|----------------------------------------------------------------|
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.TemplateVersion](schemas.md#codersdktemplateversion) | | 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.TemplateVersion](schemas.md#codersdktemplateversion) |
To perform this operation, you must be authenticated. [Learn more](authentication.md). To perform this operation, you must be authenticated. [Learn more](authentication.md).
@ -586,7 +608,7 @@ curl -X POST http://coder-server:8080/api/v2/organizations/{organization}/templa
### Parameters ### Parameters
| Name | In | Type | Required | Description | | Name | In | Type | Required | Description |
| -------------- | ---- | ---------------------------------------------------------------------------------------- | -------- | ------------------------------- | |----------------|------|------------------------------------------------------------------------------------------|----------|---------------------------------|
| `organization` | path | string(uuid) | true | Organization ID | | `organization` | path | string(uuid) | true | Organization ID |
| `body` | body | [codersdk.CreateTemplateVersionRequest](schemas.md#codersdkcreatetemplateversionrequest) | true | Create template version request | | `body` | body | [codersdk.CreateTemplateVersionRequest](schemas.md#codersdkcreatetemplateversionrequest) | true | Create template version request |
@ -633,14 +655,16 @@ curl -X POST http://coder-server:8080/api/v2/organizations/{organization}/templa
"readme": "string", "readme": "string",
"template_id": "c6d67e98-83ea-49f0-8812-e4abae2b68bc", "template_id": "c6d67e98-83ea-49f0-8812-e4abae2b68bc",
"updated_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z",
"warnings": ["UNSUPPORTED_WORKSPACES"] "warnings": [
"UNSUPPORTED_WORKSPACES"
]
} }
``` ```
### Responses ### Responses
| Status | Meaning | Description | Schema | | Status | Meaning | Description | Schema |
| ------ | ------------------------------------------------------------ | ----------- | -------------------------------------------------------------- | |--------|--------------------------------------------------------------|-------------|----------------------------------------------------------------|
| 201 | [Created](https://tools.ietf.org/html/rfc7231#section-6.3.2) | Created | [codersdk.TemplateVersion](schemas.md#codersdktemplateversion) | | 201 | [Created](https://tools.ietf.org/html/rfc7231#section-6.3.2) | Created | [codersdk.TemplateVersion](schemas.md#codersdktemplateversion) |
To perform this operation, you must be authenticated. [Learn more](authentication.md). To perform this operation, you must be authenticated. [Learn more](authentication.md).
@ -672,10 +696,14 @@ curl -X GET http://coder-server:8080/api/v2/templates \
"allow_user_autostop": true, "allow_user_autostop": true,
"allow_user_cancel_workspace_jobs": true, "allow_user_cancel_workspace_jobs": true,
"autostart_requirement": { "autostart_requirement": {
"days_of_week": ["monday"] "days_of_week": [
"monday"
]
}, },
"autostop_requirement": { "autostop_requirement": {
"days_of_week": ["monday"], "days_of_week": [
"monday"
],
"weeks": 0 "weeks": 0
}, },
"build_time_stats": { "build_time_stats": {
@ -717,7 +745,7 @@ curl -X GET http://coder-server:8080/api/v2/templates \
### Responses ### Responses
| Status | Meaning | Description | Schema | | Status | Meaning | Description | Schema |
| ------ | ------------------------------------------------------- | ----------- | --------------------------------------------------------- | |--------|---------------------------------------------------------|-------------|-----------------------------------------------------------|
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | array of [codersdk.Template](schemas.md#codersdktemplate) | | 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | array of [codersdk.Template](schemas.md#codersdktemplate) |
<h3 id="get-all-templates-responseschema">Response Schema</h3> <h3 id="get-all-templates-responseschema">Response Schema</h3>
@ -725,7 +753,7 @@ curl -X GET http://coder-server:8080/api/v2/templates \
Status Code **200** Status Code **200**
| Name | Type | Required | Restrictions | Description | | Name | Type | Required | Restrictions | Description |
| ------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | -------- | ------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | |--------------------------------------|------------------------------------------------------------------------------------------|----------|--------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `[array item]` | array | false | | | | `[array item]` | array | false | | |
| `» active_user_count` | integer | false | | Active user count is set to -1 when loading. | | `» active_user_count` | integer | false | | Active user count is set to -1 when loading. |
| `» active_version_id` | string(uuid) | false | | | | `» active_version_id` | string(uuid) | false | | |
@ -736,8 +764,8 @@ Status Code **200**
| `» autostart_requirement` | [codersdk.TemplateAutostartRequirement](schemas.md#codersdktemplateautostartrequirement) | false | | | | `» autostart_requirement` | [codersdk.TemplateAutostartRequirement](schemas.md#codersdktemplateautostartrequirement) | 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. | | `»» 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](schemas.md#codersdktemplateautostoprequirement) | 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. | | `» autostop_requirement` | [codersdk.TemplateAutostopRequirement](schemas.md#codersdktemplateautostoprequirement) | 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. | |`»» 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. | 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.| |`»» 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](schemas.md#codersdktemplatebuildtimestats)|false||| |`» build_time_stats`|[codersdk.TemplateBuildTimeStats](schemas.md#codersdktemplatebuildtimestats)|false|||
|`»» [any property]`|[codersdk.TransitionStats](schemas.md#codersdktransitionstats)|false||| |`»» [any property]`|[codersdk.TransitionStats](schemas.md#codersdktransitionstats)|false|||
@ -769,7 +797,7 @@ Status Code **200**
#### Enumerated Values #### Enumerated Values
| Property | Value | | Property | Value |
| ---------------------- | --------------- | |------------------------|-----------------|
| `max_port_share_level` | `owner` | | `max_port_share_level` | `owner` |
| `max_port_share_level` | `authenticated` | | `max_port_share_level` | `authenticated` |
| `max_port_share_level` | `public` | | `max_port_share_level` | `public` |
@ -802,7 +830,9 @@ curl -X GET http://coder-server:8080/api/v2/templates/examples \
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"markdown": "string", "markdown": "string",
"name": "string", "name": "string",
"tags": ["string"], "tags": [
"string"
],
"url": "string" "url": "string"
} }
] ]
@ -811,7 +841,7 @@ curl -X GET http://coder-server:8080/api/v2/templates/examples \
### Responses ### Responses
| Status | Meaning | Description | Schema | | Status | Meaning | Description | Schema |
| ------ | ------------------------------------------------------- | ----------- | ----------------------------------------------------------------------- | |--------|---------------------------------------------------------|-------------|-------------------------------------------------------------------------|
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | array of [codersdk.TemplateExample](schemas.md#codersdktemplateexample) | | 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | array of [codersdk.TemplateExample](schemas.md#codersdktemplateexample) |
<h3 id="get-template-examples-responseschema">Response Schema</h3> <h3 id="get-template-examples-responseschema">Response Schema</h3>
@ -819,7 +849,7 @@ curl -X GET http://coder-server:8080/api/v2/templates/examples \
Status Code **200** Status Code **200**
| Name | Type | Required | Restrictions | Description | | Name | Type | Required | Restrictions | Description |
| --------------- | ------------ | -------- | ------------ | ----------- | |-----------------|--------------|----------|--------------|-------------|
| `[array item]` | array | false | | | | `[array item]` | array | false | | |
| `» description` | string | false | | | | `» description` | string | false | | |
| `» icon` | string | false | | | | `» icon` | string | false | | |
@ -847,7 +877,7 @@ curl -X GET http://coder-server:8080/api/v2/templates/{template} \
### Parameters ### Parameters
| Name | In | Type | Required | Description | | Name | In | Type | Required | Description |
| ---------- | ---- | ------------ | -------- | ----------- | |------------|------|--------------|----------|-------------|
| `template` | path | string(uuid) | true | Template ID | | `template` | path | string(uuid) | true | Template ID |
### Example responses ### Example responses
@ -863,10 +893,14 @@ curl -X GET http://coder-server:8080/api/v2/templates/{template} \
"allow_user_autostop": true, "allow_user_autostop": true,
"allow_user_cancel_workspace_jobs": true, "allow_user_cancel_workspace_jobs": true,
"autostart_requirement": { "autostart_requirement": {
"days_of_week": ["monday"] "days_of_week": [
"monday"
]
}, },
"autostop_requirement": { "autostop_requirement": {
"days_of_week": ["monday"], "days_of_week": [
"monday"
],
"weeks": 0 "weeks": 0
}, },
"build_time_stats": { "build_time_stats": {
@ -907,7 +941,7 @@ curl -X GET http://coder-server:8080/api/v2/templates/{template} \
### Responses ### Responses
| Status | Meaning | Description | Schema | | Status | Meaning | Description | Schema |
| ------ | ------------------------------------------------------- | ----------- | ------------------------------------------------ | |--------|---------------------------------------------------------|-------------|--------------------------------------------------|
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.Template](schemas.md#codersdktemplate) | | 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.Template](schemas.md#codersdktemplate) |
To perform this operation, you must be authenticated. [Learn more](authentication.md). To perform this operation, you must be authenticated. [Learn more](authentication.md).
@ -928,7 +962,7 @@ curl -X DELETE http://coder-server:8080/api/v2/templates/{template} \
### Parameters ### Parameters
| Name | In | Type | Required | Description | | Name | In | Type | Required | Description |
| ---------- | ---- | ------------ | -------- | ----------- | |------------|------|--------------|----------|-------------|
| `template` | path | string(uuid) | true | Template ID | | `template` | path | string(uuid) | true | Template ID |
### Example responses ### Example responses
@ -951,7 +985,7 @@ curl -X DELETE http://coder-server:8080/api/v2/templates/{template} \
### Responses ### Responses
| Status | Meaning | Description | Schema | | Status | Meaning | Description | Schema |
| ------ | ------------------------------------------------------- | ----------- | ------------------------------------------------ | |--------|---------------------------------------------------------|-------------|--------------------------------------------------|
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.Response](schemas.md#codersdkresponse) | | 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.Response](schemas.md#codersdkresponse) |
To perform this operation, you must be authenticated. [Learn more](authentication.md). To perform this operation, you must be authenticated. [Learn more](authentication.md).
@ -972,7 +1006,7 @@ curl -X PATCH http://coder-server:8080/api/v2/templates/{template} \
### Parameters ### Parameters
| Name | In | Type | Required | Description | | Name | In | Type | Required | Description |
| ---------- | ---- | ------------ | -------- | ----------- | |------------|------|--------------|----------|-------------|
| `template` | path | string(uuid) | true | Template ID | | `template` | path | string(uuid) | true | Template ID |
### Example responses ### Example responses
@ -988,10 +1022,14 @@ curl -X PATCH http://coder-server:8080/api/v2/templates/{template} \
"allow_user_autostop": true, "allow_user_autostop": true,
"allow_user_cancel_workspace_jobs": true, "allow_user_cancel_workspace_jobs": true,
"autostart_requirement": { "autostart_requirement": {
"days_of_week": ["monday"] "days_of_week": [
"monday"
]
}, },
"autostop_requirement": { "autostop_requirement": {
"days_of_week": ["monday"], "days_of_week": [
"monday"
],
"weeks": 0 "weeks": 0
}, },
"build_time_stats": { "build_time_stats": {
@ -1032,7 +1070,7 @@ curl -X PATCH http://coder-server:8080/api/v2/templates/{template} \
### Responses ### Responses
| Status | Meaning | Description | Schema | | Status | Meaning | Description | Schema |
| ------ | ------------------------------------------------------- | ----------- | ------------------------------------------------ | |--------|---------------------------------------------------------|-------------|--------------------------------------------------|
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.Template](schemas.md#codersdktemplate) | | 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.Template](schemas.md#codersdktemplate) |
To perform this operation, you must be authenticated. [Learn more](authentication.md). To perform this operation, you must be authenticated. [Learn more](authentication.md).
@ -1053,7 +1091,7 @@ curl -X GET http://coder-server:8080/api/v2/templates/{template}/daus \
### Parameters ### Parameters
| Name | In | Type | Required | Description | | Name | In | Type | Required | Description |
| ---------- | ---- | ------------ | -------- | ----------- | |------------|------|--------------|----------|-------------|
| `template` | path | string(uuid) | true | Template ID | | `template` | path | string(uuid) | true | Template ID |
### Example responses ### Example responses
@ -1075,7 +1113,7 @@ curl -X GET http://coder-server:8080/api/v2/templates/{template}/daus \
### Responses ### Responses
| Status | Meaning | Description | Schema | | Status | Meaning | Description | Schema |
| ------ | ------------------------------------------------------- | ----------- | -------------------------------------------------------- | |--------|---------------------------------------------------------|-------------|----------------------------------------------------------|
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.DAUsResponse](schemas.md#codersdkdausresponse) | | 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.DAUsResponse](schemas.md#codersdkdausresponse) |
To perform this operation, you must be authenticated. [Learn more](authentication.md). To perform this operation, you must be authenticated. [Learn more](authentication.md).
@ -1096,7 +1134,7 @@ curl -X GET http://coder-server:8080/api/v2/templates/{template}/versions \
### Parameters ### Parameters
| Name | In | Type | Required | Description | | Name | In | Type | Required | Description |
| ------------------ | ----- | ------------ | -------- | ------------------------------------- | |--------------------|-------|--------------|----------|---------------------------------------|
| `template` | path | string(uuid) | true | Template ID | | `template` | path | string(uuid) | true | Template ID |
| `after_id` | query | string(uuid) | false | After ID | | `after_id` | query | string(uuid) | false | After ID |
| `include_archived` | query | boolean | false | Include archived versions in the list | | `include_archived` | query | boolean | false | Include archived versions in the list |
@ -1147,7 +1185,9 @@ curl -X GET http://coder-server:8080/api/v2/templates/{template}/versions \
"readme": "string", "readme": "string",
"template_id": "c6d67e98-83ea-49f0-8812-e4abae2b68bc", "template_id": "c6d67e98-83ea-49f0-8812-e4abae2b68bc",
"updated_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z",
"warnings": ["UNSUPPORTED_WORKSPACES"] "warnings": [
"UNSUPPORTED_WORKSPACES"
]
} }
] ]
``` ```
@ -1155,7 +1195,7 @@ curl -X GET http://coder-server:8080/api/v2/templates/{template}/versions \
### Responses ### Responses
| Status | Meaning | Description | Schema | | Status | Meaning | Description | Schema |
| ------ | ------------------------------------------------------- | ----------- | ----------------------------------------------------------------------- | |--------|---------------------------------------------------------|-------------|-------------------------------------------------------------------------|
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | array of [codersdk.TemplateVersion](schemas.md#codersdktemplateversion) | | 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | array of [codersdk.TemplateVersion](schemas.md#codersdktemplateversion) |
<h3 id="list-template-versions-by-template-id-responseschema">Response Schema</h3> <h3 id="list-template-versions-by-template-id-responseschema">Response Schema</h3>
@ -1163,7 +1203,7 @@ curl -X GET http://coder-server:8080/api/v2/templates/{template}/versions \
Status Code **200** Status Code **200**
| Name | Type | Required | Restrictions | Description | | Name | Type | Required | Restrictions | Description |
| ------------------------ | ------------------------------------------------------------------------ | -------- | ------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- | |--------------------------|--------------------------------------------------------------------------|----------|--------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `[array item]` | array | false | | | | `[array item]` | array | false | | |
| `» archived` | boolean | false | | | | `» archived` | boolean | false | | |
| `» created_at` | string(date-time) | false | | | | `» created_at` | string(date-time) | false | | |
@ -1202,7 +1242,7 @@ Status Code **200**
#### Enumerated Values #### Enumerated Values
| Property | Value | | Property | Value |
| ------------ | ----------------------------- | |--------------|-------------------------------|
| `error_code` | `REQUIRED_TEMPLATE_VARIABLES` | | `error_code` | `REQUIRED_TEMPLATE_VARIABLES` |
| `status` | `pending` | | `status` | `pending` |
| `status` | `running` | | `status` | `running` |
@ -1238,7 +1278,7 @@ curl -X PATCH http://coder-server:8080/api/v2/templates/{template}/versions \
### Parameters ### Parameters
| Name | In | Type | Required | Description | | Name | In | Type | Required | Description |
| ---------- | ---- | -------------------------------------------------------------------------------------- | -------- | ------------------------- | |------------|------|----------------------------------------------------------------------------------------|----------|---------------------------|
| `template` | path | string(uuid) | true | Template ID | | `template` | path | string(uuid) | true | Template ID |
| `body` | body | [codersdk.UpdateActiveTemplateVersion](schemas.md#codersdkupdateactivetemplateversion) | true | Modified template version | | `body` | body | [codersdk.UpdateActiveTemplateVersion](schemas.md#codersdkupdateactivetemplateversion) | true | Modified template version |
@ -1262,7 +1302,7 @@ curl -X PATCH http://coder-server:8080/api/v2/templates/{template}/versions \
### Responses ### Responses
| Status | Meaning | Description | Schema | | Status | Meaning | Description | Schema |
| ------ | ------------------------------------------------------- | ----------- | ------------------------------------------------ | |--------|---------------------------------------------------------|-------------|--------------------------------------------------|
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.Response](schemas.md#codersdkresponse) | | 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.Response](schemas.md#codersdkresponse) |
To perform this operation, you must be authenticated. [Learn more](authentication.md). To perform this operation, you must be authenticated. [Learn more](authentication.md).
@ -1292,7 +1332,7 @@ curl -X POST http://coder-server:8080/api/v2/templates/{template}/versions/archi
### Parameters ### Parameters
| Name | In | Type | Required | Description | | Name | In | Type | Required | Description |
| ---------- | ---- | -------------------------------------------------------------------------------------------- | -------- | --------------- | |------------|------|----------------------------------------------------------------------------------------------|----------|-----------------|
| `template` | path | string(uuid) | true | Template ID | | `template` | path | string(uuid) | true | Template ID |
| `body` | body | [codersdk.ArchiveTemplateVersionsRequest](schemas.md#codersdkarchivetemplateversionsrequest) | true | Archive request | | `body` | body | [codersdk.ArchiveTemplateVersionsRequest](schemas.md#codersdkarchivetemplateversionsrequest) | true | Archive request |
@ -1316,7 +1356,7 @@ curl -X POST http://coder-server:8080/api/v2/templates/{template}/versions/archi
### Responses ### Responses
| Status | Meaning | Description | Schema | | Status | Meaning | Description | Schema |
| ------ | ------------------------------------------------------- | ----------- | ------------------------------------------------ | |--------|---------------------------------------------------------|-------------|--------------------------------------------------|
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.Response](schemas.md#codersdkresponse) | | 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.Response](schemas.md#codersdkresponse) |
To perform this operation, you must be authenticated. [Learn more](authentication.md). To perform this operation, you must be authenticated. [Learn more](authentication.md).
@ -1337,7 +1377,7 @@ curl -X GET http://coder-server:8080/api/v2/templates/{template}/versions/{templ
### Parameters ### Parameters
| Name | In | Type | Required | Description | | Name | In | Type | Required | Description |
| --------------------- | ---- | ------------ | -------- | --------------------- | |-----------------------|------|--------------|----------|-----------------------|
| `template` | path | string(uuid) | true | Template ID | | `template` | path | string(uuid) | true | Template ID |
| `templateversionname` | path | string | true | Template version name | | `templateversionname` | path | string | true | Template version name |
@ -1385,7 +1425,9 @@ curl -X GET http://coder-server:8080/api/v2/templates/{template}/versions/{templ
"readme": "string", "readme": "string",
"template_id": "c6d67e98-83ea-49f0-8812-e4abae2b68bc", "template_id": "c6d67e98-83ea-49f0-8812-e4abae2b68bc",
"updated_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z",
"warnings": ["UNSUPPORTED_WORKSPACES"] "warnings": [
"UNSUPPORTED_WORKSPACES"
]
} }
] ]
``` ```
@ -1393,7 +1435,7 @@ curl -X GET http://coder-server:8080/api/v2/templates/{template}/versions/{templ
### Responses ### Responses
| Status | Meaning | Description | Schema | | Status | Meaning | Description | Schema |
| ------ | ------------------------------------------------------- | ----------- | ----------------------------------------------------------------------- | |--------|---------------------------------------------------------|-------------|-------------------------------------------------------------------------|
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | array of [codersdk.TemplateVersion](schemas.md#codersdktemplateversion) | | 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | array of [codersdk.TemplateVersion](schemas.md#codersdktemplateversion) |
<h3 id="get-template-version-by-template-id-and-name-responseschema">Response Schema</h3> <h3 id="get-template-version-by-template-id-and-name-responseschema">Response Schema</h3>
@ -1401,7 +1443,7 @@ curl -X GET http://coder-server:8080/api/v2/templates/{template}/versions/{templ
Status Code **200** Status Code **200**
| Name | Type | Required | Restrictions | Description | | Name | Type | Required | Restrictions | Description |
| ------------------------ | ------------------------------------------------------------------------ | -------- | ------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- | |--------------------------|--------------------------------------------------------------------------|----------|--------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `[array item]` | array | false | | | | `[array item]` | array | false | | |
| `» archived` | boolean | false | | | | `» archived` | boolean | false | | |
| `» created_at` | string(date-time) | false | | | | `» created_at` | string(date-time) | false | | |
@ -1440,7 +1482,7 @@ Status Code **200**
#### Enumerated Values #### Enumerated Values
| Property | Value | | Property | Value |
| ------------ | ----------------------------- | |--------------|-------------------------------|
| `error_code` | `REQUIRED_TEMPLATE_VARIABLES` | | `error_code` | `REQUIRED_TEMPLATE_VARIABLES` |
| `status` | `pending` | | `status` | `pending` |
| `status` | `running` | | `status` | `running` |
@ -1467,7 +1509,7 @@ curl -X GET http://coder-server:8080/api/v2/templateversions/{templateversion} \
### Parameters ### Parameters
| Name | In | Type | Required | Description | | Name | In | Type | Required | Description |
| ----------------- | ---- | ------------ | -------- | ------------------- | |-------------------|------|--------------|----------|---------------------|
| `templateversion` | path | string(uuid) | true | Template version ID | | `templateversion` | path | string(uuid) | true | Template version ID |
### Example responses ### Example responses
@ -1513,14 +1555,16 @@ curl -X GET http://coder-server:8080/api/v2/templateversions/{templateversion} \
"readme": "string", "readme": "string",
"template_id": "c6d67e98-83ea-49f0-8812-e4abae2b68bc", "template_id": "c6d67e98-83ea-49f0-8812-e4abae2b68bc",
"updated_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z",
"warnings": ["UNSUPPORTED_WORKSPACES"] "warnings": [
"UNSUPPORTED_WORKSPACES"
]
} }
``` ```
### Responses ### Responses
| Status | Meaning | Description | Schema | | Status | Meaning | Description | Schema |
| ------ | ------------------------------------------------------- | ----------- | -------------------------------------------------------------- | |--------|---------------------------------------------------------|-------------|----------------------------------------------------------------|
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.TemplateVersion](schemas.md#codersdktemplateversion) | | 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.TemplateVersion](schemas.md#codersdktemplateversion) |
To perform this operation, you must be authenticated. [Learn more](authentication.md). To perform this operation, you must be authenticated. [Learn more](authentication.md).
@ -1551,7 +1595,7 @@ curl -X PATCH http://coder-server:8080/api/v2/templateversions/{templateversion}
### Parameters ### Parameters
| Name | In | Type | Required | Description | | Name | In | Type | Required | Description |
| ----------------- | ---- | -------------------------------------------------------------------------------------- | -------- | ------------------------------ | |-------------------|------|----------------------------------------------------------------------------------------|----------|--------------------------------|
| `templateversion` | path | string(uuid) | true | Template version ID | | `templateversion` | path | string(uuid) | true | Template version ID |
| `body` | body | [codersdk.PatchTemplateVersionRequest](schemas.md#codersdkpatchtemplateversionrequest) | true | Patch template version request | | `body` | body | [codersdk.PatchTemplateVersionRequest](schemas.md#codersdkpatchtemplateversionrequest) | true | Patch template version request |
@ -1598,14 +1642,16 @@ curl -X PATCH http://coder-server:8080/api/v2/templateversions/{templateversion}
"readme": "string", "readme": "string",
"template_id": "c6d67e98-83ea-49f0-8812-e4abae2b68bc", "template_id": "c6d67e98-83ea-49f0-8812-e4abae2b68bc",
"updated_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z",
"warnings": ["UNSUPPORTED_WORKSPACES"] "warnings": [
"UNSUPPORTED_WORKSPACES"
]
} }
``` ```
### Responses ### Responses
| Status | Meaning | Description | Schema | | Status | Meaning | Description | Schema |
| ------ | ------------------------------------------------------- | ----------- | -------------------------------------------------------------- | |--------|---------------------------------------------------------|-------------|----------------------------------------------------------------|
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.TemplateVersion](schemas.md#codersdktemplateversion) | | 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.TemplateVersion](schemas.md#codersdktemplateversion) |
To perform this operation, you must be authenticated. [Learn more](authentication.md). To perform this operation, you must be authenticated. [Learn more](authentication.md).
@ -1626,7 +1672,7 @@ curl -X POST http://coder-server:8080/api/v2/templateversions/{templateversion}/
### Parameters ### Parameters
| Name | In | Type | Required | Description | | Name | In | Type | Required | Description |
| ----------------- | ---- | ------------ | -------- | ------------------- | |-------------------|------|--------------|----------|---------------------|
| `templateversion` | path | string(uuid) | true | Template version ID | | `templateversion` | path | string(uuid) | true | Template version ID |
### Example responses ### Example responses
@ -1649,7 +1695,7 @@ curl -X POST http://coder-server:8080/api/v2/templateversions/{templateversion}/
### Responses ### Responses
| Status | Meaning | Description | Schema | | Status | Meaning | Description | Schema |
| ------ | ------------------------------------------------------- | ----------- | ------------------------------------------------ | |--------|---------------------------------------------------------|-------------|--------------------------------------------------|
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.Response](schemas.md#codersdkresponse) | | 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.Response](schemas.md#codersdkresponse) |
To perform this operation, you must be authenticated. [Learn more](authentication.md). To perform this operation, you must be authenticated. [Learn more](authentication.md).
@ -1670,7 +1716,7 @@ curl -X PATCH http://coder-server:8080/api/v2/templateversions/{templateversion}
### Parameters ### Parameters
| Name | In | Type | Required | Description | | Name | In | Type | Required | Description |
| ----------------- | ---- | ------------ | -------- | ------------------- | |-------------------|------|--------------|----------|---------------------|
| `templateversion` | path | string(uuid) | true | Template version ID | | `templateversion` | path | string(uuid) | true | Template version ID |
### Example responses ### Example responses
@ -1693,7 +1739,7 @@ curl -X PATCH http://coder-server:8080/api/v2/templateversions/{templateversion}
### Responses ### Responses
| Status | Meaning | Description | Schema | | Status | Meaning | Description | Schema |
| ------ | ------------------------------------------------------- | ----------- | ------------------------------------------------ | |--------|---------------------------------------------------------|-------------|--------------------------------------------------|
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.Response](schemas.md#codersdkresponse) | | 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.Response](schemas.md#codersdkresponse) |
To perform this operation, you must be authenticated. [Learn more](authentication.md). To perform this operation, you must be authenticated. [Learn more](authentication.md).
@ -1735,7 +1781,7 @@ curl -X POST http://coder-server:8080/api/v2/templateversions/{templateversion}/
### Parameters ### Parameters
| Name | In | Type | Required | Description | | Name | In | Type | Required | Description |
| ----------------- | ---- | ---------------------------------------------------------------------------------------------------- | -------- | ------------------- | |-------------------|------|------------------------------------------------------------------------------------------------------|----------|---------------------|
| `templateversion` | path | string(uuid) | true | Template version ID | | `templateversion` | path | string(uuid) | true | Template version ID |
| `body` | body | [codersdk.CreateTemplateVersionDryRunRequest](schemas.md#codersdkcreatetemplateversiondryrunrequest) | true | Dry-run request | | `body` | body | [codersdk.CreateTemplateVersionDryRunRequest](schemas.md#codersdkcreatetemplateversiondryrunrequest) | true | Dry-run request |
@ -1767,7 +1813,7 @@ curl -X POST http://coder-server:8080/api/v2/templateversions/{templateversion}/
### Responses ### Responses
| Status | Meaning | Description | Schema | | Status | Meaning | Description | Schema |
| ------ | ------------------------------------------------------------ | ----------- | ------------------------------------------------------------ | |--------|--------------------------------------------------------------|-------------|--------------------------------------------------------------|
| 201 | [Created](https://tools.ietf.org/html/rfc7231#section-6.3.2) | Created | [codersdk.ProvisionerJob](schemas.md#codersdkprovisionerjob) | | 201 | [Created](https://tools.ietf.org/html/rfc7231#section-6.3.2) | Created | [codersdk.ProvisionerJob](schemas.md#codersdkprovisionerjob) |
To perform this operation, you must be authenticated. [Learn more](authentication.md). To perform this operation, you must be authenticated. [Learn more](authentication.md).
@ -1788,7 +1834,7 @@ curl -X GET http://coder-server:8080/api/v2/templateversions/{templateversion}/d
### Parameters ### Parameters
| Name | In | Type | Required | Description | | Name | In | Type | Required | Description |
| ----------------- | ---- | ------------ | -------- | ------------------- | |-------------------|------|--------------|----------|---------------------|
| `templateversion` | path | string(uuid) | true | Template version ID | | `templateversion` | path | string(uuid) | true | Template version ID |
| `jobID` | path | string(uuid) | true | Job ID | | `jobID` | path | string(uuid) | true | Job ID |
@ -1820,7 +1866,7 @@ curl -X GET http://coder-server:8080/api/v2/templateversions/{templateversion}/d
### Responses ### Responses
| Status | Meaning | Description | Schema | | Status | Meaning | Description | Schema |
| ------ | ------------------------------------------------------- | ----------- | ------------------------------------------------------------ | |--------|---------------------------------------------------------|-------------|--------------------------------------------------------------|
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.ProvisionerJob](schemas.md#codersdkprovisionerjob) | | 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.ProvisionerJob](schemas.md#codersdkprovisionerjob) |
To perform this operation, you must be authenticated. [Learn more](authentication.md). To perform this operation, you must be authenticated. [Learn more](authentication.md).
@ -1841,7 +1887,7 @@ curl -X PATCH http://coder-server:8080/api/v2/templateversions/{templateversion}
### Parameters ### Parameters
| Name | In | Type | Required | Description | | Name | In | Type | Required | Description |
| ----------------- | ---- | ------------ | -------- | ------------------- | |-------------------|------|--------------|----------|---------------------|
| `jobID` | path | string(uuid) | true | Job ID | | `jobID` | path | string(uuid) | true | Job ID |
| `templateversion` | path | string(uuid) | true | Template version ID | | `templateversion` | path | string(uuid) | true | Template version ID |
@ -1865,7 +1911,7 @@ curl -X PATCH http://coder-server:8080/api/v2/templateversions/{templateversion}
### Responses ### Responses
| Status | Meaning | Description | Schema | | Status | Meaning | Description | Schema |
| ------ | ------------------------------------------------------- | ----------- | ------------------------------------------------ | |--------|---------------------------------------------------------|-------------|--------------------------------------------------|
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.Response](schemas.md#codersdkresponse) | | 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.Response](schemas.md#codersdkresponse) |
To perform this operation, you must be authenticated. [Learn more](authentication.md). To perform this operation, you must be authenticated. [Learn more](authentication.md).
@ -1886,7 +1932,7 @@ curl -X GET http://coder-server:8080/api/v2/templateversions/{templateversion}/d
### Parameters ### Parameters
| Name | In | Type | Required | Description | | Name | In | Type | Required | Description |
| ----------------- | ----- | ------------ | -------- | --------------------- | |-------------------|-------|--------------|----------|-----------------------|
| `templateversion` | path | string(uuid) | true | Template version ID | | `templateversion` | path | string(uuid) | true | Template version ID |
| `jobID` | path | string(uuid) | true | Job ID | | `jobID` | path | string(uuid) | true | Job ID |
| `before` | query | integer | false | Before Unix timestamp | | `before` | query | integer | false | Before Unix timestamp |
@ -1913,7 +1959,7 @@ curl -X GET http://coder-server:8080/api/v2/templateversions/{templateversion}/d
### Responses ### Responses
| Status | Meaning | Description | Schema | | Status | Meaning | Description | Schema |
| ------ | ------------------------------------------------------- | ----------- | --------------------------------------------------------------------------- | |--------|---------------------------------------------------------|-------------|-----------------------------------------------------------------------------|
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | array of [codersdk.ProvisionerJobLog](schemas.md#codersdkprovisionerjoblog) | | 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | array of [codersdk.ProvisionerJobLog](schemas.md#codersdkprovisionerjoblog) |
<h3 id="get-template-version-dry-run-logs-by-job-id-responseschema">Response Schema</h3> <h3 id="get-template-version-dry-run-logs-by-job-id-responseschema">Response Schema</h3>
@ -1921,7 +1967,7 @@ curl -X GET http://coder-server:8080/api/v2/templateversions/{templateversion}/d
Status Code **200** Status Code **200**
| Name | Type | Required | Restrictions | Description | | Name | Type | Required | Restrictions | Description |
| -------------- | -------------------------------------------------- | -------- | ------------ | ----------- | |----------------|----------------------------------------------------|----------|--------------|-------------|
| `[array item]` | array | false | | | | `[array item]` | array | false | | |
| `» created_at` | string(date-time) | false | | | | `» created_at` | string(date-time) | false | | |
| `» id` | integer | false | | | | `» id` | integer | false | | |
@ -1933,7 +1979,7 @@ Status Code **200**
#### Enumerated Values #### Enumerated Values
| Property | Value | | Property | Value |
| ------------ | -------------------- | |--------------|----------------------|
| `log_level` | `trace` | | `log_level` | `trace` |
| `log_level` | `debug` | | `log_level` | `debug` |
| `log_level` | `info` | | `log_level` | `info` |
@ -1960,7 +2006,7 @@ curl -X GET http://coder-server:8080/api/v2/templateversions/{templateversion}/d
### Parameters ### Parameters
| Name | In | Type | Required | Description | | Name | In | Type | Required | Description |
| ----------------- | ---- | ------------ | -------- | ------------------- | |-------------------|------|--------------|----------|---------------------|
| `templateversion` | path | string(uuid) | true | Template version ID | | `templateversion` | path | string(uuid) | true | Template version ID |
| `jobID` | path | string(uuid) | true | Job ID | | `jobID` | path | string(uuid) | true | Job ID |
@ -1979,7 +2025,7 @@ curl -X GET http://coder-server:8080/api/v2/templateversions/{templateversion}/d
### Responses ### Responses
| Status | Meaning | Description | Schema | | Status | Meaning | Description | Schema |
| ------ | ------------------------------------------------------- | ----------- | ---------------------------------------------------------------------- | |--------|---------------------------------------------------------|-------------|------------------------------------------------------------------------|
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.MatchedProvisioners](schemas.md#codersdkmatchedprovisioners) | | 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.MatchedProvisioners](schemas.md#codersdkmatchedprovisioners) |
To perform this operation, you must be authenticated. [Learn more](authentication.md). To perform this operation, you must be authenticated. [Learn more](authentication.md).
@ -2000,7 +2046,7 @@ curl -X GET http://coder-server:8080/api/v2/templateversions/{templateversion}/d
### Parameters ### Parameters
| Name | In | Type | Required | Description | | Name | In | Type | Required | Description |
| ----------------- | ---- | ------------ | -------- | ------------------- | |-------------------|------|--------------|----------|---------------------|
| `templateversion` | path | string(uuid) | true | Template version ID | | `templateversion` | path | string(uuid) | true | Template version ID |
| `jobID` | path | string(uuid) | true | Job ID | | `jobID` | path | string(uuid) | true | Job ID |
@ -2041,7 +2087,9 @@ curl -X GET http://coder-server:8080/api/v2/templateversions/{templateversion}/d
"created_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z",
"directory": "string", "directory": "string",
"disconnected_at": "2019-08-24T14:15:22Z", "disconnected_at": "2019-08-24T14:15:22Z",
"display_apps": ["vscode"], "display_apps": [
"vscode"
],
"environment_variables": { "environment_variables": {
"property1": "string", "property1": "string",
"property2": "string" "property2": "string"
@ -2098,7 +2146,9 @@ curl -X GET http://coder-server:8080/api/v2/templateversions/{templateversion}/d
"started_at": "2019-08-24T14:15:22Z", "started_at": "2019-08-24T14:15:22Z",
"startup_script_behavior": "blocking", "startup_script_behavior": "blocking",
"status": "connecting", "status": "connecting",
"subsystems": ["envbox"], "subsystems": [
"envbox"
],
"troubleshooting_url": "string", "troubleshooting_url": "string",
"updated_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z",
"version": "string" "version": "string"
@ -2127,7 +2177,7 @@ curl -X GET http://coder-server:8080/api/v2/templateversions/{templateversion}/d
### Responses ### Responses
| Status | Meaning | Description | Schema | | Status | Meaning | Description | Schema |
| ------ | ------------------------------------------------------- | ----------- | --------------------------------------------------------------------------- | |--------|---------------------------------------------------------|-------------|-----------------------------------------------------------------------------|
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | array of [codersdk.WorkspaceResource](schemas.md#codersdkworkspaceresource) | | 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | array of [codersdk.WorkspaceResource](schemas.md#codersdkworkspaceresource) |
<h3 id="get-template-version-dry-run-resources-by-job-id-responseschema">Response Schema</h3> <h3 id="get-template-version-dry-run-resources-by-job-id-responseschema">Response Schema</h3>
@ -2135,7 +2185,7 @@ curl -X GET http://coder-server:8080/api/v2/templateversions/{templateversion}/d
Status Code **200** Status Code **200**
| Name | Type | Required | Restrictions | Description | | Name | Type | Required | Restrictions | Description |
| ------------------------------- | ------------------------------------------------------------------------------------------------------ | -------- | ------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | |---------------------------------|--------------------------------------------------------------------------------------------------------|----------|--------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `[array item]` | array | false | | | | `[array item]` | array | false | | |
| `» agents` | array | false | | | | `» agents` | array | false | | |
| `»» api_version` | string | false | | | | `»» api_version` | string | false | | |
@ -2225,7 +2275,7 @@ Status Code **200**
#### Enumerated Values #### Enumerated Values
| Property | Value | | Property | Value |
| ------------------------- | ------------------ | |---------------------------|--------------------|
| `health` | `disabled` | | `health` | `disabled` |
| `health` | `initializing` | | `health` | `initializing` |
| `health` | `healthy` | | `health` | `healthy` |
@ -2270,7 +2320,7 @@ curl -X GET http://coder-server:8080/api/v2/templateversions/{templateversion}/e
### Parameters ### Parameters
| Name | In | Type | Required | Description | | Name | In | Type | Required | Description |
| ----------------- | ---- | ------------ | -------- | ------------------- | |-------------------|------|--------------|----------|---------------------|
| `templateversion` | path | string(uuid) | true | Template version ID | | `templateversion` | path | string(uuid) | true | Template version ID |
### Example responses ### Example responses
@ -2294,7 +2344,7 @@ curl -X GET http://coder-server:8080/api/v2/templateversions/{templateversion}/e
### Responses ### Responses
| Status | Meaning | Description | Schema | | Status | Meaning | Description | Schema |
| ------ | ------------------------------------------------------- | ----------- | ----------------------------------------------------------------------------------------------- | |--------|---------------------------------------------------------|-------------|-------------------------------------------------------------------------------------------------|
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | array of [codersdk.TemplateVersionExternalAuth](schemas.md#codersdktemplateversionexternalauth) | | 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | array of [codersdk.TemplateVersionExternalAuth](schemas.md#codersdktemplateversionexternalauth) |
<h3 id="get-external-auth-by-template-version-responseschema">Response Schema</h3> <h3 id="get-external-auth-by-template-version-responseschema">Response Schema</h3>
@ -2302,7 +2352,7 @@ curl -X GET http://coder-server:8080/api/v2/templateversions/{templateversion}/e
Status Code **200** Status Code **200**
| Name | Type | Required | Restrictions | Description | | Name | Type | Required | Restrictions | Description |
| -------------------- | ------- | -------- | ------------ | ----------- | |----------------------|---------|----------|--------------|-------------|
| `[array item]` | array | false | | | | `[array item]` | array | false | | |
| `» authenticate_url` | string | false | | | | `» authenticate_url` | string | false | | |
| `» authenticated` | boolean | false | | | | `» authenticated` | boolean | false | | |
@ -2330,7 +2380,7 @@ curl -X GET http://coder-server:8080/api/v2/templateversions/{templateversion}/l
### Parameters ### Parameters
| Name | In | Type | Required | Description | | Name | In | Type | Required | Description |
| ----------------- | ----- | ------------ | -------- | ------------------- | |-------------------|-------|--------------|----------|---------------------|
| `templateversion` | path | string(uuid) | true | Template version ID | | `templateversion` | path | string(uuid) | true | Template version ID |
| `before` | query | integer | false | Before log id | | `before` | query | integer | false | Before log id |
| `after` | query | integer | false | After log id | | `after` | query | integer | false | After log id |
@ -2356,7 +2406,7 @@ curl -X GET http://coder-server:8080/api/v2/templateversions/{templateversion}/l
### Responses ### Responses
| Status | Meaning | Description | Schema | | Status | Meaning | Description | Schema |
| ------ | ------------------------------------------------------- | ----------- | --------------------------------------------------------------------------- | |--------|---------------------------------------------------------|-------------|-----------------------------------------------------------------------------|
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | array of [codersdk.ProvisionerJobLog](schemas.md#codersdkprovisionerjoblog) | | 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | array of [codersdk.ProvisionerJobLog](schemas.md#codersdkprovisionerjoblog) |
<h3 id="get-logs-by-template-version-responseschema">Response Schema</h3> <h3 id="get-logs-by-template-version-responseschema">Response Schema</h3>
@ -2364,7 +2414,7 @@ curl -X GET http://coder-server:8080/api/v2/templateversions/{templateversion}/l
Status Code **200** Status Code **200**
| Name | Type | Required | Restrictions | Description | | Name | Type | Required | Restrictions | Description |
| -------------- | -------------------------------------------------- | -------- | ------------ | ----------- | |----------------|----------------------------------------------------|----------|--------------|-------------|
| `[array item]` | array | false | | | | `[array item]` | array | false | | |
| `» created_at` | string(date-time) | false | | | | `» created_at` | string(date-time) | false | | |
| `» id` | integer | false | | | | `» id` | integer | false | | |
@ -2376,7 +2426,7 @@ Status Code **200**
#### Enumerated Values #### Enumerated Values
| Property | Value | | Property | Value |
| ------------ | -------------------- | |--------------|----------------------|
| `log_level` | `trace` | | `log_level` | `trace` |
| `log_level` | `debug` | | `log_level` | `debug` |
| `log_level` | `info` | | `log_level` | `info` |
@ -2402,13 +2452,13 @@ curl -X GET http://coder-server:8080/api/v2/templateversions/{templateversion}/p
### Parameters ### Parameters
| Name | In | Type | Required | Description | | Name | In | Type | Required | Description |
| ----------------- | ---- | ------------ | -------- | ------------------- | |-------------------|------|--------------|----------|---------------------|
| `templateversion` | path | string(uuid) | true | Template version ID | | `templateversion` | path | string(uuid) | true | Template version ID |
### Responses ### Responses
| Status | Meaning | Description | Schema | | Status | Meaning | Description | Schema |
| ------ | ------------------------------------------------------- | ----------- | ------ | |--------|---------------------------------------------------------|-------------|--------|
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | | | 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | |
To perform this operation, you must be authenticated. [Learn more](authentication.md). To perform this operation, you must be authenticated. [Learn more](authentication.md).
@ -2429,7 +2479,7 @@ curl -X GET http://coder-server:8080/api/v2/templateversions/{templateversion}/r
### Parameters ### Parameters
| Name | In | Type | Required | Description | | Name | In | Type | Required | Description |
| ----------------- | ---- | ------------ | -------- | ------------------- | |-------------------|------|--------------|----------|---------------------|
| `templateversion` | path | string(uuid) | true | Template version ID | | `templateversion` | path | string(uuid) | true | Template version ID |
### Example responses ### Example responses
@ -2469,7 +2519,9 @@ curl -X GET http://coder-server:8080/api/v2/templateversions/{templateversion}/r
"created_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z",
"directory": "string", "directory": "string",
"disconnected_at": "2019-08-24T14:15:22Z", "disconnected_at": "2019-08-24T14:15:22Z",
"display_apps": ["vscode"], "display_apps": [
"vscode"
],
"environment_variables": { "environment_variables": {
"property1": "string", "property1": "string",
"property2": "string" "property2": "string"
@ -2526,7 +2578,9 @@ curl -X GET http://coder-server:8080/api/v2/templateversions/{templateversion}/r
"started_at": "2019-08-24T14:15:22Z", "started_at": "2019-08-24T14:15:22Z",
"startup_script_behavior": "blocking", "startup_script_behavior": "blocking",
"status": "connecting", "status": "connecting",
"subsystems": ["envbox"], "subsystems": [
"envbox"
],
"troubleshooting_url": "string", "troubleshooting_url": "string",
"updated_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z",
"version": "string" "version": "string"
@ -2555,7 +2609,7 @@ curl -X GET http://coder-server:8080/api/v2/templateversions/{templateversion}/r
### Responses ### Responses
| Status | Meaning | Description | Schema | | Status | Meaning | Description | Schema |
| ------ | ------------------------------------------------------- | ----------- | --------------------------------------------------------------------------- | |--------|---------------------------------------------------------|-------------|-----------------------------------------------------------------------------|
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | array of [codersdk.WorkspaceResource](schemas.md#codersdkworkspaceresource) | | 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | array of [codersdk.WorkspaceResource](schemas.md#codersdkworkspaceresource) |
<h3 id="get-resources-by-template-version-responseschema">Response Schema</h3> <h3 id="get-resources-by-template-version-responseschema">Response Schema</h3>
@ -2563,7 +2617,7 @@ curl -X GET http://coder-server:8080/api/v2/templateversions/{templateversion}/r
Status Code **200** Status Code **200**
| Name | Type | Required | Restrictions | Description | | Name | Type | Required | Restrictions | Description |
| ------------------------------- | ------------------------------------------------------------------------------------------------------ | -------- | ------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | |---------------------------------|--------------------------------------------------------------------------------------------------------|----------|--------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `[array item]` | array | false | | | | `[array item]` | array | false | | |
| `» agents` | array | false | | | | `» agents` | array | false | | |
| `»» api_version` | string | false | | | | `»» api_version` | string | false | | |
@ -2653,7 +2707,7 @@ Status Code **200**
#### Enumerated Values #### Enumerated Values
| Property | Value | | Property | Value |
| ------------------------- | ------------------ | |---------------------------|--------------------|
| `health` | `disabled` | | `health` | `disabled` |
| `health` | `initializing` | | `health` | `initializing` |
| `health` | `healthy` | | `health` | `healthy` |
@ -2698,7 +2752,7 @@ curl -X GET http://coder-server:8080/api/v2/templateversions/{templateversion}/r
### Parameters ### Parameters
| Name | In | Type | Required | Description | | Name | In | Type | Required | Description |
| ----------------- | ---- | ------------ | -------- | ------------------- | |-------------------|------|--------------|----------|---------------------|
| `templateversion` | path | string(uuid) | true | Template version ID | | `templateversion` | path | string(uuid) | true | Template version ID |
### Example responses ### Example responses
@ -2738,7 +2792,7 @@ curl -X GET http://coder-server:8080/api/v2/templateversions/{templateversion}/r
### Responses ### Responses
| Status | Meaning | Description | Schema | | Status | Meaning | Description | Schema |
| ------ | ------------------------------------------------------- | ----------- | ----------------------------------------------------------------------------------------- | |--------|---------------------------------------------------------|-------------|-------------------------------------------------------------------------------------------|
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | array of [codersdk.TemplateVersionParameter](schemas.md#codersdktemplateversionparameter) | | 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | array of [codersdk.TemplateVersionParameter](schemas.md#codersdktemplateversionparameter) |
<h3 id="get-rich-parameters-by-template-version-responseschema">Response Schema</h3> <h3 id="get-rich-parameters-by-template-version-responseschema">Response Schema</h3>
@ -2746,7 +2800,7 @@ curl -X GET http://coder-server:8080/api/v2/templateversions/{templateversion}/r
Status Code **200** Status Code **200**
| Name | Type | Required | Restrictions | Description | | Name | Type | Required | Restrictions | Description |
| ------------------------- | -------------------------------------------------------------------------------- | -------- | ------------ | ----------- | |---------------------------|----------------------------------------------------------------------------------|----------|--------------|-------------|
| `[array item]` | array | false | | | | `[array item]` | array | false | | |
| `» default_value` | string | false | | | | `» default_value` | string | false | | |
| `» description` | string | false | | | | `» description` | string | false | | |
@ -2772,7 +2826,7 @@ Status Code **200**
#### Enumerated Values #### Enumerated Values
| Property | Value | | Property | Value |
| ---------------------- | -------------- | |------------------------|----------------|
| `type` | `string` | | `type` | `string` |
| `type` | `number` | | `type` | `number` |
| `type` | `bool` | | `type` | `bool` |
@ -2797,13 +2851,13 @@ curl -X GET http://coder-server:8080/api/v2/templateversions/{templateversion}/s
### Parameters ### Parameters
| Name | In | Type | Required | Description | | Name | In | Type | Required | Description |
| ----------------- | ---- | ------------ | -------- | ------------------- | |-------------------|------|--------------|----------|---------------------|
| `templateversion` | path | string(uuid) | true | Template version ID | | `templateversion` | path | string(uuid) | true | Template version ID |
### Responses ### Responses
| Status | Meaning | Description | Schema | | Status | Meaning | Description | Schema |
| ------ | ------------------------------------------------------- | ----------- | ------ | |--------|---------------------------------------------------------|-------------|--------|
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | | | 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | |
To perform this operation, you must be authenticated. [Learn more](authentication.md). To perform this operation, you must be authenticated. [Learn more](authentication.md).
@ -2824,7 +2878,7 @@ curl -X POST http://coder-server:8080/api/v2/templateversions/{templateversion}/
### Parameters ### Parameters
| Name | In | Type | Required | Description | | Name | In | Type | Required | Description |
| ----------------- | ---- | ------------ | -------- | ------------------- | |-------------------|------|--------------|----------|---------------------|
| `templateversion` | path | string(uuid) | true | Template version ID | | `templateversion` | path | string(uuid) | true | Template version ID |
### Example responses ### Example responses
@ -2847,7 +2901,7 @@ curl -X POST http://coder-server:8080/api/v2/templateversions/{templateversion}/
### Responses ### Responses
| Status | Meaning | Description | Schema | | Status | Meaning | Description | Schema |
| ------ | ------------------------------------------------------- | ----------- | ------------------------------------------------ | |--------|---------------------------------------------------------|-------------|--------------------------------------------------|
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.Response](schemas.md#codersdkresponse) | | 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.Response](schemas.md#codersdkresponse) |
To perform this operation, you must be authenticated. [Learn more](authentication.md). To perform this operation, you must be authenticated. [Learn more](authentication.md).
@ -2868,7 +2922,7 @@ curl -X GET http://coder-server:8080/api/v2/templateversions/{templateversion}/v
### Parameters ### Parameters
| Name | In | Type | Required | Description | | Name | In | Type | Required | Description |
| ----------------- | ---- | ------------ | -------- | ------------------- | |-------------------|------|--------------|----------|---------------------|
| `templateversion` | path | string(uuid) | true | Template version ID | | `templateversion` | path | string(uuid) | true | Template version ID |
### Example responses ### Example responses
@ -2892,7 +2946,7 @@ curl -X GET http://coder-server:8080/api/v2/templateversions/{templateversion}/v
### Responses ### Responses
| Status | Meaning | Description | Schema | | Status | Meaning | Description | Schema |
| ------ | ------------------------------------------------------- | ----------- | --------------------------------------------------------------------------------------- | |--------|---------------------------------------------------------|-------------|-----------------------------------------------------------------------------------------|
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | array of [codersdk.TemplateVersionVariable](schemas.md#codersdktemplateversionvariable) | | 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | array of [codersdk.TemplateVersionVariable](schemas.md#codersdktemplateversionvariable) |
<h3 id="get-template-variables-by-template-version-responseschema">Response Schema</h3> <h3 id="get-template-variables-by-template-version-responseschema">Response Schema</h3>
@ -2900,7 +2954,7 @@ curl -X GET http://coder-server:8080/api/v2/templateversions/{templateversion}/v
Status Code **200** Status Code **200**
| Name | Type | Required | Restrictions | Description | | Name | Type | Required | Restrictions | Description |
| ----------------- | ------- | -------- | ------------ | ----------- | |-------------------|---------|----------|--------------|-------------|
| `[array item]` | array | false | | | | `[array item]` | array | false | | |
| `» default_value` | string | false | | | | `» default_value` | string | false | | |
| `» description` | string | false | | | | `» description` | string | false | | |
@ -2913,7 +2967,7 @@ Status Code **200**
#### Enumerated Values #### Enumerated Values
| Property | Value | | Property | Value |
| -------- | -------- | |----------|----------|
| `type` | `string` | | `type` | `string` |
| `type` | `number` | | `type` | `number` |
| `type` | `bool` | | `type` | `bool` |

158
docs/reference/api/users.md generated
View File

@ -16,7 +16,7 @@ curl -X GET http://coder-server:8080/api/v2/users \
### Parameters ### Parameters
| Name | In | Type | Required | Description | | Name | In | Type | Required | Description |
| ---------- | ----- | ------------ | -------- | ------------ | |------------|-------|--------------|----------|--------------|
| `q` | query | string | false | Search query | | `q` | query | string | false | Search query |
| `after_id` | query | string(uuid) | false | After ID | | `after_id` | query | string(uuid) | false | After ID |
| `limit` | query | integer | false | Page limit | | `limit` | query | integer | false | Page limit |
@ -38,7 +38,9 @@ curl -X GET http://coder-server:8080/api/v2/users \
"last_seen_at": "2019-08-24T14:15:22Z", "last_seen_at": "2019-08-24T14:15:22Z",
"login_type": "", "login_type": "",
"name": "string", "name": "string",
"organization_ids": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"], "organization_ids": [
"497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"roles": [ "roles": [
{ {
"display_name": "string", "display_name": "string",
@ -58,7 +60,7 @@ curl -X GET http://coder-server:8080/api/v2/users \
### Responses ### Responses
| Status | Meaning | Description | Schema | | Status | Meaning | Description | Schema |
| ------ | ------------------------------------------------------- | ----------- | ---------------------------------------------------------------- | |--------|---------------------------------------------------------|-------------|------------------------------------------------------------------|
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.GetUsersResponse](schemas.md#codersdkgetusersresponse) | | 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.GetUsersResponse](schemas.md#codersdkgetusersresponse) |
To perform this operation, you must be authenticated. [Learn more](authentication.md). To perform this operation, you must be authenticated. [Learn more](authentication.md).
@ -84,7 +86,9 @@ curl -X POST http://coder-server:8080/api/v2/users \
"email": "user@example.com", "email": "user@example.com",
"login_type": "", "login_type": "",
"name": "string", "name": "string",
"organization_ids": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"], "organization_ids": [
"497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"password": "string", "password": "string",
"user_status": "active", "user_status": "active",
"username": "string" "username": "string"
@ -94,7 +98,7 @@ curl -X POST http://coder-server:8080/api/v2/users \
### Parameters ### Parameters
| Name | In | Type | Required | Description | | Name | In | Type | Required | Description |
| ------ | ---- | ---------------------------------------------------------------------------------- | -------- | ------------------- | |--------|------|------------------------------------------------------------------------------------|----------|---------------------|
| `body` | body | [codersdk.CreateUserRequestWithOrgs](schemas.md#codersdkcreateuserrequestwithorgs) | true | Create user request | | `body` | body | [codersdk.CreateUserRequestWithOrgs](schemas.md#codersdkcreateuserrequestwithorgs) | true | Create user request |
### Example responses ### Example responses
@ -110,7 +114,9 @@ curl -X POST http://coder-server:8080/api/v2/users \
"last_seen_at": "2019-08-24T14:15:22Z", "last_seen_at": "2019-08-24T14:15:22Z",
"login_type": "", "login_type": "",
"name": "string", "name": "string",
"organization_ids": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"], "organization_ids": [
"497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"roles": [ "roles": [
{ {
"display_name": "string", "display_name": "string",
@ -128,7 +134,7 @@ curl -X POST http://coder-server:8080/api/v2/users \
### Responses ### Responses
| Status | Meaning | Description | Schema | | Status | Meaning | Description | Schema |
| ------ | ------------------------------------------------------------ | ----------- | ---------------------------------------- | |--------|--------------------------------------------------------------|-------------|------------------------------------------|
| 201 | [Created](https://tools.ietf.org/html/rfc7231#section-6.3.2) | Created | [codersdk.User](schemas.md#codersdkuser) | | 201 | [Created](https://tools.ietf.org/html/rfc7231#section-6.3.2) | Created | [codersdk.User](schemas.md#codersdkuser) |
To perform this operation, you must be authenticated. [Learn more](authentication.md). To perform this operation, you must be authenticated. [Learn more](authentication.md).
@ -170,7 +176,7 @@ curl -X GET http://coder-server:8080/api/v2/users/authmethods \
### Responses ### Responses
| Status | Meaning | Description | Schema | | Status | Meaning | Description | Schema |
| ------ | ------------------------------------------------------- | ----------- | ------------------------------------------------------ | |--------|---------------------------------------------------------|-------------|--------------------------------------------------------|
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.AuthMethods](schemas.md#codersdkauthmethods) | | 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.AuthMethods](schemas.md#codersdkauthmethods) |
To perform this operation, you must be authenticated. [Learn more](authentication.md). To perform this operation, you must be authenticated. [Learn more](authentication.md).
@ -208,7 +214,7 @@ curl -X GET http://coder-server:8080/api/v2/users/first \
### Responses ### Responses
| Status | Meaning | Description | Schema | | Status | Meaning | Description | Schema |
| ------ | ------------------------------------------------------- | ----------- | ------------------------------------------------ | |--------|---------------------------------------------------------|-------------|--------------------------------------------------|
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.Response](schemas.md#codersdkresponse) | | 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.Response](schemas.md#codersdkresponse) |
To perform this operation, you must be authenticated. [Learn more](authentication.md). To perform this operation, you must be authenticated. [Learn more](authentication.md).
@ -251,7 +257,7 @@ curl -X POST http://coder-server:8080/api/v2/users/first \
### Parameters ### Parameters
| Name | In | Type | Required | Description | | Name | In | Type | Required | Description |
| ------ | ---- | ---------------------------------------------------------------------------- | -------- | ------------------ | |--------|------|------------------------------------------------------------------------------|----------|--------------------|
| `body` | body | [codersdk.CreateFirstUserRequest](schemas.md#codersdkcreatefirstuserrequest) | true | First user request | | `body` | body | [codersdk.CreateFirstUserRequest](schemas.md#codersdkcreatefirstuserrequest) | true | First user request |
### Example responses ### Example responses
@ -268,7 +274,7 @@ curl -X POST http://coder-server:8080/api/v2/users/first \
### Responses ### Responses
| Status | Meaning | Description | Schema | | Status | Meaning | Description | Schema |
| ------ | ------------------------------------------------------------ | ----------- | ------------------------------------------------------------------------------ | |--------|--------------------------------------------------------------|-------------|--------------------------------------------------------------------------------|
| 201 | [Created](https://tools.ietf.org/html/rfc7231#section-6.3.2) | Created | [codersdk.CreateFirstUserResponse](schemas.md#codersdkcreatefirstuserresponse) | | 201 | [Created](https://tools.ietf.org/html/rfc7231#section-6.3.2) | Created | [codersdk.CreateFirstUserResponse](schemas.md#codersdkcreatefirstuserresponse) |
To perform this operation, you must be authenticated. [Learn more](authentication.md). To perform this operation, you must be authenticated. [Learn more](authentication.md).
@ -306,7 +312,7 @@ curl -X POST http://coder-server:8080/api/v2/users/logout \
### Responses ### Responses
| Status | Meaning | Description | Schema | | Status | Meaning | Description | Schema |
| ------ | ------------------------------------------------------- | ----------- | ------------------------------------------------ | |--------|---------------------------------------------------------|-------------|--------------------------------------------------|
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.Response](schemas.md#codersdkresponse) | | 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.Response](schemas.md#codersdkresponse) |
To perform this operation, you must be authenticated. [Learn more](authentication.md). To perform this operation, you must be authenticated. [Learn more](authentication.md).
@ -326,7 +332,7 @@ curl -X GET http://coder-server:8080/api/v2/users/oauth2/github/callback \
### Responses ### Responses
| Status | Meaning | Description | Schema | | Status | Meaning | Description | Schema |
| ------ | ----------------------------------------------------------------------- | ------------------ | ------ | |--------|-------------------------------------------------------------------------|--------------------|--------|
| 307 | [Temporary Redirect](https://tools.ietf.org/html/rfc7231#section-6.4.7) | Temporary Redirect | | | 307 | [Temporary Redirect](https://tools.ietf.org/html/rfc7231#section-6.4.7) | Temporary Redirect | |
To perform this operation, you must be authenticated. [Learn more](authentication.md). To perform this operation, you must be authenticated. [Learn more](authentication.md).
@ -346,7 +352,7 @@ curl -X GET http://coder-server:8080/api/v2/users/oidc/callback \
### Responses ### Responses
| Status | Meaning | Description | Schema | | Status | Meaning | Description | Schema |
| ------ | ----------------------------------------------------------------------- | ------------------ | ------ | |--------|-------------------------------------------------------------------------|--------------------|--------|
| 307 | [Temporary Redirect](https://tools.ietf.org/html/rfc7231#section-6.4.7) | Temporary Redirect | | | 307 | [Temporary Redirect](https://tools.ietf.org/html/rfc7231#section-6.4.7) | Temporary Redirect | |
To perform this operation, you must be authenticated. [Learn more](authentication.md). To perform this operation, you must be authenticated. [Learn more](authentication.md).
@ -367,7 +373,7 @@ curl -X GET http://coder-server:8080/api/v2/users/{user} \
### Parameters ### Parameters
| Name | In | Type | Required | Description | | Name | In | Type | Required | Description |
| ------ | ---- | ------ | -------- | ------------------------ | |--------|------|--------|----------|--------------------------|
| `user` | path | string | true | User ID, username, or me | | `user` | path | string | true | User ID, username, or me |
### Example responses ### Example responses
@ -383,7 +389,9 @@ curl -X GET http://coder-server:8080/api/v2/users/{user} \
"last_seen_at": "2019-08-24T14:15:22Z", "last_seen_at": "2019-08-24T14:15:22Z",
"login_type": "", "login_type": "",
"name": "string", "name": "string",
"organization_ids": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"], "organization_ids": [
"497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"roles": [ "roles": [
{ {
"display_name": "string", "display_name": "string",
@ -401,7 +409,7 @@ curl -X GET http://coder-server:8080/api/v2/users/{user} \
### Responses ### Responses
| Status | Meaning | Description | Schema | | Status | Meaning | Description | Schema |
| ------ | ------------------------------------------------------- | ----------- | ---------------------------------------- | |--------|---------------------------------------------------------|-------------|------------------------------------------|
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.User](schemas.md#codersdkuser) | | 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.User](schemas.md#codersdkuser) |
To perform this operation, you must be authenticated. [Learn more](authentication.md). To perform this operation, you must be authenticated. [Learn more](authentication.md).
@ -421,13 +429,13 @@ curl -X DELETE http://coder-server:8080/api/v2/users/{user} \
### Parameters ### Parameters
| Name | In | Type | Required | Description | | Name | In | Type | Required | Description |
| ------ | ---- | ------ | -------- | -------------------- | |--------|------|--------|----------|----------------------|
| `user` | path | string | true | User ID, name, or me | | `user` | path | string | true | User ID, name, or me |
### Responses ### Responses
| Status | Meaning | Description | Schema | | Status | Meaning | Description | Schema |
| ------ | ------------------------------------------------------- | ----------- | ------ | |--------|---------------------------------------------------------|-------------|--------|
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | | | 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | |
To perform this operation, you must be authenticated. [Learn more](authentication.md). To perform this operation, you must be authenticated. [Learn more](authentication.md).
@ -457,7 +465,7 @@ curl -X PUT http://coder-server:8080/api/v2/users/{user}/appearance \
### Parameters ### Parameters
| Name | In | Type | Required | Description | | Name | In | Type | Required | Description |
| ------ | ---- | ------------------------------------------------------------------------------------------------------ | -------- | ----------------------- | |--------|------|--------------------------------------------------------------------------------------------------------|----------|-------------------------|
| `user` | path | string | true | User ID, name, or me | | `user` | path | string | true | User ID, name, or me |
| `body` | body | [codersdk.UpdateUserAppearanceSettingsRequest](schemas.md#codersdkupdateuserappearancesettingsrequest) | true | New appearance settings | | `body` | body | [codersdk.UpdateUserAppearanceSettingsRequest](schemas.md#codersdkupdateuserappearancesettingsrequest) | true | New appearance settings |
@ -474,7 +482,9 @@ curl -X PUT http://coder-server:8080/api/v2/users/{user}/appearance \
"last_seen_at": "2019-08-24T14:15:22Z", "last_seen_at": "2019-08-24T14:15:22Z",
"login_type": "", "login_type": "",
"name": "string", "name": "string",
"organization_ids": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"], "organization_ids": [
"497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"roles": [ "roles": [
{ {
"display_name": "string", "display_name": "string",
@ -492,7 +502,7 @@ curl -X PUT http://coder-server:8080/api/v2/users/{user}/appearance \
### Responses ### Responses
| Status | Meaning | Description | Schema | | Status | Meaning | Description | Schema |
| ------ | ------------------------------------------------------- | ----------- | ---------------------------------------- | |--------|---------------------------------------------------------|-------------|------------------------------------------|
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.User](schemas.md#codersdkuser) | | 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.User](schemas.md#codersdkuser) |
To perform this operation, you must be authenticated. [Learn more](authentication.md). To perform this operation, you must be authenticated. [Learn more](authentication.md).
@ -513,7 +523,7 @@ curl -X GET http://coder-server:8080/api/v2/users/{user}/autofill-parameters?tem
### Parameters ### Parameters
| Name | In | Type | Required | Description | | Name | In | Type | Required | Description |
| ------------- | ----- | ------ | -------- | ------------------------ | |---------------|-------|--------|----------|--------------------------|
| `user` | path | string | true | User ID, username, or me | | `user` | path | string | true | User ID, username, or me |
| `template_id` | query | string | true | Template ID | | `template_id` | query | string | true | Template ID |
@ -533,7 +543,7 @@ curl -X GET http://coder-server:8080/api/v2/users/{user}/autofill-parameters?tem
### Responses ### Responses
| Status | Meaning | Description | Schema | | Status | Meaning | Description | Schema |
| ------ | ------------------------------------------------------- | ----------- | ------------------------------------------------------------------- | |--------|---------------------------------------------------------|-------------|---------------------------------------------------------------------|
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | array of [codersdk.UserParameter](schemas.md#codersdkuserparameter) | | 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | array of [codersdk.UserParameter](schemas.md#codersdkuserparameter) |
<h3 id="get-autofill-build-parameters-for-user-responseschema">Response Schema</h3> <h3 id="get-autofill-build-parameters-for-user-responseschema">Response Schema</h3>
@ -541,7 +551,7 @@ curl -X GET http://coder-server:8080/api/v2/users/{user}/autofill-parameters?tem
Status Code **200** Status Code **200**
| Name | Type | Required | Restrictions | Description | | Name | Type | Required | Restrictions | Description |
| -------------- | ------ | -------- | ------------ | ----------- | |----------------|--------|----------|--------------|-------------|
| `[array item]` | array | false | | | | `[array item]` | array | false | | |
| `» name` | string | false | | | | `» name` | string | false | | |
| `» value` | string | false | | | | `» value` | string | false | | |
@ -564,7 +574,7 @@ curl -X GET http://coder-server:8080/api/v2/users/{user}/gitsshkey \
### Parameters ### Parameters
| Name | In | Type | Required | Description | | Name | In | Type | Required | Description |
| ------ | ---- | ------ | -------- | -------------------- | |--------|------|--------|----------|----------------------|
| `user` | path | string | true | User ID, name, or me | | `user` | path | string | true | User ID, name, or me |
### Example responses ### Example responses
@ -583,7 +593,7 @@ curl -X GET http://coder-server:8080/api/v2/users/{user}/gitsshkey \
### Responses ### Responses
| Status | Meaning | Description | Schema | | Status | Meaning | Description | Schema |
| ------ | ------------------------------------------------------- | ----------- | -------------------------------------------------- | |--------|---------------------------------------------------------|-------------|----------------------------------------------------|
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.GitSSHKey](schemas.md#codersdkgitsshkey) | | 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.GitSSHKey](schemas.md#codersdkgitsshkey) |
To perform this operation, you must be authenticated. [Learn more](authentication.md). To perform this operation, you must be authenticated. [Learn more](authentication.md).
@ -604,7 +614,7 @@ curl -X PUT http://coder-server:8080/api/v2/users/{user}/gitsshkey \
### Parameters ### Parameters
| Name | In | Type | Required | Description | | Name | In | Type | Required | Description |
| ------ | ---- | ------ | -------- | -------------------- | |--------|------|--------|----------|----------------------|
| `user` | path | string | true | User ID, name, or me | | `user` | path | string | true | User ID, name, or me |
### Example responses ### Example responses
@ -623,7 +633,7 @@ curl -X PUT http://coder-server:8080/api/v2/users/{user}/gitsshkey \
### Responses ### Responses
| Status | Meaning | Description | Schema | | Status | Meaning | Description | Schema |
| ------ | ------------------------------------------------------- | ----------- | -------------------------------------------------- | |--------|---------------------------------------------------------|-------------|----------------------------------------------------|
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.GitSSHKey](schemas.md#codersdkgitsshkey) | | 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.GitSSHKey](schemas.md#codersdkgitsshkey) |
To perform this operation, you must be authenticated. [Learn more](authentication.md). To perform this operation, you must be authenticated. [Learn more](authentication.md).
@ -644,7 +654,7 @@ curl -X POST http://coder-server:8080/api/v2/users/{user}/keys \
### Parameters ### Parameters
| Name | In | Type | Required | Description | | Name | In | Type | Required | Description |
| ------ | ---- | ------ | -------- | -------------------- | |--------|------|--------|----------|----------------------|
| `user` | path | string | true | User ID, name, or me | | `user` | path | string | true | User ID, name, or me |
### Example responses ### Example responses
@ -660,7 +670,7 @@ curl -X POST http://coder-server:8080/api/v2/users/{user}/keys \
### Responses ### Responses
| Status | Meaning | Description | Schema | | Status | Meaning | Description | Schema |
| ------ | ------------------------------------------------------------ | ----------- | ---------------------------------------------------------------------------- | |--------|--------------------------------------------------------------|-------------|------------------------------------------------------------------------------|
| 201 | [Created](https://tools.ietf.org/html/rfc7231#section-6.3.2) | Created | [codersdk.GenerateAPIKeyResponse](schemas.md#codersdkgenerateapikeyresponse) | | 201 | [Created](https://tools.ietf.org/html/rfc7231#section-6.3.2) | Created | [codersdk.GenerateAPIKeyResponse](schemas.md#codersdkgenerateapikeyresponse) |
To perform this operation, you must be authenticated. [Learn more](authentication.md). To perform this operation, you must be authenticated. [Learn more](authentication.md).
@ -681,7 +691,7 @@ curl -X GET http://coder-server:8080/api/v2/users/{user}/keys/tokens \
### Parameters ### Parameters
| Name | In | Type | Required | Description | | Name | In | Type | Required | Description |
| ------ | ---- | ------ | -------- | -------------------- | |--------|------|--------|----------|----------------------|
| `user` | path | string | true | User ID, name, or me | | `user` | path | string | true | User ID, name, or me |
### Example responses ### Example responses
@ -708,7 +718,7 @@ curl -X GET http://coder-server:8080/api/v2/users/{user}/keys/tokens \
### Responses ### Responses
| Status | Meaning | Description | Schema | | Status | Meaning | Description | Schema |
| ------ | ------------------------------------------------------- | ----------- | ----------------------------------------------------- | |--------|---------------------------------------------------------|-------------|-------------------------------------------------------|
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | array of [codersdk.APIKey](schemas.md#codersdkapikey) | | 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | array of [codersdk.APIKey](schemas.md#codersdkapikey) |
<h3 id="get-user-tokens-responseschema">Response Schema</h3> <h3 id="get-user-tokens-responseschema">Response Schema</h3>
@ -716,7 +726,7 @@ curl -X GET http://coder-server:8080/api/v2/users/{user}/keys/tokens \
Status Code **200** Status Code **200**
| Name | Type | Required | Restrictions | Description | | Name | Type | Required | Restrictions | Description |
| -------------------- | ------------------------------------------------------ | -------- | ------------ | ----------- | |----------------------|--------------------------------------------------------|----------|--------------|-------------|
| `[array item]` | array | false | | | | `[array item]` | array | false | | |
| `» created_at` | string(date-time) | true | | | | `» created_at` | string(date-time) | true | | |
| `» expires_at` | string(date-time) | true | | | | `» expires_at` | string(date-time) | true | | |
@ -732,7 +742,7 @@ Status Code **200**
#### Enumerated Values #### Enumerated Values
| Property | Value | | Property | Value |
| ------------ | --------------------- | |--------------|-----------------------|
| `login_type` | `password` | | `login_type` | `password` |
| `login_type` | `github` | | `login_type` | `github` |
| `login_type` | `oidc` | | `login_type` | `oidc` |
@ -769,7 +779,7 @@ curl -X POST http://coder-server:8080/api/v2/users/{user}/keys/tokens \
### Parameters ### Parameters
| Name | In | Type | Required | Description | | Name | In | Type | Required | Description |
| ------ | ---- | -------------------------------------------------------------------- | -------- | -------------------- | |--------|------|----------------------------------------------------------------------|----------|----------------------|
| `user` | path | string | true | User ID, name, or me | | `user` | path | string | true | User ID, name, or me |
| `body` | body | [codersdk.CreateTokenRequest](schemas.md#codersdkcreatetokenrequest) | true | Create token request | | `body` | body | [codersdk.CreateTokenRequest](schemas.md#codersdkcreatetokenrequest) | true | Create token request |
@ -786,7 +796,7 @@ curl -X POST http://coder-server:8080/api/v2/users/{user}/keys/tokens \
### Responses ### Responses
| Status | Meaning | Description | Schema | | Status | Meaning | Description | Schema |
| ------ | ------------------------------------------------------------ | ----------- | ---------------------------------------------------------------------------- | |--------|--------------------------------------------------------------|-------------|------------------------------------------------------------------------------|
| 201 | [Created](https://tools.ietf.org/html/rfc7231#section-6.3.2) | Created | [codersdk.GenerateAPIKeyResponse](schemas.md#codersdkgenerateapikeyresponse) | | 201 | [Created](https://tools.ietf.org/html/rfc7231#section-6.3.2) | Created | [codersdk.GenerateAPIKeyResponse](schemas.md#codersdkgenerateapikeyresponse) |
To perform this operation, you must be authenticated. [Learn more](authentication.md). To perform this operation, you must be authenticated. [Learn more](authentication.md).
@ -807,7 +817,7 @@ curl -X GET http://coder-server:8080/api/v2/users/{user}/keys/tokens/{keyname} \
### Parameters ### Parameters
| Name | In | Type | Required | Description | | Name | In | Type | Required | Description |
| --------- | ---- | -------------- | -------- | -------------------- | |-----------|------|----------------|----------|----------------------|
| `user` | path | string | true | User ID, name, or me | | `user` | path | string | true | User ID, name, or me |
| `keyname` | path | string(string) | true | Key Name | | `keyname` | path | string(string) | true | Key Name |
@ -833,7 +843,7 @@ curl -X GET http://coder-server:8080/api/v2/users/{user}/keys/tokens/{keyname} \
### Responses ### Responses
| Status | Meaning | Description | Schema | | Status | Meaning | Description | Schema |
| ------ | ------------------------------------------------------- | ----------- | -------------------------------------------- | |--------|---------------------------------------------------------|-------------|----------------------------------------------|
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.APIKey](schemas.md#codersdkapikey) | | 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.APIKey](schemas.md#codersdkapikey) |
To perform this operation, you must be authenticated. [Learn more](authentication.md). To perform this operation, you must be authenticated. [Learn more](authentication.md).
@ -854,7 +864,7 @@ curl -X GET http://coder-server:8080/api/v2/users/{user}/keys/{keyid} \
### Parameters ### Parameters
| Name | In | Type | Required | Description | | Name | In | Type | Required | Description |
| ------- | ---- | ------------ | -------- | -------------------- | |---------|------|--------------|----------|----------------------|
| `user` | path | string | true | User ID, name, or me | | `user` | path | string | true | User ID, name, or me |
| `keyid` | path | string(uuid) | true | Key ID | | `keyid` | path | string(uuid) | true | Key ID |
@ -880,7 +890,7 @@ curl -X GET http://coder-server:8080/api/v2/users/{user}/keys/{keyid} \
### Responses ### Responses
| Status | Meaning | Description | Schema | | Status | Meaning | Description | Schema |
| ------ | ------------------------------------------------------- | ----------- | -------------------------------------------- | |--------|---------------------------------------------------------|-------------|----------------------------------------------|
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.APIKey](schemas.md#codersdkapikey) | | 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.APIKey](schemas.md#codersdkapikey) |
To perform this operation, you must be authenticated. [Learn more](authentication.md). To perform this operation, you must be authenticated. [Learn more](authentication.md).
@ -900,14 +910,14 @@ curl -X DELETE http://coder-server:8080/api/v2/users/{user}/keys/{keyid} \
### Parameters ### Parameters
| Name | In | Type | Required | Description | | Name | In | Type | Required | Description |
| ------- | ---- | ------------ | -------- | -------------------- | |---------|------|--------------|----------|----------------------|
| `user` | path | string | true | User ID, name, or me | | `user` | path | string | true | User ID, name, or me |
| `keyid` | path | string(uuid) | true | Key ID | | `keyid` | path | string(uuid) | true | Key ID |
### Responses ### Responses
| Status | Meaning | Description | Schema | | Status | Meaning | Description | Schema |
| ------ | --------------------------------------------------------------- | ----------- | ------ | |--------|-----------------------------------------------------------------|-------------|--------|
| 204 | [No Content](https://tools.ietf.org/html/rfc7231#section-6.3.5) | No Content | | | 204 | [No Content](https://tools.ietf.org/html/rfc7231#section-6.3.5) | No Content | |
To perform this operation, you must be authenticated. [Learn more](authentication.md). To perform this operation, you must be authenticated. [Learn more](authentication.md).
@ -928,7 +938,7 @@ curl -X GET http://coder-server:8080/api/v2/users/{user}/login-type \
### Parameters ### Parameters
| Name | In | Type | Required | Description | | Name | In | Type | Required | Description |
| ------ | ---- | ------ | -------- | -------------------- | |--------|------|--------|----------|----------------------|
| `user` | path | string | true | User ID, name, or me | | `user` | path | string | true | User ID, name, or me |
### Example responses ### Example responses
@ -944,7 +954,7 @@ curl -X GET http://coder-server:8080/api/v2/users/{user}/login-type \
### Responses ### Responses
| Status | Meaning | Description | Schema | | Status | Meaning | Description | Schema |
| ------ | ------------------------------------------------------- | ----------- | ---------------------------------------------------------- | |--------|---------------------------------------------------------|-------------|------------------------------------------------------------|
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.UserLoginType](schemas.md#codersdkuserlogintype) | | 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.UserLoginType](schemas.md#codersdkuserlogintype) |
To perform this operation, you must be authenticated. [Learn more](authentication.md). To perform this operation, you must be authenticated. [Learn more](authentication.md).
@ -965,7 +975,7 @@ curl -X GET http://coder-server:8080/api/v2/users/{user}/organizations \
### Parameters ### Parameters
| Name | In | Type | Required | Description | | Name | In | Type | Required | Description |
| ------ | ---- | ------ | -------- | -------------------- | |--------|------|--------|----------|----------------------|
| `user` | path | string | true | User ID, name, or me | | `user` | path | string | true | User ID, name, or me |
### Example responses ### Example responses
@ -990,7 +1000,7 @@ curl -X GET http://coder-server:8080/api/v2/users/{user}/organizations \
### Responses ### Responses
| Status | Meaning | Description | Schema | | Status | Meaning | Description | Schema |
| ------ | ------------------------------------------------------- | ----------- | ----------------------------------------------------------------- | |--------|---------------------------------------------------------|-------------|-------------------------------------------------------------------|
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | array of [codersdk.Organization](schemas.md#codersdkorganization) | | 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | array of [codersdk.Organization](schemas.md#codersdkorganization) |
<h3 id="get-organizations-by-user-responseschema">Response Schema</h3> <h3 id="get-organizations-by-user-responseschema">Response Schema</h3>
@ -998,7 +1008,7 @@ curl -X GET http://coder-server:8080/api/v2/users/{user}/organizations \
Status Code **200** Status Code **200**
| Name | Type | Required | Restrictions | Description | | Name | Type | Required | Restrictions | Description |
| ---------------- | ----------------- | -------- | ------------ | ----------- | |------------------|-------------------|----------|--------------|-------------|
| `[array item]` | array | false | | | | `[array item]` | array | false | | |
| `» created_at` | string(date-time) | true | | | | `» created_at` | string(date-time) | true | | |
| `» description` | string | false | | | | `» description` | string | false | | |
@ -1027,7 +1037,7 @@ curl -X GET http://coder-server:8080/api/v2/users/{user}/organizations/{organiza
### Parameters ### Parameters
| Name | In | Type | Required | Description | | Name | In | Type | Required | Description |
| ------------------ | ---- | ------ | -------- | -------------------- | |--------------------|------|--------|----------|----------------------|
| `user` | path | string | true | User ID, name, or me | | `user` | path | string | true | User ID, name, or me |
| `organizationname` | path | string | true | Organization name | | `organizationname` | path | string | true | Organization name |
@ -1051,7 +1061,7 @@ curl -X GET http://coder-server:8080/api/v2/users/{user}/organizations/{organiza
### Responses ### Responses
| Status | Meaning | Description | Schema | | Status | Meaning | Description | Schema |
| ------ | ------------------------------------------------------- | ----------- | -------------------------------------------------------- | |--------|---------------------------------------------------------|-------------|----------------------------------------------------------|
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.Organization](schemas.md#codersdkorganization) | | 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.Organization](schemas.md#codersdkorganization) |
To perform this operation, you must be authenticated. [Learn more](authentication.md). To perform this operation, you must be authenticated. [Learn more](authentication.md).
@ -1081,14 +1091,14 @@ curl -X PUT http://coder-server:8080/api/v2/users/{user}/password \
### Parameters ### Parameters
| Name | In | Type | Required | Description | | Name | In | Type | Required | Description |
| ------ | ---- | ---------------------------------------------------------------------------------- | -------- | ----------------------- | |--------|------|------------------------------------------------------------------------------------|----------|-------------------------|
| `user` | path | string | true | User ID, name, or me | | `user` | path | string | true | User ID, name, or me |
| `body` | body | [codersdk.UpdateUserPasswordRequest](schemas.md#codersdkupdateuserpasswordrequest) | true | Update password request | | `body` | body | [codersdk.UpdateUserPasswordRequest](schemas.md#codersdkupdateuserpasswordrequest) | true | Update password request |
### Responses ### Responses
| Status | Meaning | Description | Schema | | Status | Meaning | Description | Schema |
| ------ | --------------------------------------------------------------- | ----------- | ------ | |--------|-----------------------------------------------------------------|-------------|--------|
| 204 | [No Content](https://tools.ietf.org/html/rfc7231#section-6.3.5) | No Content | | | 204 | [No Content](https://tools.ietf.org/html/rfc7231#section-6.3.5) | No Content | |
To perform this operation, you must be authenticated. [Learn more](authentication.md). To perform this operation, you must be authenticated. [Learn more](authentication.md).
@ -1119,7 +1129,7 @@ curl -X PUT http://coder-server:8080/api/v2/users/{user}/profile \
### Parameters ### Parameters
| Name | In | Type | Required | Description | | Name | In | Type | Required | Description |
| ------ | ---- | -------------------------------------------------------------------------------- | -------- | -------------------- | |--------|------|----------------------------------------------------------------------------------|----------|----------------------|
| `user` | path | string | true | User ID, name, or me | | `user` | path | string | true | User ID, name, or me |
| `body` | body | [codersdk.UpdateUserProfileRequest](schemas.md#codersdkupdateuserprofilerequest) | true | Updated profile | | `body` | body | [codersdk.UpdateUserProfileRequest](schemas.md#codersdkupdateuserprofilerequest) | true | Updated profile |
@ -1136,7 +1146,9 @@ curl -X PUT http://coder-server:8080/api/v2/users/{user}/profile \
"last_seen_at": "2019-08-24T14:15:22Z", "last_seen_at": "2019-08-24T14:15:22Z",
"login_type": "", "login_type": "",
"name": "string", "name": "string",
"organization_ids": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"], "organization_ids": [
"497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"roles": [ "roles": [
{ {
"display_name": "string", "display_name": "string",
@ -1154,7 +1166,7 @@ curl -X PUT http://coder-server:8080/api/v2/users/{user}/profile \
### Responses ### Responses
| Status | Meaning | Description | Schema | | Status | Meaning | Description | Schema |
| ------ | ------------------------------------------------------- | ----------- | ---------------------------------------- | |--------|---------------------------------------------------------|-------------|------------------------------------------|
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.User](schemas.md#codersdkuser) | | 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.User](schemas.md#codersdkuser) |
To perform this operation, you must be authenticated. [Learn more](authentication.md). To perform this operation, you must be authenticated. [Learn more](authentication.md).
@ -1175,7 +1187,7 @@ curl -X GET http://coder-server:8080/api/v2/users/{user}/roles \
### Parameters ### Parameters
| Name | In | Type | Required | Description | | Name | In | Type | Required | Description |
| ------ | ---- | ------ | -------- | -------------------- | |--------|------|--------|----------|----------------------|
| `user` | path | string | true | User ID, name, or me | | `user` | path | string | true | User ID, name, or me |
### Example responses ### Example responses
@ -1191,7 +1203,9 @@ curl -X GET http://coder-server:8080/api/v2/users/{user}/roles \
"last_seen_at": "2019-08-24T14:15:22Z", "last_seen_at": "2019-08-24T14:15:22Z",
"login_type": "", "login_type": "",
"name": "string", "name": "string",
"organization_ids": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"], "organization_ids": [
"497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"roles": [ "roles": [
{ {
"display_name": "string", "display_name": "string",
@ -1209,7 +1223,7 @@ curl -X GET http://coder-server:8080/api/v2/users/{user}/roles \
### Responses ### Responses
| Status | Meaning | Description | Schema | | Status | Meaning | Description | Schema |
| ------ | ------------------------------------------------------- | ----------- | ---------------------------------------- | |--------|---------------------------------------------------------|-------------|------------------------------------------|
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.User](schemas.md#codersdkuser) | | 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.User](schemas.md#codersdkuser) |
To perform this operation, you must be authenticated. [Learn more](authentication.md). To perform this operation, you must be authenticated. [Learn more](authentication.md).
@ -1232,14 +1246,16 @@ curl -X PUT http://coder-server:8080/api/v2/users/{user}/roles \
```json ```json
{ {
"roles": ["string"] "roles": [
"string"
]
} }
``` ```
### Parameters ### Parameters
| Name | In | Type | Required | Description | | Name | In | Type | Required | Description |
| ------ | ---- | ------------------------------------------------------ | -------- | -------------------- | |--------|------|--------------------------------------------------------|----------|----------------------|
| `user` | path | string | true | User ID, name, or me | | `user` | path | string | true | User ID, name, or me |
| `body` | body | [codersdk.UpdateRoles](schemas.md#codersdkupdateroles) | true | Update roles request | | `body` | body | [codersdk.UpdateRoles](schemas.md#codersdkupdateroles) | true | Update roles request |
@ -1256,7 +1272,9 @@ curl -X PUT http://coder-server:8080/api/v2/users/{user}/roles \
"last_seen_at": "2019-08-24T14:15:22Z", "last_seen_at": "2019-08-24T14:15:22Z",
"login_type": "", "login_type": "",
"name": "string", "name": "string",
"organization_ids": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"], "organization_ids": [
"497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"roles": [ "roles": [
{ {
"display_name": "string", "display_name": "string",
@ -1274,7 +1292,7 @@ curl -X PUT http://coder-server:8080/api/v2/users/{user}/roles \
### Responses ### Responses
| Status | Meaning | Description | Schema | | Status | Meaning | Description | Schema |
| ------ | ------------------------------------------------------- | ----------- | ---------------------------------------- | |--------|---------------------------------------------------------|-------------|------------------------------------------|
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.User](schemas.md#codersdkuser) | | 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.User](schemas.md#codersdkuser) |
To perform this operation, you must be authenticated. [Learn more](authentication.md). To perform this operation, you must be authenticated. [Learn more](authentication.md).
@ -1295,7 +1313,7 @@ curl -X PUT http://coder-server:8080/api/v2/users/{user}/status/activate \
### Parameters ### Parameters
| Name | In | Type | Required | Description | | Name | In | Type | Required | Description |
| ------ | ---- | ------ | -------- | -------------------- | |--------|------|--------|----------|----------------------|
| `user` | path | string | true | User ID, name, or me | | `user` | path | string | true | User ID, name, or me |
### Example responses ### Example responses
@ -1311,7 +1329,9 @@ curl -X PUT http://coder-server:8080/api/v2/users/{user}/status/activate \
"last_seen_at": "2019-08-24T14:15:22Z", "last_seen_at": "2019-08-24T14:15:22Z",
"login_type": "", "login_type": "",
"name": "string", "name": "string",
"organization_ids": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"], "organization_ids": [
"497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"roles": [ "roles": [
{ {
"display_name": "string", "display_name": "string",
@ -1329,7 +1349,7 @@ curl -X PUT http://coder-server:8080/api/v2/users/{user}/status/activate \
### Responses ### Responses
| Status | Meaning | Description | Schema | | Status | Meaning | Description | Schema |
| ------ | ------------------------------------------------------- | ----------- | ---------------------------------------- | |--------|---------------------------------------------------------|-------------|------------------------------------------|
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.User](schemas.md#codersdkuser) | | 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.User](schemas.md#codersdkuser) |
To perform this operation, you must be authenticated. [Learn more](authentication.md). To perform this operation, you must be authenticated. [Learn more](authentication.md).
@ -1350,7 +1370,7 @@ curl -X PUT http://coder-server:8080/api/v2/users/{user}/status/suspend \
### Parameters ### Parameters
| Name | In | Type | Required | Description | | Name | In | Type | Required | Description |
| ------ | ---- | ------ | -------- | -------------------- | |--------|------|--------|----------|----------------------|
| `user` | path | string | true | User ID, name, or me | | `user` | path | string | true | User ID, name, or me |
### Example responses ### Example responses
@ -1366,7 +1386,9 @@ curl -X PUT http://coder-server:8080/api/v2/users/{user}/status/suspend \
"last_seen_at": "2019-08-24T14:15:22Z", "last_seen_at": "2019-08-24T14:15:22Z",
"login_type": "", "login_type": "",
"name": "string", "name": "string",
"organization_ids": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"], "organization_ids": [
"497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"roles": [ "roles": [
{ {
"display_name": "string", "display_name": "string",
@ -1384,7 +1406,7 @@ curl -X PUT http://coder-server:8080/api/v2/users/{user}/status/suspend \
### Responses ### Responses
| Status | Meaning | Description | Schema | | Status | Meaning | Description | Schema |
| ------ | ------------------------------------------------------- | ----------- | ---------------------------------------- | |--------|---------------------------------------------------------|-------------|------------------------------------------|
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.User](schemas.md#codersdkuser) | | 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.User](schemas.md#codersdkuser) |
To perform this operation, you must be authenticated. [Learn more](authentication.md). To perform this operation, you must be authenticated. [Learn more](authentication.md).

2
docs/reference/api/workspaceproxies.md generated
View File

@ -36,7 +36,7 @@ curl -X GET http://coder-server:8080/api/v2/regions \
### Responses ### Responses
| Status | Meaning | Description | Schema | | Status | Meaning | Description | Schema |
| ------ | ------------------------------------------------------- | ----------- | ---------------------------------------------------------------------------------------------- | |--------|---------------------------------------------------------|-------------|------------------------------------------------------------------------------------------------|
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.RegionsResponse-codersdk_Region](schemas.md#codersdkregionsresponse-codersdk_region) | | 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.RegionsResponse-codersdk_Region](schemas.md#codersdkregionsresponse-codersdk_region) |
To perform this operation, you must be authenticated. [Learn more](authentication.md). To perform this operation, you must be authenticated. [Learn more](authentication.md).

148
docs/reference/api/workspaces.md generated
View File

@ -41,7 +41,7 @@ of the template will be used.
### Parameters ### Parameters
| Name | In | Type | Required | Description | | Name | In | Type | Required | Description |
| -------------- | ---- | ---------------------------------------------------------------------------- | -------- | ------------------------ | |----------------|------|------------------------------------------------------------------------------|----------|--------------------------|
| `organization` | path | string(uuid) | true | Organization ID | | `organization` | path | string(uuid) | true | Organization ID |
| `user` | path | string | true | Username, UUID, or me | | `user` | path | string | true | Username, UUID, or me |
| `body` | body | [codersdk.CreateWorkspaceRequest](schemas.md#codersdkcreateworkspacerequest) | true | Create workspace request | | `body` | body | [codersdk.CreateWorkspaceRequest](schemas.md#codersdkcreateworkspacerequest) | true | Create workspace request |
@ -60,7 +60,9 @@ of the template will be used.
"dormant_at": "2019-08-24T14:15:22Z", "dormant_at": "2019-08-24T14:15:22Z",
"favorite": true, "favorite": true,
"health": { "health": {
"failing_agents": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"], "failing_agents": [
"497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"healthy": false "healthy": false
}, },
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
@ -130,7 +132,9 @@ of the template will be used.
"created_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z",
"directory": "string", "directory": "string",
"disconnected_at": "2019-08-24T14:15:22Z", "disconnected_at": "2019-08-24T14:15:22Z",
"display_apps": ["vscode"], "display_apps": [
"vscode"
],
"environment_variables": { "environment_variables": {
"property1": "string", "property1": "string",
"property2": "string" "property2": "string"
@ -187,7 +191,9 @@ of the template will be used.
"started_at": "2019-08-24T14:15:22Z", "started_at": "2019-08-24T14:15:22Z",
"startup_script_behavior": "blocking", "startup_script_behavior": "blocking",
"status": "connecting", "status": "connecting",
"subsystems": ["envbox"], "subsystems": [
"envbox"
],
"troubleshooting_url": "string", "troubleshooting_url": "string",
"updated_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z",
"version": "string" "version": "string"
@ -245,7 +251,7 @@ of the template will be used.
### Responses ### Responses
| Status | Meaning | Description | Schema | | Status | Meaning | Description | Schema |
| ------ | ------------------------------------------------------- | ----------- | -------------------------------------------------- | |--------|---------------------------------------------------------|-------------|----------------------------------------------------|
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.Workspace](schemas.md#codersdkworkspace) | | 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.Workspace](schemas.md#codersdkworkspace) |
To perform this operation, you must be authenticated. [Learn more](authentication.md). To perform this operation, you must be authenticated. [Learn more](authentication.md).
@ -266,7 +272,7 @@ curl -X GET http://coder-server:8080/api/v2/users/{user}/workspace/{workspacenam
### Parameters ### Parameters
| Name | In | Type | Required | Description | | Name | In | Type | Required | Description |
| ----------------- | ----- | ------- | -------- | ----------------------------------------------------------- | |-------------------|-------|---------|----------|-------------------------------------------------------------|
| `user` | path | string | true | User ID, name, or me | | `user` | path | string | true | User ID, name, or me |
| `workspacename` | path | string | true | Workspace name | | `workspacename` | path | string | true | Workspace name |
| `include_deleted` | query | boolean | false | Return data instead of HTTP 404 if the workspace is deleted | | `include_deleted` | query | boolean | false | Return data instead of HTTP 404 if the workspace is deleted |
@ -285,7 +291,9 @@ curl -X GET http://coder-server:8080/api/v2/users/{user}/workspace/{workspacenam
"dormant_at": "2019-08-24T14:15:22Z", "dormant_at": "2019-08-24T14:15:22Z",
"favorite": true, "favorite": true,
"health": { "health": {
"failing_agents": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"], "failing_agents": [
"497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"healthy": false "healthy": false
}, },
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
@ -355,7 +363,9 @@ curl -X GET http://coder-server:8080/api/v2/users/{user}/workspace/{workspacenam
"created_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z",
"directory": "string", "directory": "string",
"disconnected_at": "2019-08-24T14:15:22Z", "disconnected_at": "2019-08-24T14:15:22Z",
"display_apps": ["vscode"], "display_apps": [
"vscode"
],
"environment_variables": { "environment_variables": {
"property1": "string", "property1": "string",
"property2": "string" "property2": "string"
@ -412,7 +422,9 @@ curl -X GET http://coder-server:8080/api/v2/users/{user}/workspace/{workspacenam
"started_at": "2019-08-24T14:15:22Z", "started_at": "2019-08-24T14:15:22Z",
"startup_script_behavior": "blocking", "startup_script_behavior": "blocking",
"status": "connecting", "status": "connecting",
"subsystems": ["envbox"], "subsystems": [
"envbox"
],
"troubleshooting_url": "string", "troubleshooting_url": "string",
"updated_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z",
"version": "string" "version": "string"
@ -470,7 +482,7 @@ curl -X GET http://coder-server:8080/api/v2/users/{user}/workspace/{workspacenam
### Responses ### Responses
| Status | Meaning | Description | Schema | | Status | Meaning | Description | Schema |
| ------ | ------------------------------------------------------- | ----------- | -------------------------------------------------- | |--------|---------------------------------------------------------|-------------|----------------------------------------------------|
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.Workspace](schemas.md#codersdkworkspace) | | 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.Workspace](schemas.md#codersdkworkspace) |
To perform this operation, you must be authenticated. [Learn more](authentication.md). To perform this operation, you must be authenticated. [Learn more](authentication.md).
@ -516,7 +528,7 @@ of the template will be used.
### Parameters ### Parameters
| Name | In | Type | Required | Description | | Name | In | Type | Required | Description |
| ------ | ---- | ---------------------------------------------------------------------------- | -------- | ------------------------ | |--------|------|------------------------------------------------------------------------------|----------|--------------------------|
| `user` | path | string | true | Username, UUID, or me | | `user` | path | string | true | Username, UUID, or me |
| `body` | body | [codersdk.CreateWorkspaceRequest](schemas.md#codersdkcreateworkspacerequest) | true | Create workspace request | | `body` | body | [codersdk.CreateWorkspaceRequest](schemas.md#codersdkcreateworkspacerequest) | true | Create workspace request |
@ -534,7 +546,9 @@ of the template will be used.
"dormant_at": "2019-08-24T14:15:22Z", "dormant_at": "2019-08-24T14:15:22Z",
"favorite": true, "favorite": true,
"health": { "health": {
"failing_agents": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"], "failing_agents": [
"497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"healthy": false "healthy": false
}, },
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
@ -604,7 +618,9 @@ of the template will be used.
"created_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z",
"directory": "string", "directory": "string",
"disconnected_at": "2019-08-24T14:15:22Z", "disconnected_at": "2019-08-24T14:15:22Z",
"display_apps": ["vscode"], "display_apps": [
"vscode"
],
"environment_variables": { "environment_variables": {
"property1": "string", "property1": "string",
"property2": "string" "property2": "string"
@ -661,7 +677,9 @@ of the template will be used.
"started_at": "2019-08-24T14:15:22Z", "started_at": "2019-08-24T14:15:22Z",
"startup_script_behavior": "blocking", "startup_script_behavior": "blocking",
"status": "connecting", "status": "connecting",
"subsystems": ["envbox"], "subsystems": [
"envbox"
],
"troubleshooting_url": "string", "troubleshooting_url": "string",
"updated_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z",
"version": "string" "version": "string"
@ -719,7 +737,7 @@ of the template will be used.
### Responses ### Responses
| Status | Meaning | Description | Schema | | Status | Meaning | Description | Schema |
| ------ | ------------------------------------------------------- | ----------- | -------------------------------------------------- | |--------|---------------------------------------------------------|-------------|----------------------------------------------------|
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.Workspace](schemas.md#codersdkworkspace) | | 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.Workspace](schemas.md#codersdkworkspace) |
To perform this operation, you must be authenticated. [Learn more](authentication.md). To perform this operation, you must be authenticated. [Learn more](authentication.md).
@ -740,7 +758,7 @@ curl -X GET http://coder-server:8080/api/v2/workspaces \
### Parameters ### Parameters
| Name | In | Type | Required | Description | | Name | In | Type | Required | Description |
| -------- | ----- | ------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | |----------|-------|---------|----------|---------------------------------------------------------------------------------------------------------------------------------------------------|
| `q` | query | string | false | Search query in the format `key:value`. Available keys are: owner, template, name, status, has-agent, dormant, last_used_after, last_used_before. | | `q` | query | string | false | Search query in the format `key:value`. Available keys are: owner, template, name, status, has-agent, dormant, last_used_after, last_used_before. |
| `limit` | query | integer | false | Page limit | | `limit` | query | integer | false | Page limit |
| `offset` | query | integer | false | Page offset | | `offset` | query | integer | false | Page offset |
@ -762,7 +780,9 @@ curl -X GET http://coder-server:8080/api/v2/workspaces \
"dormant_at": "2019-08-24T14:15:22Z", "dormant_at": "2019-08-24T14:15:22Z",
"favorite": true, "favorite": true,
"health": { "health": {
"failing_agents": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"], "failing_agents": [
"497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"healthy": false "healthy": false
}, },
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
@ -828,7 +848,9 @@ curl -X GET http://coder-server:8080/api/v2/workspaces \
"created_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z",
"directory": "string", "directory": "string",
"disconnected_at": "2019-08-24T14:15:22Z", "disconnected_at": "2019-08-24T14:15:22Z",
"display_apps": ["vscode"], "display_apps": [
"vscode"
],
"environment_variables": { "environment_variables": {
"property1": "string", "property1": "string",
"property2": "string" "property2": "string"
@ -885,7 +907,9 @@ curl -X GET http://coder-server:8080/api/v2/workspaces \
"started_at": "2019-08-24T14:15:22Z", "started_at": "2019-08-24T14:15:22Z",
"startup_script_behavior": "blocking", "startup_script_behavior": "blocking",
"status": "connecting", "status": "connecting",
"subsystems": ["envbox"], "subsystems": [
"envbox"
],
"troubleshooting_url": "string", "troubleshooting_url": "string",
"updated_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z",
"version": "string" "version": "string"
@ -945,7 +969,7 @@ curl -X GET http://coder-server:8080/api/v2/workspaces \
### Responses ### Responses
| Status | Meaning | Description | Schema | | Status | Meaning | Description | Schema |
| ------ | ------------------------------------------------------- | ----------- | -------------------------------------------------------------------- | |--------|---------------------------------------------------------|-------------|----------------------------------------------------------------------|
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.WorkspacesResponse](schemas.md#codersdkworkspacesresponse) | | 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.WorkspacesResponse](schemas.md#codersdkworkspacesresponse) |
To perform this operation, you must be authenticated. [Learn more](authentication.md). To perform this operation, you must be authenticated. [Learn more](authentication.md).
@ -966,7 +990,7 @@ curl -X GET http://coder-server:8080/api/v2/workspaces/{workspace} \
### Parameters ### Parameters
| Name | In | Type | Required | Description | | Name | In | Type | Required | Description |
| ----------------- | ----- | ------------ | -------- | ----------------------------------------------------------- | |-------------------|-------|--------------|----------|-------------------------------------------------------------|
| `workspace` | path | string(uuid) | true | Workspace ID | | `workspace` | path | string(uuid) | true | Workspace ID |
| `include_deleted` | query | boolean | false | Return data instead of HTTP 404 if the workspace is deleted | | `include_deleted` | query | boolean | false | Return data instead of HTTP 404 if the workspace is deleted |
@ -984,7 +1008,9 @@ curl -X GET http://coder-server:8080/api/v2/workspaces/{workspace} \
"dormant_at": "2019-08-24T14:15:22Z", "dormant_at": "2019-08-24T14:15:22Z",
"favorite": true, "favorite": true,
"health": { "health": {
"failing_agents": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"], "failing_agents": [
"497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"healthy": false "healthy": false
}, },
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
@ -1054,7 +1080,9 @@ curl -X GET http://coder-server:8080/api/v2/workspaces/{workspace} \
"created_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z",
"directory": "string", "directory": "string",
"disconnected_at": "2019-08-24T14:15:22Z", "disconnected_at": "2019-08-24T14:15:22Z",
"display_apps": ["vscode"], "display_apps": [
"vscode"
],
"environment_variables": { "environment_variables": {
"property1": "string", "property1": "string",
"property2": "string" "property2": "string"
@ -1111,7 +1139,9 @@ curl -X GET http://coder-server:8080/api/v2/workspaces/{workspace} \
"started_at": "2019-08-24T14:15:22Z", "started_at": "2019-08-24T14:15:22Z",
"startup_script_behavior": "blocking", "startup_script_behavior": "blocking",
"status": "connecting", "status": "connecting",
"subsystems": ["envbox"], "subsystems": [
"envbox"
],
"troubleshooting_url": "string", "troubleshooting_url": "string",
"updated_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z",
"version": "string" "version": "string"
@ -1169,7 +1199,7 @@ curl -X GET http://coder-server:8080/api/v2/workspaces/{workspace} \
### Responses ### Responses
| Status | Meaning | Description | Schema | | Status | Meaning | Description | Schema |
| ------ | ------------------------------------------------------- | ----------- | -------------------------------------------------- | |--------|---------------------------------------------------------|-------------|----------------------------------------------------|
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.Workspace](schemas.md#codersdkworkspace) | | 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.Workspace](schemas.md#codersdkworkspace) |
To perform this operation, you must be authenticated. [Learn more](authentication.md). To perform this operation, you must be authenticated. [Learn more](authentication.md).
@ -1198,14 +1228,14 @@ curl -X PATCH http://coder-server:8080/api/v2/workspaces/{workspace} \
### Parameters ### Parameters
| Name | In | Type | Required | Description | | Name | In | Type | Required | Description |
| ----------- | ---- | ---------------------------------------------------------------------------- | -------- | ----------------------- | |-------------|------|------------------------------------------------------------------------------|----------|-------------------------|
| `workspace` | path | string(uuid) | true | Workspace ID | | `workspace` | path | string(uuid) | true | Workspace ID |
| `body` | body | [codersdk.UpdateWorkspaceRequest](schemas.md#codersdkupdateworkspacerequest) | true | Metadata update request | | `body` | body | [codersdk.UpdateWorkspaceRequest](schemas.md#codersdkupdateworkspacerequest) | true | Metadata update request |
### Responses ### Responses
| Status | Meaning | Description | Schema | | Status | Meaning | Description | Schema |
| ------ | --------------------------------------------------------------- | ----------- | ------ | |--------|-----------------------------------------------------------------|-------------|--------|
| 204 | [No Content](https://tools.ietf.org/html/rfc7231#section-6.3.5) | No Content | | | 204 | [No Content](https://tools.ietf.org/html/rfc7231#section-6.3.5) | No Content | |
To perform this operation, you must be authenticated. [Learn more](authentication.md). To perform this operation, you must be authenticated. [Learn more](authentication.md).
@ -1234,14 +1264,14 @@ curl -X PUT http://coder-server:8080/api/v2/workspaces/{workspace}/autostart \
### Parameters ### Parameters
| Name | In | Type | Required | Description | | Name | In | Type | Required | Description |
| ----------- | ---- | ---------------------------------------------------------------------------------------------- | -------- | ----------------------- | |-------------|------|------------------------------------------------------------------------------------------------|----------|-------------------------|
| `workspace` | path | string(uuid) | true | Workspace ID | | `workspace` | path | string(uuid) | true | Workspace ID |
| `body` | body | [codersdk.UpdateWorkspaceAutostartRequest](schemas.md#codersdkupdateworkspaceautostartrequest) | true | Schedule update request | | `body` | body | [codersdk.UpdateWorkspaceAutostartRequest](schemas.md#codersdkupdateworkspaceautostartrequest) | true | Schedule update request |
### Responses ### Responses
| Status | Meaning | Description | Schema | | Status | Meaning | Description | Schema |
| ------ | --------------------------------------------------------------- | ----------- | ------ | |--------|-----------------------------------------------------------------|-------------|--------|
| 204 | [No Content](https://tools.ietf.org/html/rfc7231#section-6.3.5) | No Content | | | 204 | [No Content](https://tools.ietf.org/html/rfc7231#section-6.3.5) | No Content | |
To perform this operation, you must be authenticated. [Learn more](authentication.md). To perform this operation, you must be authenticated. [Learn more](authentication.md).
@ -1270,19 +1300,19 @@ curl -X PUT http://coder-server:8080/api/v2/workspaces/{workspace}/autoupdates \
### Parameters ### Parameters
| Name | In | Type | Required | Description | | Name | In | Type | Required | Description |
| ----------- | ---- | ------------------------------------------------------------------------------------------------------------ | -------- | ------------------------- | |-------------|------|--------------------------------------------------------------------------------------------------------------|----------|---------------------------|
| `workspace` | path | string(uuid) | true | Workspace ID | | `workspace` | path | string(uuid) | true | Workspace ID |
| `body` | body | [codersdk.UpdateWorkspaceAutomaticUpdatesRequest](schemas.md#codersdkupdateworkspaceautomaticupdatesrequest) | true | Automatic updates request | | `body` | body | [codersdk.UpdateWorkspaceAutomaticUpdatesRequest](schemas.md#codersdkupdateworkspaceautomaticupdatesrequest) | true | Automatic updates request |
### Responses ### Responses
| Status | Meaning | Description | Schema | | Status | Meaning | Description | Schema |
| ------ | --------------------------------------------------------------- | ----------- | ------ | |--------|-----------------------------------------------------------------|-------------|--------|
| 204 | [No Content](https://tools.ietf.org/html/rfc7231#section-6.3.5) | No Content | | | 204 | [No Content](https://tools.ietf.org/html/rfc7231#section-6.3.5) | No Content | |
To perform this operation, you must be authenticated. [Learn more](authentication.md). To perform this operation, you must be authenticated. [Learn more](authentication.md).
## Update workspace dormancy status by id. ## Update workspace dormancy status by id
### Code samples ### Code samples
@ -1307,7 +1337,7 @@ curl -X PUT http://coder-server:8080/api/v2/workspaces/{workspace}/dormant \
### Parameters ### Parameters
| Name | In | Type | Required | Description | | Name | In | Type | Required | Description |
| ----------- | ---- | ------------------------------------------------------------------------------ | -------- | ---------------------------------- | |-------------|------|--------------------------------------------------------------------------------|----------|------------------------------------|
| `workspace` | path | string(uuid) | true | Workspace ID | | `workspace` | path | string(uuid) | true | Workspace ID |
| `body` | body | [codersdk.UpdateWorkspaceDormancy](schemas.md#codersdkupdateworkspacedormancy) | true | Make a workspace dormant or active | | `body` | body | [codersdk.UpdateWorkspaceDormancy](schemas.md#codersdkupdateworkspacedormancy) | true | Make a workspace dormant or active |
@ -1325,7 +1355,9 @@ curl -X PUT http://coder-server:8080/api/v2/workspaces/{workspace}/dormant \
"dormant_at": "2019-08-24T14:15:22Z", "dormant_at": "2019-08-24T14:15:22Z",
"favorite": true, "favorite": true,
"health": { "health": {
"failing_agents": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"], "failing_agents": [
"497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"healthy": false "healthy": false
}, },
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
@ -1395,7 +1427,9 @@ curl -X PUT http://coder-server:8080/api/v2/workspaces/{workspace}/dormant \
"created_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z",
"directory": "string", "directory": "string",
"disconnected_at": "2019-08-24T14:15:22Z", "disconnected_at": "2019-08-24T14:15:22Z",
"display_apps": ["vscode"], "display_apps": [
"vscode"
],
"environment_variables": { "environment_variables": {
"property1": "string", "property1": "string",
"property2": "string" "property2": "string"
@ -1452,7 +1486,9 @@ curl -X PUT http://coder-server:8080/api/v2/workspaces/{workspace}/dormant \
"started_at": "2019-08-24T14:15:22Z", "started_at": "2019-08-24T14:15:22Z",
"startup_script_behavior": "blocking", "startup_script_behavior": "blocking",
"status": "connecting", "status": "connecting",
"subsystems": ["envbox"], "subsystems": [
"envbox"
],
"troubleshooting_url": "string", "troubleshooting_url": "string",
"updated_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z",
"version": "string" "version": "string"
@ -1510,7 +1546,7 @@ curl -X PUT http://coder-server:8080/api/v2/workspaces/{workspace}/dormant \
### Responses ### Responses
| Status | Meaning | Description | Schema | | Status | Meaning | Description | Schema |
| ------ | ------------------------------------------------------- | ----------- | -------------------------------------------------- | |--------|---------------------------------------------------------|-------------|----------------------------------------------------|
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.Workspace](schemas.md#codersdkworkspace) | | 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.Workspace](schemas.md#codersdkworkspace) |
To perform this operation, you must be authenticated. [Learn more](authentication.md). To perform this operation, you must be authenticated. [Learn more](authentication.md).
@ -1540,7 +1576,7 @@ curl -X PUT http://coder-server:8080/api/v2/workspaces/{workspace}/extend \
### Parameters ### Parameters
| Name | In | Type | Required | Description | | Name | In | Type | Required | Description |
| ----------- | ---- | ---------------------------------------------------------------------------------- | -------- | ------------------------------ | |-------------|------|------------------------------------------------------------------------------------|----------|--------------------------------|
| `workspace` | path | string(uuid) | true | Workspace ID | | `workspace` | path | string(uuid) | true | Workspace ID |
| `body` | body | [codersdk.PutExtendWorkspaceRequest](schemas.md#codersdkputextendworkspacerequest) | true | Extend deadline update request | | `body` | body | [codersdk.PutExtendWorkspaceRequest](schemas.md#codersdkputextendworkspacerequest) | true | Extend deadline update request |
@ -1564,12 +1600,12 @@ curl -X PUT http://coder-server:8080/api/v2/workspaces/{workspace}/extend \
### Responses ### Responses
| Status | Meaning | Description | Schema | | Status | Meaning | Description | Schema |
| ------ | ------------------------------------------------------- | ----------- | ------------------------------------------------ | |--------|---------------------------------------------------------|-------------|--------------------------------------------------|
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.Response](schemas.md#codersdkresponse) | | 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.Response](schemas.md#codersdkresponse) |
To perform this operation, you must be authenticated. [Learn more](authentication.md). To perform this operation, you must be authenticated. [Learn more](authentication.md).
## Favorite workspace by ID. ## Favorite workspace by ID
### Code samples ### Code samples
@ -1584,18 +1620,18 @@ curl -X PUT http://coder-server:8080/api/v2/workspaces/{workspace}/favorite \
### Parameters ### Parameters
| Name | In | Type | Required | Description | | Name | In | Type | Required | Description |
| ----------- | ---- | ------------ | -------- | ------------ | |-------------|------|--------------|----------|--------------|
| `workspace` | path | string(uuid) | true | Workspace ID | | `workspace` | path | string(uuid) | true | Workspace ID |
### Responses ### Responses
| Status | Meaning | Description | Schema | | Status | Meaning | Description | Schema |
| ------ | --------------------------------------------------------------- | ----------- | ------ | |--------|-----------------------------------------------------------------|-------------|--------|
| 204 | [No Content](https://tools.ietf.org/html/rfc7231#section-6.3.5) | No Content | | | 204 | [No Content](https://tools.ietf.org/html/rfc7231#section-6.3.5) | No Content | |
To perform this operation, you must be authenticated. [Learn more](authentication.md). To perform this operation, you must be authenticated. [Learn more](authentication.md).
## Unfavorite workspace by ID. ## Unfavorite workspace by ID
### Code samples ### Code samples
@ -1610,18 +1646,18 @@ curl -X DELETE http://coder-server:8080/api/v2/workspaces/{workspace}/favorite \
### Parameters ### Parameters
| Name | In | Type | Required | Description | | Name | In | Type | Required | Description |
| ----------- | ---- | ------------ | -------- | ------------ | |-------------|------|--------------|----------|--------------|
| `workspace` | path | string(uuid) | true | Workspace ID | | `workspace` | path | string(uuid) | true | Workspace ID |
### Responses ### Responses
| Status | Meaning | Description | Schema | | Status | Meaning | Description | Schema |
| ------ | --------------------------------------------------------------- | ----------- | ------ | |--------|-----------------------------------------------------------------|-------------|--------|
| 204 | [No Content](https://tools.ietf.org/html/rfc7231#section-6.3.5) | No Content | | | 204 | [No Content](https://tools.ietf.org/html/rfc7231#section-6.3.5) | No Content | |
To perform this operation, you must be authenticated. [Learn more](authentication.md). To perform this operation, you must be authenticated. [Learn more](authentication.md).
## Resolve workspace autostart by id. ## Resolve workspace autostart by id
### Code samples ### Code samples
@ -1637,7 +1673,7 @@ curl -X GET http://coder-server:8080/api/v2/workspaces/{workspace}/resolve-autos
### Parameters ### Parameters
| Name | In | Type | Required | Description | | Name | In | Type | Required | Description |
| ----------- | ---- | ------------ | -------- | ------------ | |-------------|------|--------------|----------|--------------|
| `workspace` | path | string(uuid) | true | Workspace ID | | `workspace` | path | string(uuid) | true | Workspace ID |
### Example responses ### Example responses
@ -1653,7 +1689,7 @@ curl -X GET http://coder-server:8080/api/v2/workspaces/{workspace}/resolve-autos
### Responses ### Responses
| Status | Meaning | Description | Schema | | Status | Meaning | Description | Schema |
| ------ | ------------------------------------------------------- | ----------- | -------------------------------------------------------------------------------- | |--------|---------------------------------------------------------|-------------|----------------------------------------------------------------------------------|
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.ResolveAutostartResponse](schemas.md#codersdkresolveautostartresponse) | | 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.ResolveAutostartResponse](schemas.md#codersdkresolveautostartresponse) |
To perform this operation, you must be authenticated. [Learn more](authentication.md). To perform this operation, you must be authenticated. [Learn more](authentication.md).
@ -1674,7 +1710,7 @@ curl -X GET http://coder-server:8080/api/v2/workspaces/{workspace}/timings \
### Parameters ### Parameters
| Name | In | Type | Required | Description | | Name | In | Type | Required | Description |
| ----------- | ---- | ------------ | -------- | ------------ | |-------------|------|--------------|----------|--------------|
| `workspace` | path | string(uuid) | true | Workspace ID | | `workspace` | path | string(uuid) | true | Workspace ID |
### Example responses ### Example responses
@ -1721,7 +1757,7 @@ curl -X GET http://coder-server:8080/api/v2/workspaces/{workspace}/timings \
### Responses ### Responses
| Status | Meaning | Description | Schema | | Status | Meaning | Description | Schema |
| ------ | ------------------------------------------------------- | ----------- | -------------------------------------------------------------------------- | |--------|---------------------------------------------------------|-------------|----------------------------------------------------------------------------|
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.WorkspaceBuildTimings](schemas.md#codersdkworkspacebuildtimings) | | 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.WorkspaceBuildTimings](schemas.md#codersdkworkspacebuildtimings) |
To perform this operation, you must be authenticated. [Learn more](authentication.md). To perform this operation, you must be authenticated. [Learn more](authentication.md).
@ -1750,14 +1786,14 @@ curl -X PUT http://coder-server:8080/api/v2/workspaces/{workspace}/ttl \
### Parameters ### Parameters
| Name | In | Type | Required | Description | | Name | In | Type | Required | Description |
| ----------- | ---- | ---------------------------------------------------------------------------------- | -------- | ---------------------------- | |-------------|------|------------------------------------------------------------------------------------|----------|------------------------------|
| `workspace` | path | string(uuid) | true | Workspace ID | | `workspace` | path | string(uuid) | true | Workspace ID |
| `body` | body | [codersdk.UpdateWorkspaceTTLRequest](schemas.md#codersdkupdateworkspacettlrequest) | true | Workspace TTL update request | | `body` | body | [codersdk.UpdateWorkspaceTTLRequest](schemas.md#codersdkupdateworkspacettlrequest) | true | Workspace TTL update request |
### Responses ### Responses
| Status | Meaning | Description | Schema | | Status | Meaning | Description | Schema |
| ------ | --------------------------------------------------------------- | ----------- | ------ | |--------|-----------------------------------------------------------------|-------------|--------|
| 204 | [No Content](https://tools.ietf.org/html/rfc7231#section-6.3.5) | No Content | | | 204 | [No Content](https://tools.ietf.org/html/rfc7231#section-6.3.5) | No Content | |
To perform this operation, you must be authenticated. [Learn more](authentication.md). To perform this operation, you must be authenticated. [Learn more](authentication.md).
@ -1787,14 +1823,14 @@ curl -X POST http://coder-server:8080/api/v2/workspaces/{workspace}/usage \
### Parameters ### Parameters
| Name | In | Type | Required | Description | | Name | In | Type | Required | Description |
| ----------- | ---- | ---------------------------------------------------------------------------------- | -------- | ---------------------------- | |-------------|------|------------------------------------------------------------------------------------|----------|------------------------------|
| `workspace` | path | string(uuid) | true | Workspace ID | | `workspace` | path | string(uuid) | true | Workspace ID |
| `body` | body | [codersdk.PostWorkspaceUsageRequest](schemas.md#codersdkpostworkspaceusagerequest) | false | Post workspace usage request | | `body` | body | [codersdk.PostWorkspaceUsageRequest](schemas.md#codersdkpostworkspaceusagerequest) | false | Post workspace usage request |
### Responses ### Responses
| Status | Meaning | Description | Schema | | Status | Meaning | Description | Schema |
| ------ | --------------------------------------------------------------- | ----------- | ------ | |--------|-----------------------------------------------------------------|-------------|--------|
| 204 | [No Content](https://tools.ietf.org/html/rfc7231#section-6.3.5) | No Content | | | 204 | [No Content](https://tools.ietf.org/html/rfc7231#section-6.3.5) | No Content | |
To perform this operation, you must be authenticated. [Learn more](authentication.md). To perform this operation, you must be authenticated. [Learn more](authentication.md).
@ -1815,7 +1851,7 @@ curl -X GET http://coder-server:8080/api/v2/workspaces/{workspace}/watch \
### Parameters ### Parameters
| Name | In | Type | Required | Description | | Name | In | Type | Required | Description |
| ----------- | ---- | ------------ | -------- | ------------ | |-------------|------|--------------|----------|--------------|
| `workspace` | path | string(uuid) | true | Workspace ID | | `workspace` | path | string(uuid) | true | Workspace ID |
### Example responses ### Example responses
@ -1825,7 +1861,7 @@ curl -X GET http://coder-server:8080/api/v2/workspaces/{workspace}/watch \
### Responses ### Responses
| Status | Meaning | Description | Schema | | Status | Meaning | Description | Schema |
| ------ | ------------------------------------------------------- | ----------- | ------------------------------------------------ | |--------|---------------------------------------------------------|-------------|--------------------------------------------------|
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.Response](schemas.md#codersdkresponse) | | 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.Response](schemas.md#codersdkresponse) |
To perform this operation, you must be authenticated. [Learn more](authentication.md). To perform this operation, you must be authenticated. [Learn more](authentication.md).

3
docs/reference/cli/autoupdate.md generated
View File

@ -1,5 +1,4 @@
<!-- DO NOT EDIT | GENERATED CONTENT --> <!-- DO NOT EDIT | GENERATED CONTENT -->
# autoupdate # autoupdate
Toggle auto-update policy for a workspace Toggle auto-update policy for a workspace
@ -15,7 +14,7 @@ coder autoupdate [flags] <workspace> <always|never>
### -y, --yes ### -y, --yes
| | | | | |
| ---- | ----------------- | |------|-------------------|
| Type | <code>bool</code> | | Type | <code>bool</code> |
Bypass prompts. Bypass prompts.

5
docs/reference/cli/completion.md generated
View File

@ -1,5 +1,4 @@
<!-- DO NOT EDIT | GENERATED CONTENT --> <!-- DO NOT EDIT | GENERATED CONTENT -->
# completion # completion
Install or update shell completion scripts for the detected or chosen shell. Install or update shell completion scripts for the detected or chosen shell.
@ -15,7 +14,7 @@ coder completion [flags]
### -s, --shell ### -s, --shell
| | | | | |
| ---- | ---------------------------------------- | |------|------------------------------------------|
| Type | <code>bash\|fish\|zsh\|powershell</code> | | Type | <code>bash\|fish\|zsh\|powershell</code> |
The shell to install completion for. The shell to install completion for.
@ -23,7 +22,7 @@ The shell to install completion for.
### -p, --print ### -p, --print
| | | | | |
| ---- | ----------------- | |------|-------------------|
| Type | <code>bool</code> | | Type | <code>bool</code> |
Print the completion script instead of installing it. Print the completion script instead of installing it.

19
docs/reference/cli/config-ssh.md generated
View File

@ -1,5 +1,4 @@
<!-- DO NOT EDIT | GENERATED CONTENT --> <!-- DO NOT EDIT | GENERATED CONTENT -->
# config-ssh # config-ssh
Add an SSH Host entry for your workspaces "ssh coder.workspace" Add an SSH Host entry for your workspaces "ssh coder.workspace"
@ -28,7 +27,7 @@ workspaces:
### --ssh-config-file ### --ssh-config-file
| | | | | |
| ----------- | ----------------------------------- | |-------------|-------------------------------------|
| Type | <code>string</code> | | Type | <code>string</code> |
| Environment | <code>$CODER_SSH_CONFIG_FILE</code> | | Environment | <code>$CODER_SSH_CONFIG_FILE</code> |
| Default | <code>~/.ssh/config</code> | | Default | <code>~/.ssh/config</code> |
@ -38,7 +37,7 @@ Specifies the path to an SSH config.
### --coder-binary-path ### --coder-binary-path
| | | | | |
| ----------- | ------------------------------------------ | |-------------|--------------------------------------------|
| Type | <code>string</code> | | Type | <code>string</code> |
| Environment | <code>$CODER_SSH_CONFIG_BINARY_PATH</code> | | Environment | <code>$CODER_SSH_CONFIG_BINARY_PATH</code> |
@ -47,7 +46,7 @@ Optionally specify the absolute path to the coder binary used in ProxyCommand. B
### -o, --ssh-option ### -o, --ssh-option
| | | | | |
| ----------- | ----------------------------------- | |-------------|-------------------------------------|
| Type | <code>string-array</code> | | Type | <code>string-array</code> |
| Environment | <code>$CODER_SSH_CONFIG_OPTS</code> | | Environment | <code>$CODER_SSH_CONFIG_OPTS</code> |
@ -56,7 +55,7 @@ Specifies additional SSH options to embed in each host stanza.
### -n, --dry-run ### -n, --dry-run
| | | | | |
| ----------- | ------------------------------- | |-------------|---------------------------------|
| Type | <code>bool</code> | | Type | <code>bool</code> |
| Environment | <code>$CODER_SSH_DRY_RUN</code> | | Environment | <code>$CODER_SSH_DRY_RUN</code> |
@ -65,7 +64,7 @@ Perform a trial run with no changes made, showing a diff at the end.
### --use-previous-options ### --use-previous-options
| | | | | |
| ----------- | -------------------------------------------- | |-------------|----------------------------------------------|
| Type | <code>bool</code> | | Type | <code>bool</code> |
| Environment | <code>$CODER_SSH_USE_PREVIOUS_OPTIONS</code> | | Environment | <code>$CODER_SSH_USE_PREVIOUS_OPTIONS</code> |
@ -74,7 +73,7 @@ Specifies whether or not to keep options from previous run of config-ssh.
### --ssh-host-prefix ### --ssh-host-prefix
| | | | | |
| ----------- | --------------------------------------------- | |-------------|-----------------------------------------------|
| Type | <code>string</code> | | Type | <code>string</code> |
| Environment | <code>$CODER_CONFIGSSH_SSH_HOST_PREFIX</code> | | Environment | <code>$CODER_CONFIGSSH_SSH_HOST_PREFIX</code> |
@ -83,7 +82,7 @@ Override the default host prefix.
### --wait ### --wait
| | | | | |
| ----------- | ---------------------------------- | |-------------|------------------------------------|
| Type | <code>yes\|no\|auto</code> | | Type | <code>yes\|no\|auto</code> |
| Environment | <code>$CODER_CONFIGSSH_WAIT</code> | | Environment | <code>$CODER_CONFIGSSH_WAIT</code> |
| Default | <code>auto</code> | | Default | <code>auto</code> |
@ -93,7 +92,7 @@ Specifies whether or not to wait for the startup script to finish executing. Aut
### --disable-autostart ### --disable-autostart
| | | | | |
| ----------- | ----------------------------------------------- | |-------------|-------------------------------------------------|
| Type | <code>bool</code> | | Type | <code>bool</code> |
| Environment | <code>$CODER_CONFIGSSH_DISABLE_AUTOSTART</code> | | Environment | <code>$CODER_CONFIGSSH_DISABLE_AUTOSTART</code> |
| Default | <code>false</code> | | Default | <code>false</code> |
@ -103,7 +102,7 @@ Disable starting the workspace automatically when connecting via SSH.
### -y, --yes ### -y, --yes
| | | | | |
| ---- | ----------------- | |------|-------------------|
| Type | <code>bool</code> | | Type | <code>bool</code> |
Bypass prompts. Bypass prompts.

23
docs/reference/cli/create.md generated
View File

@ -1,5 +1,4 @@
<!-- DO NOT EDIT | GENERATED CONTENT --> <!-- DO NOT EDIT | GENERATED CONTENT -->
# create # create
Create a workspace Create a workspace
@ -23,7 +22,7 @@ coder create [flags] [workspace]
### -t, --template ### -t, --template
| | | | | |
| ----------- | --------------------------------- | |-------------|-----------------------------------|
| Type | <code>string</code> | | Type | <code>string</code> |
| Environment | <code>$CODER_TEMPLATE_NAME</code> | | Environment | <code>$CODER_TEMPLATE_NAME</code> |
@ -32,7 +31,7 @@ Specify a template name.
### --template-version ### --template-version
| | | | | |
| ----------- | ------------------------------------ | |-------------|--------------------------------------|
| Type | <code>string</code> | | Type | <code>string</code> |
| Environment | <code>$CODER_TEMPLATE_VERSION</code> | | Environment | <code>$CODER_TEMPLATE_VERSION</code> |
@ -41,7 +40,7 @@ Specify a template version name.
### --start-at ### --start-at
| | | | | |
| ----------- | -------------------------------------- | |-------------|----------------------------------------|
| Type | <code>string</code> | | Type | <code>string</code> |
| Environment | <code>$CODER_WORKSPACE_START_AT</code> | | Environment | <code>$CODER_WORKSPACE_START_AT</code> |
@ -50,7 +49,7 @@ Specify the workspace autostart schedule. Check coder schedule start --help for
### --stop-after ### --stop-after
| | | | | |
| ----------- | ---------------------------------------- | |-------------|------------------------------------------|
| Type | <code>duration</code> | | Type | <code>duration</code> |
| Environment | <code>$CODER_WORKSPACE_STOP_AFTER</code> | | Environment | <code>$CODER_WORKSPACE_STOP_AFTER</code> |
@ -59,7 +58,7 @@ Specify a duration after which the workspace should shut down (e.g. 8h).
### --automatic-updates ### --automatic-updates
| | | | | |
| ----------- | ----------------------------------------------- | |-------------|-------------------------------------------------|
| Type | <code>string</code> | | Type | <code>string</code> |
| Environment | <code>$CODER_WORKSPACE_AUTOMATIC_UPDATES</code> | | Environment | <code>$CODER_WORKSPACE_AUTOMATIC_UPDATES</code> |
| Default | <code>never</code> | | Default | <code>never</code> |
@ -69,7 +68,7 @@ Specify automatic updates setting for the workspace (accepts 'always' or 'never'
### --copy-parameters-from ### --copy-parameters-from
| | | | | |
| ----------- | -------------------------------------------------- | |-------------|----------------------------------------------------|
| Type | <code>string</code> | | Type | <code>string</code> |
| Environment | <code>$CODER_WORKSPACE_COPY_PARAMETERS_FROM</code> | | Environment | <code>$CODER_WORKSPACE_COPY_PARAMETERS_FROM</code> |
@ -78,7 +77,7 @@ Specify the source workspace name to copy parameters from.
### -y, --yes ### -y, --yes
| | | | | |
| ---- | ----------------- | |------|-------------------|
| Type | <code>bool</code> | | Type | <code>bool</code> |
Bypass prompts. Bypass prompts.
@ -86,7 +85,7 @@ Bypass prompts.
### --parameter ### --parameter
| | | | | |
| ----------- | ---------------------------------- | |-------------|------------------------------------|
| Type | <code>string-array</code> | | Type | <code>string-array</code> |
| Environment | <code>$CODER_RICH_PARAMETER</code> | | Environment | <code>$CODER_RICH_PARAMETER</code> |
@ -95,7 +94,7 @@ Rich parameter value in the format "name=value".
### --rich-parameter-file ### --rich-parameter-file
| | | | | |
| ----------- | --------------------------------------- | |-------------|-----------------------------------------|
| Type | <code>string</code> | | Type | <code>string</code> |
| Environment | <code>$CODER_RICH_PARAMETER_FILE</code> | | Environment | <code>$CODER_RICH_PARAMETER_FILE</code> |
@ -104,7 +103,7 @@ Specify a file path with values for rich parameters defined in the template. The
### --parameter-default ### --parameter-default
| | | | | |
| ----------- | ------------------------------------------ | |-------------|--------------------------------------------|
| Type | <code>string-array</code> | | Type | <code>string-array</code> |
| Environment | <code>$CODER_RICH_PARAMETER_DEFAULT</code> | | Environment | <code>$CODER_RICH_PARAMETER_DEFAULT</code> |
@ -113,7 +112,7 @@ Rich parameter default values in the format "name=value".
### -O, --org ### -O, --org
| | | | | |
| ----------- | -------------------------------- | |-------------|----------------------------------|
| Type | <code>string</code> | | Type | <code>string</code> |
| Environment | <code>$CODER_ORGANIZATION</code> | | Environment | <code>$CODER_ORGANIZATION</code> |

7
docs/reference/cli/delete.md generated
View File

@ -1,12 +1,11 @@
<!-- DO NOT EDIT | GENERATED CONTENT --> <!-- DO NOT EDIT | GENERATED CONTENT -->
# delete # delete
Delete a workspace Delete a workspace
Aliases: Aliases:
- rm * rm
## Usage ## Usage
@ -27,7 +26,7 @@ coder delete [flags] <workspace>
### --orphan ### --orphan
| | | | | |
| ---- | ----------------- | |------|-------------------|
| Type | <code>bool</code> | | Type | <code>bool</code> |
Delete a workspace without deleting its resources. This can delete a workspace in a broken state, but may also lead to unaccounted cloud resources. Delete a workspace without deleting its resources. This can delete a workspace in a broken state, but may also lead to unaccounted cloud resources.
@ -35,7 +34,7 @@ Delete a workspace without deleting its resources. This can delete a workspace i
### -y, --yes ### -y, --yes
| | | | | |
| ---- | ----------------- | |------|-------------------|
| Type | <code>bool</code> | | Type | <code>bool</code> |
Bypass prompts. Bypass prompts.

9
docs/reference/cli/dotfiles.md generated
View File

@ -1,5 +1,4 @@
<!-- DO NOT EDIT | GENERATED CONTENT --> <!-- DO NOT EDIT | GENERATED CONTENT -->
# dotfiles # dotfiles
Personalize your workspace by applying a canonical dotfiles repository Personalize your workspace by applying a canonical dotfiles repository
@ -23,7 +22,7 @@ coder dotfiles [flags] <git_repo_url>
### --symlink-dir ### --symlink-dir
| | | | | |
| ----------- | ------------------------------- | |-------------|---------------------------------|
| Type | <code>string</code> | | Type | <code>string</code> |
| Environment | <code>$CODER_SYMLINK_DIR</code> | | Environment | <code>$CODER_SYMLINK_DIR</code> |
@ -32,7 +31,7 @@ Specifies the directory for the dotfiles symlink destinations. If empty, will us
### -b, --branch ### -b, --branch
| | | | | |
| ---- | ------------------- | |------|---------------------|
| Type | <code>string</code> | | Type | <code>string</code> |
Specifies which branch to clone. If empty, will default to cloning the default branch or using the existing branch in the cloned repo on disk. Specifies which branch to clone. If empty, will default to cloning the default branch or using the existing branch in the cloned repo on disk.
@ -40,7 +39,7 @@ Specifies which branch to clone. If empty, will default to cloning the default b
### --repo-dir ### --repo-dir
| | | | | |
| ----------- | ------------------------------------- | |-------------|---------------------------------------|
| Type | <code>string</code> | | Type | <code>string</code> |
| Environment | <code>$CODER_DOTFILES_REPO_DIR</code> | | Environment | <code>$CODER_DOTFILES_REPO_DIR</code> |
| Default | <code>dotfiles</code> | | Default | <code>dotfiles</code> |
@ -50,7 +49,7 @@ Specifies the directory for the dotfiles repository, relative to global config d
### -y, --yes ### -y, --yes
| | | | | |
| ---- | ----------------- | |------|-------------------|
| Type | <code>bool</code> | | Type | <code>bool</code> |
Bypass prompts. Bypass prompts.

3
docs/reference/cli/external-auth.md generated
View File

@ -1,5 +1,4 @@
<!-- DO NOT EDIT | GENERATED CONTENT --> <!-- DO NOT EDIT | GENERATED CONTENT -->
# external-auth # external-auth
Manage external authentication Manage external authentication
@ -19,5 +18,5 @@ Authenticate with external services inside of a workspace.
## Subcommands ## Subcommands
| Name | Purpose | | Name | Purpose |
| ------------------------------------------------------------ | ----------------------------------- | |--------------------------------------------------------------|-------------------------------------|
| [<code>access-token</code>](./external-auth_access-token.md) | Print auth for an external provider | | [<code>access-token</code>](./external-auth_access-token.md) | Print auth for an external provider |

Some files were not shown because too many files have changed in this diff Show More