opensource/coder
3
0
Fork 0
mirror of https://github.com/coder/coder.git synced 2026-09-24 15:04:27 +08:00
Code Issues Packages Projects Releases Wiki Activity

docs: normalize code-fence languages for Shiki compatibility (#27161)

Browse Source 
Normalizes non-standard code-fence language tags across `docs/**` so a
strict highlighter (Shiki, used by Fumadocs) won't fail the build on an
unrecognized language, and unifies redundant synonym tags onto one
canonical form per language. The current renderer (Speed-Highlight)
detects the language from the code content, not the fence label, so this
drift wasn't visible until now.

## Changes

- `hcl` -> `tf` (199 fences, including indented ones nested in
numbered/bulleted lists). Shiki ships `hcl` and `terraform` as two
distinct grammars (not aliases); every `hcl`-tagged fence in `docs/**`
is actually Terraform resource/data/provider syntax, so the more
specific `terraform` grammar is correct for all of them. `tf` is Shiki's
own alias for that grammar, and it's also what GitHub's own markdown
renderer resolves to the same HCL/Terraform highlighting.
- `pwsh`/`powershell` -> `ps1`. Both `ps` and `ps1` are registered
PowerShell aliases in Shiki, but on GitHub's renderer only `.ps1` is a
registered file extension (`.ps` isn't), so `ps1` renders identically to
`powershell` there today while bare `ps` would silently lose
highlighting.
- `env` -> `dotenv` (a dedicated Shiki grammar for `KEY=VALUE` files)
- `text`/`output`/`none`/`url` -> `txt`. Same built-in plain-text
fallback either way, just shorter.
- `Dockerfile` -> `dockerfile` (lowercase)
- `bash`/`shell` -> `sh` (732 fences). Shiki and GitHub both alias all
three to a single shell grammar; this was already the style guide's
stated preference, just not enforced across the existing corpus until
now.
- `markdown` -> `md` (4 fences). Alias of the same grammar in both Shiki
and GitHub.
- `jsonc` -> `json` (1 fence). The block has no comments or trailing
commas, so it doesn't need the comments-capable grammar.
- `ts` -> `tsx` (2 fences, `docs/about/contributing/frontend.md`).
Verified the actual content tokenizes identically under both grammars,
and a sibling block in the same file already needs `tsx` for real JSX,
so unifying to one tag is safe for this file. Documented a caveat: `tsx`
mis-tokenizes the legacy angle-bracket type-assertion syntax
(`<Type>value`), which is invalid in real `.tsx` files anyway, so use
`value as Type` instead.
- `yml` -> `yaml` (1 fence)
- Updated `docs/.style/style-guide/formatting.md` to document all
canonical tags

`promql` (2 fences) and `caddyfile` (2 fences) are left as-is. Shiki
doesn't bundle a grammar for either, so they need a custom grammar
registration when the site adopts Shiki, rather than degrading to `txt`.
Tracked as follow-up work under DOCS-118 and
[DOCS-544](https://linear.app/codercom/issue/DOCS-544/vendor-a-local-promql-grammar-for-shiki-syntax-highlighting)
(promql).

Does not touch `offlinedocs/`.

Linear:
[DOCS-476](https://linear.app/codercom/issue/DOCS-476/normalize-docs-code-fence-languages-de-risk-shikifumadocs)

<details>
<summary>How the fence tags were verified</summary>

Each tag was tested against a real `shiki@latest` highlighter instance
(`codeToHtml`/`codeToTokens`) and cross-checked against GitHub's
`@wooorm/starry-night` grammar sources (the renderer that actually
displays these `.md` files today, in repo browsing and PR diffs), since
that's what determines whether brevity is safe before Shiki adoption:

```text
FAIL  env        -- Language `env` is not included in this bundle.
FAIL  Dockerfile -- Language `Dockerfile` is not included in this bundle.
FAIL  promql     -- Language `promql` is not included in this bundle.
FAIL  caddyfile  -- Language `caddyfile` is not included in this bundle.
FAIL  pwsh       -- Language `pwsh` is not included in this bundle.
FAIL  output     -- Language `output` is not included in this bundle.
```

`hcl` doesn't error in Shiki, since it's a real grammar, but that's
exactly the trap: it was silently rendering every fence with the generic
HCL grammar instead of the Terraform-specific one. Every `hcl`-tagged
fence in `docs/**` was manually checked against `origin/main` and is
genuinely Terraform content.

For `ts`/`tsx`, tokenizing the actual doc content confirmed identical
output under both grammars; a synthetic test with the legacy
angle-bracket cast syntax confirmed `tsx` degrades on that specific
construct, which the style guide now calls out.

The first normalization pass only matched fence tags at column 0
(`^```tag$`), missing tags indented inside numbered/bulleted lists. A
follow-up pass caught the remaining occurrences at any indentation
level.

</details>


---

*This PR description and the underlying changes were prepared with Coder
Agents assistance.*
This commit is contained in:
Nick Vigilante
2026-07-15 14:07:09 -04:00
committed by GitHub
parent d0982e3cc7
commit c84aa564ba
181 changed files with 997 additions and 980 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/reference/api/agents.md
Generated
+23 -23
View File
@@ -6,7 +6,7 @@ Workspace agent endpoints. These power the workspace agent daemon defined by the
### Code samples
```shell
```sh
# Example request using curl
curl -X GET http://coder-server:8080/api/v2/derp-map \
-H 'Coder-Session-Token: API_KEY'
@@ -26,7 +26,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X GET http://coder-server:8080/api/v2/tailnet \
-H 'Coder-Session-Token: API_KEY'
@@ -46,7 +46,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X POST http://coder-server:8080/api/v2/workspaceagents/aws-instance-identity \
-H 'Content-Type: application/json' \
@@ -94,7 +94,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X POST http://coder-server:8080/api/v2/workspaceagents/azure-instance-identity \
-H 'Content-Type: application/json' \
@@ -142,7 +142,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X POST http://coder-server:8080/api/v2/workspaceagents/google-instance-identity \
-H 'Content-Type: application/json' \
@@ -189,7 +189,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X PATCH http://coder-server:8080/api/v2/workspaceagents/me/app-status \
-H 'Content-Type: application/json' \
@@ -247,7 +247,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X GET http://coder-server:8080/api/v2/workspaceagents/me/external-auth?match=string&id=string \
-H 'Accept: application/json' \
@@ -292,7 +292,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X GET http://coder-server:8080/api/v2/workspaceagents/me/gitauth?match=string&id=string \
-H 'Accept: application/json' \
@@ -337,7 +337,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X GET http://coder-server:8080/api/v2/workspaceagents/me/gitsshkey \
-H 'Accept: application/json' \
@@ -369,7 +369,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X POST http://coder-server:8080/api/v2/workspaceagents/me/log-source \
-H 'Content-Type: application/json' \
@@ -421,7 +421,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X PATCH http://coder-server:8080/api/v2/workspaceagents/me/logs \
-H 'Content-Type: application/json' \
@@ -481,7 +481,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X GET http://coder-server:8080/api/v2/workspaceagents/me/reinit \
-H 'Accept: application/json' \
@@ -521,7 +521,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X GET http://coder-server:8080/api/v2/workspaceagents/{workspaceagent} \
-H 'Accept: application/json' \
@@ -672,7 +672,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X GET http://coder-server:8080/api/v2/workspaceagents/{workspaceagent}/connection \
-H 'Accept: application/json' \
@@ -770,7 +770,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X GET http://coder-server:8080/api/v2/workspaceagents/{workspaceagent}/containers?label=string \
-H 'Accept: application/json' \
@@ -880,7 +880,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X DELETE http://coder-server:8080/api/v2/workspaceagents/{workspaceagent}/containers/devcontainers/{devcontainer} \
-H 'Coder-Session-Token: API_KEY'
@@ -907,7 +907,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X POST http://coder-server:8080/api/v2/workspaceagents/{workspaceagent}/containers/devcontainers/{devcontainer}/recreate \
-H 'Accept: application/json' \
@@ -952,7 +952,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X GET http://coder-server:8080/api/v2/workspaceagents/{workspaceagent}/containers/watch \
-H 'Accept: application/json' \
@@ -1061,7 +1061,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X GET http://coder-server:8080/api/v2/workspaceagents/{workspaceagent}/coordinate \
-H 'Coder-Session-Token: API_KEY'
@@ -1087,7 +1087,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X GET http://coder-server:8080/api/v2/workspaceagents/{workspaceagent}/listening-ports \
-H 'Accept: application/json' \
@@ -1130,7 +1130,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X GET http://coder-server:8080/api/v2/workspaceagents/{workspaceagent}/logs \
-H 'Accept: application/json' \
@@ -1203,7 +1203,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X GET http://coder-server:8080/api/v2/workspaceagents/{workspaceagent}/pty \
-H 'Coder-Session-Token: API_KEY'
@@ -1229,7 +1229,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X GET http://coder-server:8080/api/v2/workspaceagents/{workspaceagent}/startup-logs \
-H 'Accept: application/json' \
docs/reference/api/aigateway.md
Generated
+4 -4
View File
@@ -4,7 +4,7 @@
### Code samples
```shell
```sh
# Example request using curl
curl -X GET http://coder-server:8080/api/v2/ai-gateway/clients \
-H 'Accept: application/json' \
@@ -39,7 +39,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X GET http://coder-server:8080/api/v2/ai-gateway/models \
-H 'Accept: application/json' \
@@ -74,7 +74,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X GET http://coder-server:8080/api/v2/ai-gateway/sessions \
-H 'Accept: application/json' \
@@ -149,7 +149,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X GET http://coder-server:8080/api/v2/ai-gateway/sessions/{session_id} \
-H 'Accept: application/json' \
docs/reference/api/aiproviders.md
Generated
+5 -5
View File
@@ -4,7 +4,7 @@
### Code samples
```shell
```sh
# Example request using curl
curl -X GET http://coder-server:8080/api/v2/ai/providers \
-H 'Accept: application/json' \
@@ -81,7 +81,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X POST http://coder-server:8080/api/v2/ai/providers \
-H 'Content-Type: application/json' \
@@ -152,7 +152,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X GET http://coder-server:8080/api/v2/ai/providers/{idOrName} \
-H 'Accept: application/json' \
@@ -205,7 +205,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X DELETE http://coder-server:8080/api/v2/ai/providers/{idOrName} \
-H 'Coder-Session-Token: API_KEY'
@@ -231,7 +231,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X PATCH http://coder-server:8080/api/v2/ai/providers/{idOrName} \
-H 'Content-Type: application/json' \
docs/reference/api/applications.md
Generated
+2 -2
View File
@@ -4,7 +4,7 @@
### Code samples
```shell
```sh
# Example request using curl
curl -X GET http://coder-server:8080/api/v2/applications/auth-redirect \
-H 'Coder-Session-Token: API_KEY'
@@ -30,7 +30,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X GET http://coder-server:8080/api/v2/applications/host \
-H 'Accept: application/json' \
docs/reference/api/audit.md
Generated
+1 -1
View File
@@ -4,7 +4,7 @@
### Code samples
```shell
```sh
# Example request using curl
curl -X GET http://coder-server:8080/api/v2/audit?limit=0 \
-H 'Accept: application/json' \
docs/reference/api/authentication.md
Generated
+1 -1
View File
@@ -2,7 +2,7 @@
Long-lived tokens can be generated to perform actions on behalf of your user account:
```shell
```sh
coder tokens create
```
docs/reference/api/authorization.md
Generated
+7 -7
View File
@@ -4,7 +4,7 @@
### Code samples
```shell
```sh
# Example request using curl
curl -X GET http://coder-server:8080/api/v2/auth/scopes \
-H 'Accept: application/json'
@@ -34,7 +34,7 @@ curl -X GET http://coder-server:8080/api/v2/auth/scopes \
### Code samples
```shell
```sh
# Example request using curl
curl -X POST http://coder-server:8080/api/v2/authcheck \
-H 'Content-Type: application/json' \
@@ -102,7 +102,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X POST http://coder-server:8080/api/v2/users/login \
-H 'Content-Type: application/json' \
@@ -146,7 +146,7 @@ curl -X POST http://coder-server:8080/api/v2/users/login \
### Code samples
```shell
```sh
# Example request using curl
curl -X POST http://coder-server:8080/api/v2/users/otp/change-password \
-H 'Content-Type: application/json'
@@ -180,7 +180,7 @@ curl -X POST http://coder-server:8080/api/v2/users/otp/change-password \
### Code samples
```shell
```sh
# Example request using curl
curl -X POST http://coder-server:8080/api/v2/users/otp/request \
-H 'Content-Type: application/json'
@@ -212,7 +212,7 @@ curl -X POST http://coder-server:8080/api/v2/users/otp/request \
### Code samples
```shell
```sh
# Example request using curl
curl -X POST http://coder-server:8080/api/v2/users/validate-password \
-H 'Content-Type: application/json' \
@@ -259,7 +259,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X POST http://coder-server:8080/api/v2/users/{user}/convert-login \
-H 'Content-Type: application/json' \
docs/reference/api/builds.md
Generated
+11 -11
View File
@@ -4,7 +4,7 @@
### Code samples
```shell
```sh
# Example request using curl
curl -X GET http://coder-server:8080/api/v2/users/{user}/workspace/{workspacename}/builds/{buildnumber} \
-H 'Accept: application/json' \
@@ -249,7 +249,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X GET http://coder-server:8080/api/v2/workspacebuilds/{workspacebuild} \
-H 'Accept: application/json' \
@@ -492,7 +492,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X PATCH http://coder-server:8080/api/v2/workspacebuilds/{workspacebuild}/cancel \
-H 'Accept: application/json' \
@@ -543,7 +543,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X GET http://coder-server:8080/api/v2/workspacebuilds/{workspacebuild}/logs \
-H 'Accept: application/json' \
@@ -618,7 +618,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X GET http://coder-server:8080/api/v2/workspacebuilds/{workspacebuild}/parameters \
-H 'Accept: application/json' \
@@ -668,7 +668,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X GET http://coder-server:8080/api/v2/workspacebuilds/{workspacebuild}/resources \
-H 'Accept: application/json' \
@@ -964,7 +964,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X GET http://coder-server:8080/api/v2/workspacebuilds/{workspacebuild}/state \
-H 'Accept: application/json' \
@@ -1207,7 +1207,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X PUT http://coder-server:8080/api/v2/workspacebuilds/{workspacebuild}/state \
-H 'Content-Type: application/json' \
@@ -1245,7 +1245,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X GET http://coder-server:8080/api/v2/workspacebuilds/{workspacebuild}/timings \
-H 'Accept: application/json' \
@@ -1313,7 +1313,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X GET http://coder-server:8080/api/v2/workspaces/{workspace}/builds \
-H 'Accept: application/json' \
@@ -1751,7 +1751,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X POST http://coder-server:8080/api/v2/workspaces/{workspace}/builds \
-H 'Content-Type: application/json' \
docs/reference/api/chats.md
Generated
+20 -20
View File
@@ -6,7 +6,7 @@ Programmatic API for Coder Agents (the user-facing "Coder Agents" / "Chats" prod
### Code samples
```shell
```sh
# Example request using curl
curl -X GET http://coder-server:8080/api/experimental/chats \
-H 'Accept: application/json' \
@@ -238,7 +238,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X POST http://coder-server:8080/api/experimental/chats \
-H 'Content-Type: application/json' \
@@ -511,7 +511,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X POST http://coder-server:8080/api/experimental/chats/files?organization=497f6eca-6276-4993-bfeb-53cbbbba6f08 \
-H 'Accept: application/json' \
@@ -550,7 +550,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X GET http://coder-server:8080/api/experimental/chats/files/{file} \
-H 'Coder-Session-Token: API_KEY'
@@ -578,7 +578,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X GET http://coder-server:8080/api/experimental/chats/models \
-H 'Accept: application/json' \
@@ -631,7 +631,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X GET http://coder-server:8080/api/experimental/chats/watch \
-H 'Accept: application/json' \
@@ -770,7 +770,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X GET http://coder-server:8080/api/experimental/chats/{chat} \
-H 'Accept: application/json' \
@@ -1001,7 +1001,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X PATCH http://coder-server:8080/api/experimental/chats/{chat} \
-H 'Content-Type: application/json' \
@@ -1047,7 +1047,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X PUT http://coder-server:8080/api/experimental/chats/{chat}/context \
-H 'Accept: application/json' \
@@ -1278,7 +1278,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X GET http://coder-server:8080/api/experimental/chats/{chat}/diff \
-H 'Accept: application/json' \
@@ -1322,7 +1322,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X POST http://coder-server:8080/api/experimental/chats/{chat}/interrupt \
-H 'Accept: application/json' \
@@ -1553,7 +1553,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X GET http://coder-server:8080/api/experimental/chats/{chat}/messages \
-H 'Accept: application/json' \
@@ -1750,7 +1750,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X POST http://coder-server:8080/api/experimental/chats/{chat}/messages \
-H 'Content-Type: application/json' \
@@ -1970,7 +1970,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X PATCH http://coder-server:8080/api/experimental/chats/{chat}/messages/{message} \
-H 'Content-Type: application/json' \
@@ -2115,7 +2115,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X GET http://coder-server:8080/api/experimental/chats/{chat}/prompts \
-H 'Accept: application/json' \
@@ -2166,7 +2166,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X POST http://coder-server:8080/api/experimental/chats/{chat}/reconcile-invalid \
-H 'Accept: application/json' \
@@ -2397,7 +2397,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X GET http://coder-server:8080/api/experimental/chats/{chat}/stream \
-H 'Accept: application/json' \
@@ -2687,7 +2687,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X GET http://coder-server:8080/api/experimental/chats/{chat}/stream/desktop \
-H 'Coder-Session-Token: API_KEY'
@@ -2716,7 +2716,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X GET http://coder-server:8080/api/experimental/chats/{chat}/stream/git \
-H 'Accept: application/json' \
@@ -2766,7 +2766,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X POST http://coder-server:8080/api/experimental/chats/{chat}/title/regenerate \
-H 'Accept: application/json' \
docs/reference/api/debug.md
Generated
+5 -5
View File
@@ -4,7 +4,7 @@
### Code samples
```shell
```sh
# Example request using curl
curl -X GET http://coder-server:8080/api/v2/debug/coordinator \
-H 'Coder-Session-Token: API_KEY'
@@ -24,7 +24,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X GET http://coder-server:8080/api/v2/debug/health \
-H 'Accept: application/json' \
@@ -427,7 +427,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X GET http://coder-server:8080/api/v2/debug/health/settings \
-H 'Accept: application/json' \
@@ -460,7 +460,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X PUT http://coder-server:8080/api/v2/debug/health/settings \
-H 'Content-Type: application/json' \
@@ -510,7 +510,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X GET http://coder-server:8080/api/v2/debug/tailnet \
-H 'Coder-Session-Token: API_KEY'
docs/reference/api/enterprise.md
Generated
+95 -95
View File
@@ -4,7 +4,7 @@
### Code samples
```shell
```sh
# Example request using curl
curl -X GET http://coder-server:8080/.well-known/oauth-authorization-server \
-H 'Accept: application/json'
@@ -51,7 +51,7 @@ curl -X GET http://coder-server:8080/.well-known/oauth-authorization-server \
### Code samples
```shell
```sh
# Example request using curl
curl -X GET http://coder-server:8080/.well-known/oauth-protected-resource \
-H 'Accept: application/json'
@@ -88,7 +88,7 @@ curl -X GET http://coder-server:8080/.well-known/oauth-protected-resource \
### Code samples
```shell
```sh
# Example request using curl
curl -X GET http://coder-server:8080/api/v2/agent-firewall/sessions/{id} \
-H 'Accept: application/json' \
@@ -129,7 +129,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X GET http://coder-server:8080/api/v2/agent-firewall/sessions/{id}/logs \
-H 'Accept: application/json' \
@@ -182,7 +182,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X GET http://coder-server:8080/api/v2/ai-gateway/keys \
-H 'Accept: application/json' \
@@ -232,7 +232,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X POST http://coder-server:8080/api/v2/ai-gateway/keys \
-H 'Content-Type: application/json' \
@@ -282,7 +282,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X DELETE http://coder-server:8080/api/v2/ai-gateway/keys/{key} \
-H 'Coder-Session-Token: API_KEY'
@@ -308,7 +308,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X GET http://coder-server:8080/api/v2/ai-gateway/serve \
-H 'X-AI-Governance-Gateway-Key: API_KEY'
@@ -328,7 +328,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X GET http://coder-server:8080/api/v2/appearance \
-H 'Accept: application/json' \
@@ -381,7 +381,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X PUT http://coder-server:8080/api/v2/appearance \
-H 'Content-Type: application/json' \
@@ -453,7 +453,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X GET http://coder-server:8080/api/v2/connectionlog?limit=0 \
-H 'Accept: application/json' \
@@ -548,7 +548,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X GET http://coder-server:8080/api/v2/entitlements \
-H 'Accept: application/json' \
@@ -612,7 +612,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X GET http://coder-server:8080/api/v2/groups?organization=string&has_member=string&group_ids=string \
-H 'Accept: application/json' \
@@ -717,7 +717,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X GET http://coder-server:8080/api/v2/groups/{group} \
-H 'Accept: application/json' \
@@ -780,7 +780,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X DELETE http://coder-server:8080/api/v2/groups/{group} \
-H 'Accept: application/json' \
@@ -842,7 +842,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X PATCH http://coder-server:8080/api/v2/groups/{group} \
-H 'Content-Type: application/json' \
@@ -923,7 +923,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X GET http://coder-server:8080/api/v2/groups/{group}/ai/budget \
-H 'Accept: application/json' \
@@ -963,7 +963,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X PUT http://coder-server:8080/api/v2/groups/{group}/ai/budget \
-H 'Content-Type: application/json' \
@@ -1013,7 +1013,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X DELETE http://coder-server:8080/api/v2/groups/{group}/ai/budget \
-H 'Coder-Session-Token: API_KEY'
@@ -1039,7 +1039,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X GET http://coder-server:8080/api/v2/groups/{group}/members \
-H 'Accept: application/json' \
@@ -1096,7 +1096,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X GET http://coder-server:8080/api/v2/licenses \
-H 'Accept: application/json' \
@@ -1144,7 +1144,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X POST http://coder-server:8080/api/v2/licenses \
-H 'Content-Type: application/json' \
@@ -1193,7 +1193,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X POST http://coder-server:8080/api/v2/licenses/refresh-entitlements \
-H 'Accept: application/json' \
@@ -1231,7 +1231,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X DELETE http://coder-server:8080/api/v2/licenses/{id} \
-H 'Coder-Session-Token: API_KEY'
@@ -1257,7 +1257,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X PUT http://coder-server:8080/api/v2/notifications/templates/{notification_template}/method \
-H 'Coder-Session-Token: API_KEY'
@@ -1284,7 +1284,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X GET http://coder-server:8080/api/v2/oauth2-provider/apps \
-H 'Accept: application/json' \
@@ -1349,7 +1349,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X POST http://coder-server:8080/api/v2/oauth2-provider/apps \
-H 'Content-Type: application/json' \
@@ -1406,7 +1406,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X GET http://coder-server:8080/api/v2/oauth2-provider/apps/{app} \
-H 'Accept: application/json' \
@@ -1452,7 +1452,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X PUT http://coder-server:8080/api/v2/oauth2-provider/apps/{app} \
-H 'Content-Type: application/json' \
@@ -1510,7 +1510,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X DELETE http://coder-server:8080/api/v2/oauth2-provider/apps/{app} \
-H 'Coder-Session-Token: API_KEY'
@@ -1536,7 +1536,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X GET http://coder-server:8080/api/v2/oauth2-provider/apps/{app}/secrets \
-H 'Accept: application/json' \
@@ -1588,7 +1588,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X POST http://coder-server:8080/api/v2/oauth2-provider/apps/{app}/secrets \
-H 'Accept: application/json' \
@@ -1638,7 +1638,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X DELETE http://coder-server:8080/api/v2/oauth2-provider/apps/{app}/secrets/{secretID} \
-H 'Coder-Session-Token: API_KEY'
@@ -1665,7 +1665,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X GET http://coder-server:8080/api/v2/organizations/{organization}/groups \
-H 'Accept: application/json' \
@@ -1768,7 +1768,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X POST http://coder-server:8080/api/v2/organizations/{organization}/groups \
-H 'Content-Type: application/json' \
@@ -1843,7 +1843,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X GET http://coder-server:8080/api/v2/organizations/{organization}/groups/{groupName} \
-H 'Accept: application/json' \
@@ -1906,7 +1906,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X GET http://coder-server:8080/api/v2/organizations/{organization}/groups/{groupName}/members \
-H 'Accept: application/json' \
@@ -1964,7 +1964,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X GET http://coder-server:8080/api/v2/organizations/{organization}/members/{user}/workspace-quota \
-H 'Accept: application/json' \
@@ -2003,7 +2003,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X GET http://coder-server:8080/api/v2/organizations/{organization}/provisionerdaemons/serve \
-H 'Coder-Session-Token: API_KEY'
@@ -2029,7 +2029,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X GET http://coder-server:8080/api/v2/organizations/{organization}/provisionerkeys \
-H 'Accept: application/json' \
@@ -2089,7 +2089,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X POST http://coder-server:8080/api/v2/organizations/{organization}/provisionerkeys \
-H 'Accept: application/json' \
@@ -2126,7 +2126,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X GET http://coder-server:8080/api/v2/organizations/{organization}/provisionerkeys/daemons \
-H 'Accept: application/json' \
@@ -2251,7 +2251,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X DELETE http://coder-server:8080/api/v2/organizations/{organization}/provisionerkeys/{provisionerkey} \
-H 'Coder-Session-Token: API_KEY'
@@ -2278,7 +2278,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X GET http://coder-server:8080/api/v2/organizations/{organization}/settings/idpsync/available-fields \
-H 'Accept: application/json' \
@@ -2317,7 +2317,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X GET http://coder-server:8080/api/v2/organizations/{organization}/settings/idpsync/field-values?claimField=string \
-H 'Accept: application/json' \
@@ -2357,7 +2357,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X GET http://coder-server:8080/api/v2/organizations/{organization}/settings/idpsync/groups \
-H 'Accept: application/json' \
@@ -2408,7 +2408,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X PATCH http://coder-server:8080/api/v2/organizations/{organization}/settings/idpsync/groups \
-H 'Content-Type: application/json' \
@@ -2483,7 +2483,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X PATCH http://coder-server:8080/api/v2/organizations/{organization}/settings/idpsync/groups/config \
-H 'Content-Type: application/json' \
@@ -2546,7 +2546,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X PATCH http://coder-server:8080/api/v2/organizations/{organization}/settings/idpsync/groups/mapping \
-H 'Content-Type: application/json' \
@@ -2618,7 +2618,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X GET http://coder-server:8080/api/v2/organizations/{organization}/settings/idpsync/roles \
-H 'Accept: application/json' \
@@ -2663,7 +2663,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X PATCH http://coder-server:8080/api/v2/organizations/{organization}/settings/idpsync/roles \
-H 'Content-Type: application/json' \
@@ -2726,7 +2726,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X PATCH http://coder-server:8080/api/v2/organizations/{organization}/settings/idpsync/roles/config \
-H 'Content-Type: application/json' \
@@ -2781,7 +2781,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X PATCH http://coder-server:8080/api/v2/organizations/{organization}/settings/idpsync/roles/mapping \
-H 'Content-Type: application/json' \
@@ -2847,7 +2847,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X GET http://coder-server:8080/api/v2/organizations/{organization}/settings/workspace-sharing \
-H 'Accept: application/json' \
@@ -2886,7 +2886,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X PATCH http://coder-server:8080/api/v2/organizations/{organization}/settings/workspace-sharing \
-H 'Content-Type: application/json' \
@@ -2936,7 +2936,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X GET http://coder-server:8080/api/v2/provisionerkeys/{provisionerkey} \
-H 'Accept: application/json'
@@ -2979,7 +2979,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X GET http://coder-server:8080/api/v2/replicas \
-H 'Accept: application/json' \
@@ -3033,7 +3033,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X GET http://coder-server:8080/api/v2/settings/idpsync/available-fields \
-H 'Accept: application/json' \
@@ -3072,7 +3072,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X GET http://coder-server:8080/api/v2/settings/idpsync/field-values?claimField=string \
-H 'Accept: application/json' \
@@ -3112,7 +3112,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X GET http://coder-server:8080/api/v2/settings/idpsync/organization \
-H 'Accept: application/json' \
@@ -3152,7 +3152,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X PATCH http://coder-server:8080/api/v2/settings/idpsync/organization \
-H 'Content-Type: application/json' \
@@ -3216,7 +3216,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X PATCH http://coder-server:8080/api/v2/settings/idpsync/organization/config \
-H 'Content-Type: application/json' \
@@ -3272,7 +3272,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X PATCH http://coder-server:8080/api/v2/settings/idpsync/organization/mapping \
-H 'Content-Type: application/json' \
@@ -3338,7 +3338,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X GET http://coder-server:8080/api/v2/templates/{template}/acl \
-H 'Accept: application/json' \
@@ -3433,7 +3433,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X PATCH http://coder-server:8080/api/v2/templates/{template}/acl \
-H 'Content-Type: application/json' \
@@ -3494,7 +3494,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X GET http://coder-server:8080/api/v2/templates/{template}/acl/available \
-H 'Accept: application/json' \
@@ -3619,7 +3619,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X POST http://coder-server:8080/api/v2/templates/{template}/prebuilds/invalidate \
-H 'Accept: application/json' \
@@ -3662,7 +3662,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X GET http://coder-server:8080/api/v2/users/{user}/ai/budget \
-H 'Accept: application/json' \
@@ -3703,7 +3703,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X PUT http://coder-server:8080/api/v2/users/{user}/ai/budget \
-H 'Content-Type: application/json' \
@@ -3755,7 +3755,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X DELETE http://coder-server:8080/api/v2/users/{user}/ai/budget \
-H 'Coder-Session-Token: API_KEY'
@@ -3781,7 +3781,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X GET http://coder-server:8080/api/v2/users/{user}/ai/spend \
-H 'Accept: application/json' \
@@ -3824,7 +3824,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X GET http://coder-server:8080/api/v2/users/{user}/quiet-hours \
-H 'Accept: application/json' \
@@ -3882,7 +3882,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X PUT http://coder-server:8080/api/v2/users/{user}/quiet-hours \
-H 'Content-Type: application/json' \
@@ -3950,7 +3950,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X GET http://coder-server:8080/api/v2/workspace-quota/{user} \
-H 'Accept: application/json' \
@@ -3988,7 +3988,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X GET http://coder-server:8080/api/v2/workspaceproxies \
-H 'Accept: application/json' \
@@ -4083,7 +4083,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X POST http://coder-server:8080/api/v2/workspaceproxies \
-H 'Content-Type: application/json' \
@@ -4155,7 +4155,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X GET http://coder-server:8080/api/v2/workspaceproxies/{workspaceproxy} \
-H 'Accept: application/json' \
@@ -4216,7 +4216,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X DELETE http://coder-server:8080/api/v2/workspaceproxies/{workspaceproxy} \
-H 'Accept: application/json' \
@@ -4260,7 +4260,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X PATCH http://coder-server:8080/api/v2/workspaceproxies/{workspaceproxy} \
-H 'Content-Type: application/json' \
@@ -4335,7 +4335,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X GET http://coder-server:8080/api/v2/workspaces/{workspace}/external-agent/{agent}/credentials \
-H 'Accept: application/json' \
@@ -4374,7 +4374,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X GET http://coder-server:8080/oauth2/authorize?client_id=string&state=string&response_type=code \
-H 'Coder-Session-Token: API_KEY'
@@ -4410,7 +4410,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X POST http://coder-server:8080/oauth2/authorize?client_id=string&state=string&response_type=code \
-H 'Coder-Session-Token: API_KEY'
@@ -4446,7 +4446,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X GET http://coder-server:8080/oauth2/clients/{client_id} \
-H 'Accept: application/json'
@@ -4507,7 +4507,7 @@ curl -X GET http://coder-server:8080/oauth2/clients/{client_id} \
### Code samples
```shell
```sh
# Example request using curl
curl -X PUT http://coder-server:8080/oauth2/clients/{client_id} \
-H 'Content-Type: application/json' \
@@ -4601,7 +4601,7 @@ curl -X PUT http://coder-server:8080/oauth2/clients/{client_id} \
### Code samples
```shell
```sh
# Example request using curl
curl -X DELETE http://coder-server:8080/oauth2/clients/{client_id}
@@ -4625,7 +4625,7 @@ curl -X DELETE http://coder-server:8080/oauth2/clients/{client_id}
### Code samples
```shell
```sh
# Example request using curl
curl -X POST http://coder-server:8080/oauth2/register \
-H 'Content-Type: application/json' \
@@ -4719,7 +4719,7 @@ curl -X POST http://coder-server:8080/oauth2/register \
### Code samples
```shell
```sh
# Example request using curl
curl -X POST http://coder-server:8080/oauth2/revoke \
@@ -4755,7 +4755,7 @@ token_type_hint: string
### Code samples
```shell
```sh
# Example request using curl
curl -X POST http://coder-server:8080/oauth2/tokens \
-H 'Accept: application/json'
@@ -4815,7 +4815,7 @@ grant_type: authorization_code
### Code samples
```shell
```sh
# Example request using curl
curl -X DELETE http://coder-server:8080/oauth2/tokens?client_id=string \
-H 'Coder-Session-Token: API_KEY'
@@ -4841,7 +4841,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X GET http://coder-server:8080/scim/v2/ServiceProviderConfig
@@ -4859,7 +4859,7 @@ curl -X GET http://coder-server:8080/scim/v2/ServiceProviderConfig
### Code samples
```shell
```sh
# Example request using curl
curl -X GET http://coder-server:8080/scim/v2/Users \
-H 'Authorizaiton: API_KEY'
@@ -4879,7 +4879,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X POST http://coder-server:8080/scim/v2/Users \
-H 'Content-Type: application/json' \
@@ -4971,7 +4971,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X GET http://coder-server:8080/scim/v2/Users/{id} \
-H 'Authorizaiton: API_KEY'
@@ -4997,7 +4997,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X PUT http://coder-server:8080/scim/v2/Users/{id} \
-H 'Content-Type: application/json' \
@@ -5089,7 +5089,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X PATCH http://coder-server:8080/scim/v2/Users/{id} \
-H 'Content-Type: application/json' \
docs/reference/api/files.md
Generated
+2 -2
View File
@@ -4,7 +4,7 @@
### Code samples
```shell
```sh
# Example request using curl
curl -X POST http://coder-server:8080/api/v2/files \
-H 'Accept: application/json' \
@@ -52,7 +52,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X GET http://coder-server:8080/api/v2/files/{fileID} \
-H 'Coder-Session-Token: API_KEY'
docs/reference/api/general.md
Generated
+10 -10
View File
@@ -4,7 +4,7 @@
### Code samples
```shell
```sh
# Example request using curl
curl -X GET http://coder-server:8080/api/v2/ \
-H 'Accept: application/json'
@@ -39,7 +39,7 @@ curl -X GET http://coder-server:8080/api/v2/ \
### Code samples
```shell
```sh
# Example request using curl
curl -X GET http://coder-server:8080/api/v2/buildinfo \
-H 'Accept: application/json'
@@ -76,7 +76,7 @@ curl -X GET http://coder-server:8080/api/v2/buildinfo \
### Code samples
```shell
```sh
# Example request using curl
curl -X POST http://coder-server:8080/api/v2/csp/reports \
-H 'Content-Type: application/json' \
@@ -117,7 +117,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X GET http://coder-server:8080/api/v2/deployment/config \
-H 'Accept: application/json' \
@@ -705,7 +705,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X GET http://coder-server:8080/api/v2/deployment/ssh \
-H 'Accept: application/json' \
@@ -741,7 +741,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X GET http://coder-server:8080/api/v2/deployment/stats \
-H 'Accept: application/json' \
@@ -793,7 +793,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X GET http://coder-server:8080/api/v2/experiments \
-H 'Accept: application/json' \
@@ -832,7 +832,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X GET http://coder-server:8080/api/v2/experiments/available \
-H 'Accept: application/json' \
@@ -871,7 +871,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X GET http://coder-server:8080/api/v2/updatecheck \
-H 'Accept: application/json'
@@ -901,7 +901,7 @@ curl -X GET http://coder-server:8080/api/v2/updatecheck \
### Code samples
```shell
```sh
# Example request using curl
curl -X GET http://coder-server:8080/api/v2/users/{user}/keys/tokens/tokenconfig \
-H 'Accept: application/json' \
docs/reference/api/git.md
Generated
+5 -5
View File
@@ -4,7 +4,7 @@
### Code samples
```shell
```sh
# Example request using curl
curl -X GET http://coder-server:8080/api/v2/external-auth \
-H 'Accept: application/json' \
@@ -41,7 +41,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X GET http://coder-server:8080/api/v2/external-auth/{externalauth} \
-H 'Accept: application/json' \
@@ -103,7 +103,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X DELETE http://coder-server:8080/api/v2/external-auth/{externalauth} \
-H 'Accept: application/json' \
@@ -141,7 +141,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X GET http://coder-server:8080/api/v2/external-auth/{externalauth}/device \
-H 'Accept: application/json' \
@@ -182,7 +182,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X POST http://coder-server:8080/api/v2/external-auth/{externalauth}/device \
-H 'Coder-Session-Token: API_KEY'
docs/reference/api/index.md
Generated
+2 -2
View File
@@ -6,13 +6,13 @@ Get started with the Coder API:
Generate a token on your Coder deployment by visiting:
````shell
````txt
https://coder.example.com/settings/tokens
````
List your workspaces
````shell
````sh
# CLI
curl https://coder.example.com/api/v2/workspaces?q=owner:me \
-H "Coder-Session-Token: <your-token>"
docs/reference/api/initscript.md
Generated
+1 -1
View File
@@ -4,7 +4,7 @@
### Code samples
```shell
```sh
# Example request using curl
curl -X GET http://coder-server:8080/api/v2/init-script/{os}/{arch}
docs/reference/api/insights.md
Generated
+5 -5
View File
@@ -4,7 +4,7 @@
### Code samples
```shell
```sh
# Example request using curl
curl -X GET http://coder-server:8080/api/v2/insights/daus?tz_offset=0 \
-H 'Accept: application/json' \
@@ -47,7 +47,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X GET http://coder-server:8080/api/v2/insights/templates?start_time=2019-08-24T14%3A15%3A22Z&end_time=2019-08-24T14%3A15%3A22Z&interval=week \
-H 'Accept: application/json' \
@@ -149,7 +149,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X GET http://coder-server:8080/api/v2/insights/user-activity?start_time=2019-08-24T14%3A15%3A22Z&end_time=2019-08-24T14%3A15%3A22Z \
-H 'Accept: application/json' \
@@ -205,7 +205,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X GET http://coder-server:8080/api/v2/insights/user-latency?start_time=2019-08-24T14%3A15%3A22Z&end_time=2019-08-24T14%3A15%3A22Z \
-H 'Accept: application/json' \
@@ -264,7 +264,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X GET http://coder-server:8080/api/v2/insights/user-status-counts \
-H 'Accept: application/json' \
docs/reference/api/members.md
Generated
+11 -11
View File
@@ -4,7 +4,7 @@
### Code samples
```shell
```sh
# Example request using curl
curl -X GET http://coder-server:8080/api/v2/organizations/{organization}/members \
-H 'Accept: application/json' \
@@ -106,7 +106,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X GET http://coder-server:8080/api/v2/organizations/{organization}/members/roles \
-H 'Accept: application/json' \
@@ -204,7 +204,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X PUT http://coder-server:8080/api/v2/organizations/{organization}/members/roles \
-H 'Content-Type: application/json' \
@@ -337,7 +337,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X POST http://coder-server:8080/api/v2/organizations/{organization}/members/roles \
-H 'Content-Type: application/json' \
@@ -470,7 +470,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X DELETE http://coder-server:8080/api/v2/organizations/{organization}/members/roles/{roleName} \
-H 'Accept: application/json' \
@@ -565,7 +565,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X GET http://coder-server:8080/api/v2/organizations/{organization}/members/{user} \
-H 'Accept: application/json' \
@@ -631,7 +631,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X POST http://coder-server:8080/api/v2/organizations/{organization}/members/{user} \
-H 'Accept: application/json' \
@@ -679,7 +679,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X DELETE http://coder-server:8080/api/v2/organizations/{organization}/members/{user} \
-H 'Coder-Session-Token: API_KEY'
@@ -706,7 +706,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X PUT http://coder-server:8080/api/v2/organizations/{organization}/members/{user}/roles \
-H 'Content-Type: application/json' \
@@ -766,7 +766,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X GET http://coder-server:8080/api/v2/organizations/{organization}/paginated-members \
-H 'Accept: application/json' \
@@ -879,7 +879,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X GET http://coder-server:8080/api/v2/users/roles \
-H 'Accept: application/json' \
docs/reference/api/notifications.md
Generated
+13 -13
View File
@@ -4,7 +4,7 @@
### Code samples
```shell
```sh
# Example request using curl
curl -X POST http://coder-server:8080/api/v2/notifications/custom \
-H 'Content-Type: application/json' \
@@ -63,7 +63,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X GET http://coder-server:8080/api/v2/notifications/dispatch-methods \
-H 'Accept: application/json' \
@@ -109,7 +109,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X GET http://coder-server:8080/api/v2/notifications/inbox \
-H 'Accept: application/json' \
@@ -170,7 +170,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X PUT http://coder-server:8080/api/v2/notifications/inbox/mark-all-as-read \
-H 'Coder-Session-Token: API_KEY'
@@ -190,7 +190,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X GET http://coder-server:8080/api/v2/notifications/inbox/watch \
-H 'Accept: application/json' \
@@ -255,7 +255,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X PUT http://coder-server:8080/api/v2/notifications/inbox/{id}/read-status \
-H 'Accept: application/json' \
@@ -299,7 +299,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X GET http://coder-server:8080/api/v2/notifications/settings \
-H 'Accept: application/json' \
@@ -330,7 +330,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X PUT http://coder-server:8080/api/v2/notifications/settings \
-H 'Content-Type: application/json' \
@@ -377,7 +377,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X GET http://coder-server:8080/api/v2/notifications/templates/custom \
-H 'Accept: application/json' \
@@ -436,7 +436,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X GET http://coder-server:8080/api/v2/notifications/templates/system \
-H 'Accept: application/json' \
@@ -495,7 +495,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X POST http://coder-server:8080/api/v2/notifications/test \
-H 'Coder-Session-Token: API_KEY'
@@ -515,7 +515,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X GET http://coder-server:8080/api/v2/users/{user}/notifications/preferences \
-H 'Accept: application/json' \
@@ -567,7 +567,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X PUT http://coder-server:8080/api/v2/users/{user}/notifications/preferences \
-H 'Content-Type: application/json' \
docs/reference/api/organizations.md
Generated
+7 -7
View File
@@ -4,7 +4,7 @@
### Code samples
```shell
```sh
# Example request using curl
curl -X GET http://coder-server:8080/api/v2/organizations \
-H 'Accept: application/json' \
@@ -64,7 +64,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X POST http://coder-server:8080/api/v2/organizations \
-H 'Content-Type: application/json' \
@@ -123,7 +123,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X GET http://coder-server:8080/api/v2/organizations/{organization} \
-H 'Accept: application/json' \
@@ -170,7 +170,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X DELETE http://coder-server:8080/api/v2/organizations/{organization} \
-H 'Accept: application/json' \
@@ -214,7 +214,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X PATCH http://coder-server:8080/api/v2/organizations/{organization} \
-H 'Content-Type: application/json' \
@@ -277,7 +277,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X GET http://coder-server:8080/api/v2/organizations/{organization}/provisionerjobs \
-H 'Accept: application/json' \
@@ -415,7 +415,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X GET http://coder-server:8080/api/v2/organizations/{organization}/provisionerjobs/{job} \
-H 'Accept: application/json' \
docs/reference/api/portsharing.md
Generated
+3 -3
View File
@@ -4,7 +4,7 @@
### Code samples
```shell
```sh
# Example request using curl
curl -X GET http://coder-server:8080/api/v2/workspaces/{workspace}/port-share \
-H 'Accept: application/json' \
@@ -49,7 +49,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X POST http://coder-server:8080/api/v2/workspaces/{workspace}/port-share \
-H 'Content-Type: application/json' \
@@ -103,7 +103,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X DELETE http://coder-server:8080/api/v2/workspaces/{workspace}/port-share \
-H 'Content-Type: application/json' \
docs/reference/api/prebuilds.md
Generated
+2 -2
View File
@@ -4,7 +4,7 @@
### Code samples
```shell
```sh
# Example request using curl
curl -X GET http://coder-server:8080/api/v2/prebuilds/settings \
-H 'Accept: application/json' \
@@ -35,7 +35,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X PUT http://coder-server:8080/api/v2/prebuilds/settings \
-H 'Content-Type: application/json' \
docs/reference/api/provisioning.md
Generated
+1 -1
View File
@@ -4,7 +4,7 @@
### Code samples
```shell
```sh
# Example request using curl
curl -X GET http://coder-server:8080/api/v2/organizations/{organization}/provisionerdaemons \
-H 'Accept: application/json' \
docs/reference/api/secrets.md
Generated
+5 -5
View File
@@ -4,7 +4,7 @@
### Code samples
```shell
```sh
# Example request using curl
curl -X GET http://coder-server:8080/api/v2/users/{user}/secrets \
-H 'Accept: application/json' \
@@ -64,7 +64,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X POST http://coder-server:8080/api/v2/users/{user}/secrets \
-H 'Content-Type: application/json' \
@@ -121,7 +121,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X GET http://coder-server:8080/api/v2/users/{user}/secrets/{name} \
-H 'Accept: application/json' \
@@ -165,7 +165,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X DELETE http://coder-server:8080/api/v2/users/{user}/secrets/{name} \
-H 'Coder-Session-Token: API_KEY'
@@ -192,7 +192,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X PATCH http://coder-server:8080/api/v2/users/{user}/secrets/{name} \
-H 'Content-Type: application/json' \
docs/reference/api/tasks.md
Generated
+10 -10
View File
@@ -4,7 +4,7 @@
### Code samples
```shell
```sh
# Example request using curl
curl -X GET http://coder-server:8080/api/v2/tasks \
-H 'Accept: application/json' \
@@ -87,7 +87,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X POST http://coder-server:8080/api/v2/tasks/{user} \
-H 'Content-Type: application/json' \
@@ -179,7 +179,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X GET http://coder-server:8080/api/v2/tasks/{user}/{task} \
-H 'Accept: application/json' \
@@ -258,7 +258,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X DELETE http://coder-server:8080/api/v2/tasks/{user}/{task} \
-H 'Coder-Session-Token: API_KEY'
@@ -285,7 +285,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X PATCH http://coder-server:8080/api/v2/tasks/{user}/{task}/input \
-H 'Content-Type: application/json' \
@@ -322,7 +322,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X GET http://coder-server:8080/api/v2/tasks/{user}/{task}/logs \
-H 'Accept: application/json' \
@@ -369,7 +369,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X POST http://coder-server:8080/api/v2/tasks/{user}/{task}/pause \
-H 'Accept: application/json' \
@@ -615,7 +615,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X POST http://coder-server:8080/api/v2/tasks/{user}/{task}/resume \
-H 'Accept: application/json' \
@@ -861,7 +861,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X POST http://coder-server:8080/api/v2/tasks/{user}/{task}/send \
-H 'Content-Type: application/json' \
@@ -898,7 +898,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X POST http://coder-server:8080/api/v2/workspaceagents/me/tasks/{task}/log-snapshot?format=agentapi \
-H 'Content-Type: application/json' \
docs/reference/api/templatebuilder.md
Generated
+4 -4
View File
@@ -4,7 +4,7 @@
### Code samples
```shell
```sh
# Example request using curl
curl -X GET http://coder-server:8080/api/v2/templatebuilder/bases \
-H 'Accept: application/json' \
@@ -56,7 +56,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X POST http://coder-server:8080/api/v2/templatebuilder/compose \
-H 'Content-Type: application/json' \
@@ -104,7 +104,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X POST http://coder-server:8080/api/v2/templatebuilder/compose/template \
-H 'Content-Type: application/json' \
@@ -231,7 +231,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X GET http://coder-server:8080/api/v2/templatebuilder/modules \
-H 'Accept: application/json' \
docs/reference/api/templates.md
Generated
+38 -38
View File
@@ -4,7 +4,7 @@
### Code samples
```shell
```sh
# Example request using curl
curl -X GET http://coder-server:8080/api/v2/organizations/{organization}/templates \
-H 'Accept: application/json' \
@@ -159,7 +159,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X POST http://coder-server:8080/api/v2/organizations/{organization}/templates \
-H 'Content-Type: application/json' \
@@ -288,7 +288,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X GET http://coder-server:8080/api/v2/organizations/{organization}/templates/examples \
-H 'Accept: application/json' \
@@ -350,7 +350,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X GET http://coder-server:8080/api/v2/organizations/{organization}/templates/{templatename} \
-H 'Accept: application/json' \
@@ -441,7 +441,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X GET http://coder-server:8080/api/v2/organizations/{organization}/templates/{templatename}/versions/{templateversionname} \
-H 'Accept: application/json' \
@@ -544,7 +544,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X GET http://coder-server:8080/api/v2/organizations/{organization}/templates/{templatename}/versions/{templateversionname}/previous \
-H 'Accept: application/json' \
@@ -648,7 +648,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X POST http://coder-server:8080/api/v2/organizations/{organization}/templateversions \
-H 'Content-Type: application/json' \
@@ -775,7 +775,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X GET http://coder-server:8080/api/v2/templates \
-H 'Accept: application/json' \
@@ -924,7 +924,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X GET http://coder-server:8080/api/v2/templates/examples \
-H 'Accept: application/json' \
@@ -980,7 +980,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X GET http://coder-server:8080/api/v2/templates/{template} \
-H 'Accept: application/json' \
@@ -1070,7 +1070,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X DELETE http://coder-server:8080/api/v2/templates/{template} \
-H 'Accept: application/json' \
@@ -1114,7 +1114,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X PATCH http://coder-server:8080/api/v2/templates/{template} \
-H 'Content-Type: application/json' \
@@ -1246,7 +1246,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X GET http://coder-server:8080/api/v2/templates/{template}/daus \
-H 'Accept: application/json' \
@@ -1289,7 +1289,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X GET http://coder-server:8080/api/v2/templates/{template}/versions \
-H 'Accept: application/json' \
@@ -1467,7 +1467,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X PATCH http://coder-server:8080/api/v2/templates/{template}/versions \
-H 'Content-Type: application/json' \
@@ -1521,7 +1521,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X POST http://coder-server:8080/api/v2/templates/{template}/versions/archive \
-H 'Content-Type: application/json' \
@@ -1575,7 +1575,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X GET http://coder-server:8080/api/v2/templates/{template}/versions/{templateversionname} \
-H 'Accept: application/json' \
@@ -1750,7 +1750,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X GET http://coder-server:8080/api/v2/templateversions/{templateversion} \
-H 'Accept: application/json' \
@@ -1851,7 +1851,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X PATCH http://coder-server:8080/api/v2/templateversions/{templateversion} \
-H 'Content-Type: application/json' \
@@ -1963,7 +1963,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X POST http://coder-server:8080/api/v2/templateversions/{templateversion}/archive \
-H 'Accept: application/json' \
@@ -2007,7 +2007,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X PATCH http://coder-server:8080/api/v2/templateversions/{templateversion}/cancel \
-H 'Accept: application/json' \
@@ -2051,7 +2051,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X POST http://coder-server:8080/api/v2/templateversions/{templateversion}/dry-run \
-H 'Content-Type: application/json' \
@@ -2148,7 +2148,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X GET http://coder-server:8080/api/v2/templateversions/{templateversion}/dry-run/{jobID} \
-H 'Accept: application/json' \
@@ -2224,7 +2224,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X PATCH http://coder-server:8080/api/v2/templateversions/{templateversion}/dry-run/{jobID}/cancel \
-H 'Accept: application/json' \
@@ -2269,7 +2269,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X GET http://coder-server:8080/api/v2/templateversions/{templateversion}/dry-run/{jobID}/logs \
-H 'Accept: application/json' \
@@ -2345,7 +2345,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X GET http://coder-server:8080/api/v2/templateversions/{templateversion}/dry-run/{jobID}/matched-provisioners \
-H 'Accept: application/json' \
@@ -2385,7 +2385,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X GET http://coder-server:8080/api/v2/templateversions/{templateversion}/dry-run/{jobID}/resources \
-H 'Accept: application/json' \
@@ -2682,7 +2682,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X GET http://coder-server:8080/api/v2/templateversions/{templateversion}/dynamic-parameters \
-H 'Coder-Session-Token: API_KEY'
@@ -2708,7 +2708,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X POST http://coder-server:8080/api/v2/templateversions/{templateversion}/dynamic-parameters/evaluate \
-H 'Content-Type: application/json' \
@@ -2828,7 +2828,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X GET http://coder-server:8080/api/v2/templateversions/{templateversion}/external-auth \
-H 'Accept: application/json' \
@@ -2888,7 +2888,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X GET http://coder-server:8080/api/v2/templateversions/{templateversion}/logs \
-H 'Accept: application/json' \
@@ -2963,7 +2963,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X GET http://coder-server:8080/api/v2/templateversions/{templateversion}/parameters \
-H 'Coder-Session-Token: API_KEY'
@@ -2989,7 +2989,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X GET http://coder-server:8080/api/v2/templateversions/{templateversion}/presets \
-H 'Accept: application/json' \
@@ -3056,7 +3056,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X GET http://coder-server:8080/api/v2/templateversions/{templateversion}/resources \
-H 'Accept: application/json' \
@@ -3352,7 +3352,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X GET http://coder-server:8080/api/v2/templateversions/{templateversion}/rich-parameters \
-H 'Accept: application/json' \
@@ -3451,7 +3451,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X GET http://coder-server:8080/api/v2/templateversions/{templateversion}/schema \
-H 'Coder-Session-Token: API_KEY'
@@ -3477,7 +3477,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X POST http://coder-server:8080/api/v2/templateversions/{templateversion}/unarchive \
-H 'Accept: application/json' \
@@ -3521,7 +3521,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X GET http://coder-server:8080/api/v2/templateversions/{templateversion}/variables \
-H 'Accept: application/json' \
docs/reference/api/users.md
Generated
+35 -35
View File
@@ -4,7 +4,7 @@
### Code samples
```shell
```sh
# Example request using curl
curl -X GET http://coder-server:8080/api/v2/users \
-H 'Accept: application/json' \
@@ -71,7 +71,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X POST http://coder-server:8080/api/v2/users \
-H 'Content-Type: application/json' \
@@ -151,7 +151,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X GET http://coder-server:8080/api/v2/users/authmethods \
-H 'Accept: application/json' \
@@ -194,7 +194,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X GET http://coder-server:8080/api/v2/users/first \
-H 'Accept: application/json' \
@@ -232,7 +232,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X POST http://coder-server:8080/api/v2/users/first \
-H 'Content-Type: application/json' \
@@ -296,7 +296,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X POST http://coder-server:8080/api/v2/users/logout \
-H 'Accept: application/json' \
@@ -334,7 +334,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X GET http://coder-server:8080/api/v2/users/oauth2/github/callback \
-H 'Coder-Session-Token: API_KEY'
@@ -354,7 +354,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X GET http://coder-server:8080/api/v2/users/oauth2/github/device \
-H 'Accept: application/json' \
@@ -389,7 +389,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X GET http://coder-server:8080/api/v2/users/oidc-claims \
-H 'Accept: application/json' \
@@ -420,7 +420,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X GET http://coder-server:8080/api/v2/users/oidc/callback \
-H 'Coder-Session-Token: API_KEY'
@@ -440,7 +440,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X GET http://coder-server:8080/api/v2/users/{user} \
-H 'Accept: application/json' \
@@ -499,7 +499,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X DELETE http://coder-server:8080/api/v2/users/{user} \
-H 'Coder-Session-Token: API_KEY'
@@ -525,7 +525,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X GET http://coder-server:8080/api/v2/users/{user}/appearance \
-H 'Accept: application/json' \
@@ -566,7 +566,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X PUT http://coder-server:8080/api/v2/users/{user}/appearance \
-H 'Content-Type: application/json' \
@@ -621,7 +621,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X GET http://coder-server:8080/api/v2/users/{user}/autofill-parameters?template_id=string \
-H 'Accept: application/json' \
@@ -672,7 +672,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X GET http://coder-server:8080/api/v2/users/{user}/gitsshkey \
-H 'Accept: application/json' \
@@ -712,7 +712,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X PUT http://coder-server:8080/api/v2/users/{user}/gitsshkey \
-H 'Accept: application/json' \
@@ -752,7 +752,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X POST http://coder-server:8080/api/v2/users/{user}/keys \
-H 'Accept: application/json' \
@@ -789,7 +789,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X GET http://coder-server:8080/api/v2/users/{user}/keys/tokens \
-H 'Accept: application/json' \
@@ -877,7 +877,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X POST http://coder-server:8080/api/v2/users/{user}/keys/tokens \
-H 'Content-Type: application/json' \
@@ -935,7 +935,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X GET http://coder-server:8080/api/v2/users/{user}/keys/tokens/{keyname} \
-H 'Accept: application/json' \
@@ -991,7 +991,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X GET http://coder-server:8080/api/v2/users/{user}/keys/{keyid} \
-H 'Accept: application/json' \
@@ -1047,7 +1047,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X DELETE http://coder-server:8080/api/v2/users/{user}/keys/{keyid} \
-H 'Coder-Session-Token: API_KEY'
@@ -1074,7 +1074,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X PUT http://coder-server:8080/api/v2/users/{user}/keys/{keyid}/expire \
-H 'Accept: */*' \
@@ -1108,7 +1108,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X GET http://coder-server:8080/api/v2/users/{user}/login-type \
-H 'Accept: application/json' \
@@ -1145,7 +1145,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X GET http://coder-server:8080/api/v2/users/{user}/organizations \
-H 'Accept: application/json' \
@@ -1211,7 +1211,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X GET http://coder-server:8080/api/v2/users/{user}/organizations/{organizationname} \
-H 'Accept: application/json' \
@@ -1259,7 +1259,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X PUT http://coder-server:8080/api/v2/users/{user}/password \
-H 'Content-Type: application/json' \
@@ -1296,7 +1296,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X GET http://coder-server:8080/api/v2/users/{user}/preferences \
-H 'Accept: application/json' \
@@ -1337,7 +1337,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X PUT http://coder-server:8080/api/v2/users/{user}/preferences \
-H 'Content-Type: application/json' \
@@ -1392,7 +1392,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X PUT http://coder-server:8080/api/v2/users/{user}/profile \
-H 'Content-Type: application/json' \
@@ -1463,7 +1463,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X GET http://coder-server:8080/api/v2/users/{user}/roles \
-H 'Accept: application/json' \
@@ -1522,7 +1522,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X PUT http://coder-server:8080/api/v2/users/{user}/roles \
-H 'Content-Type: application/json' \
@@ -1593,7 +1593,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X PUT http://coder-server:8080/api/v2/users/{user}/status/activate \
-H 'Accept: application/json' \
@@ -1652,7 +1652,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X PUT http://coder-server:8080/api/v2/users/{user}/status/suspend \
-H 'Accept: application/json' \
docs/reference/api/workspaceproxies.md
Generated
+1 -1
View File
@@ -4,7 +4,7 @@
### Code samples
```shell
```sh
# Example request using curl
curl -X GET http://coder-server:8080/api/v2/regions \
-H 'Accept: application/json' \
docs/reference/api/workspaces.md
Generated
+23 -23
View File
@@ -4,7 +4,7 @@
### Code samples
```shell
```sh
# Example request using curl
curl -X POST http://coder-server:8080/api/v2/organizations/{organization}/members/{user}/workspaces \
-H 'Content-Type: application/json' \
@@ -338,7 +338,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X GET http://coder-server:8080/api/v2/organizations/{organization}/members/{user}/workspaces/available-users \
-H 'Accept: application/json' \
@@ -396,7 +396,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X GET http://coder-server:8080/api/v2/users/{user}/workspace/{workspacename} \
-H 'Accept: application/json' \
@@ -704,7 +704,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X POST http://coder-server:8080/api/v2/users/{user}/workspaces \
-H 'Content-Type: application/json' \
@@ -1037,7 +1037,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X GET http://coder-server:8080/api/v2/workspaces \
-H 'Accept: application/json' \
@@ -1333,7 +1333,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X GET http://coder-server:8080/api/v2/workspaces/{workspace} \
-H 'Accept: application/json' \
@@ -1640,7 +1640,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X PATCH http://coder-server:8080/api/v2/workspaces/{workspace} \
-H 'Content-Type: application/json' \
@@ -1676,7 +1676,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X GET http://coder-server:8080/api/v2/workspaces/{workspace}/acl \
-H 'Accept: application/json' \
@@ -1752,7 +1752,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X DELETE http://coder-server:8080/api/v2/workspaces/{workspace}/acl \
-H 'Coder-Session-Token: API_KEY'
@@ -1778,7 +1778,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X PATCH http://coder-server:8080/api/v2/workspaces/{workspace}/acl \
-H 'Content-Type: application/json' \
@@ -1821,7 +1821,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X GET http://coder-server:8080/api/v2/workspaces/{workspace}/agent-connection-watch \
-H 'Accept: application/json' \
@@ -1871,7 +1871,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X PUT http://coder-server:8080/api/v2/workspaces/{workspace}/autostart \
-H 'Content-Type: application/json' \
@@ -1907,7 +1907,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X PUT http://coder-server:8080/api/v2/workspaces/{workspace}/autoupdates \
-H 'Content-Type: application/json' \
@@ -1943,7 +1943,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X PUT http://coder-server:8080/api/v2/workspaces/{workspace}/dormant \
-H 'Content-Type: application/json' \
@@ -2259,7 +2259,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X PUT http://coder-server:8080/api/v2/workspaces/{workspace}/extend \
-H 'Content-Type: application/json' \
@@ -2313,7 +2313,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X PUT http://coder-server:8080/api/v2/workspaces/{workspace}/favorite \
-H 'Coder-Session-Token: API_KEY'
@@ -2339,7 +2339,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X DELETE http://coder-server:8080/api/v2/workspaces/{workspace}/favorite \
-H 'Coder-Session-Token: API_KEY'
@@ -2365,7 +2365,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X GET http://coder-server:8080/api/v2/workspaces/{workspace}/resolve-autostart \
-H 'Accept: application/json' \
@@ -2402,7 +2402,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X GET http://coder-server:8080/api/v2/workspaces/{workspace}/timings \
-H 'Accept: application/json' \
@@ -2470,7 +2470,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X PUT http://coder-server:8080/api/v2/workspaces/{workspace}/ttl \
-H 'Content-Type: application/json' \
@@ -2506,7 +2506,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X POST http://coder-server:8080/api/v2/workspaces/{workspace}/usage \
-H 'Content-Type: application/json' \
@@ -2543,7 +2543,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X GET http://coder-server:8080/api/v2/workspaces/{workspace}/watch \
-H 'Accept: text/event-stream' \
@@ -2574,7 +2574,7 @@ To perform this operation, you must be authenticated. [Learn more](authenticatio
### Code samples
```shell
```sh
# Example request using curl
curl -X GET http://coder-server:8080/api/v2/workspaces/{workspace}/watch-ws \
-H 'Accept: application/json' \