mirror of
https://github.com/coder/coder.git
synced 2026-09-22 05:05:20 +08:00
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.*
936 lines
24 KiB
Markdown
Generated
936 lines
24 KiB
Markdown
Generated
# General
|
|
|
|
## API root handler
|
|
|
|
### Code samples
|
|
|
|
```sh
|
|
# Example request using curl
|
|
curl -X GET http://coder-server:8080/api/v2/ \
|
|
-H 'Accept: application/json'
|
|
```
|
|
|
|
`GET /api/v2/`
|
|
|
|
### Example responses
|
|
|
|
> 200 Response
|
|
|
|
```json
|
|
{
|
|
"detail": "string",
|
|
"message": "string",
|
|
"validations": [
|
|
{
|
|
"detail": "string",
|
|
"field": "string"
|
|
}
|
|
]
|
|
}
|
|
```
|
|
|
|
### Responses
|
|
|
|
| Status | Meaning | Description | Schema |
|
|
|--------|---------------------------------------------------------|-------------|--------------------------------------------------|
|
|
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.Response](schemas.md#codersdkresponse) |
|
|
|
|
## Build info
|
|
|
|
### Code samples
|
|
|
|
```sh
|
|
# Example request using curl
|
|
curl -X GET http://coder-server:8080/api/v2/buildinfo \
|
|
-H 'Accept: application/json'
|
|
```
|
|
|
|
`GET /api/v2/buildinfo`
|
|
|
|
### Example responses
|
|
|
|
> 200 Response
|
|
|
|
```json
|
|
{
|
|
"agent_api_version": "string",
|
|
"dashboard_url": "string",
|
|
"deployment_id": "string",
|
|
"external_url": "string",
|
|
"provisioner_api_version": "string",
|
|
"telemetry": true,
|
|
"upgrade_message": "string",
|
|
"version": "string",
|
|
"webpush_public_key": "string",
|
|
"workspace_proxy": true
|
|
}
|
|
```
|
|
|
|
### Responses
|
|
|
|
| Status | Meaning | Description | Schema |
|
|
|--------|---------------------------------------------------------|-------------|--------------------------------------------------------------------|
|
|
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.BuildInfoResponse](schemas.md#codersdkbuildinforesponse) |
|
|
|
|
## Report CSP violations
|
|
|
|
### Code samples
|
|
|
|
```sh
|
|
# Example request using curl
|
|
curl -X POST http://coder-server:8080/api/v2/csp/reports \
|
|
-H 'Content-Type: application/json' \
|
|
-H 'Accept: */*' \
|
|
-H 'Coder-Session-Token: API_KEY'
|
|
```
|
|
|
|
`POST /api/v2/csp/reports`
|
|
|
|
> Body parameter
|
|
|
|
```json
|
|
{
|
|
"csp-report": {}
|
|
}
|
|
```
|
|
|
|
### Parameters
|
|
|
|
| Name | In | Type | Required | Description |
|
|
|--------|------|------------------------------------------------------|----------|------------------|
|
|
| `body` | body | [coderd.cspViolation](schemas.md#coderdcspviolation) | true | Violation report |
|
|
|
|
### Example responses
|
|
|
|
> 413 Response
|
|
|
|
### Responses
|
|
|
|
| Status | Meaning | Description | Schema |
|
|
|--------|-------------------------------------------------------------------------|--------------------------|--------------------------------------------------|
|
|
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | |
|
|
| 413 | [Payload Too Large](https://tools.ietf.org/html/rfc7231#section-6.5.11) | Request Entity Too Large | [codersdk.Response](schemas.md#codersdkresponse) |
|
|
|
|
To perform this operation, you must be authenticated. [Learn more](authentication.md).
|
|
|
|
## Get deployment config
|
|
|
|
### Code samples
|
|
|
|
```sh
|
|
# Example request using curl
|
|
curl -X GET http://coder-server:8080/api/v2/deployment/config \
|
|
-H 'Accept: application/json' \
|
|
-H 'Coder-Session-Token: API_KEY'
|
|
```
|
|
|
|
`GET /api/v2/deployment/config`
|
|
|
|
### Example responses
|
|
|
|
> 200 Response
|
|
|
|
```json
|
|
{
|
|
"config": {
|
|
"access_url": {
|
|
"forceQuery": true,
|
|
"fragment": "string",
|
|
"host": "string",
|
|
"omitHost": true,
|
|
"opaque": "string",
|
|
"path": "string",
|
|
"rawFragment": "string",
|
|
"rawPath": "string",
|
|
"rawQuery": "string",
|
|
"scheme": "string",
|
|
"user": {}
|
|
},
|
|
"additional_csp_policy": [
|
|
"string"
|
|
],
|
|
"address": {
|
|
"host": "string",
|
|
"port": "string"
|
|
},
|
|
"agent_fallback_troubleshooting_url": {
|
|
"forceQuery": true,
|
|
"fragment": "string",
|
|
"host": "string",
|
|
"omitHost": true,
|
|
"opaque": "string",
|
|
"path": "string",
|
|
"rawFragment": "string",
|
|
"rawPath": "string",
|
|
"rawQuery": "string",
|
|
"scheme": "string",
|
|
"user": {}
|
|
},
|
|
"agent_stat_refresh_interval": 0,
|
|
"ai": {
|
|
"aibridge_proxy": {
|
|
"allowed_private_cidrs": [
|
|
"string"
|
|
],
|
|
"api_dump_dir": "string",
|
|
"cert_file": "string",
|
|
"domain_allowlist": [
|
|
"string"
|
|
],
|
|
"enabled": true,
|
|
"key_file": "string",
|
|
"listen_addr": "string",
|
|
"target": "string",
|
|
"tls_cert_file": "string",
|
|
"tls_key_file": "string",
|
|
"upstream_proxy": "string",
|
|
"upstream_proxy_ca": "string"
|
|
},
|
|
"bridge": {
|
|
"allow_byok": true,
|
|
"anthropic": {
|
|
"base_url": "string",
|
|
"key": "string"
|
|
},
|
|
"api_dump_dir": "string",
|
|
"bedrock": {
|
|
"access_key": "string",
|
|
"access_key_secret": "string",
|
|
"base_url": "string",
|
|
"model": "string",
|
|
"region": "string",
|
|
"small_fast_model": "string"
|
|
},
|
|
"budget_period": "string",
|
|
"budget_policy": "string",
|
|
"circuit_breaker_enabled": true,
|
|
"circuit_breaker_failure_threshold": 0,
|
|
"circuit_breaker_interval": 0,
|
|
"circuit_breaker_max_requests": 0,
|
|
"circuit_breaker_timeout": 0,
|
|
"enabled": true,
|
|
"inject_coder_mcp_tools": true,
|
|
"max_concurrency": 0,
|
|
"openai": {
|
|
"base_url": "string",
|
|
"key": "string"
|
|
},
|
|
"providers": [
|
|
{
|
|
"base_url": "string",
|
|
"bedrock_model": "string",
|
|
"bedrock_region": "string",
|
|
"bedrock_small_fast_model": "string",
|
|
"name": "string",
|
|
"type": "string"
|
|
}
|
|
],
|
|
"rate_limit": 0,
|
|
"retention": 0,
|
|
"send_actor_headers": true,
|
|
"structured_logging": true
|
|
},
|
|
"chat": {
|
|
"acquire_batch_size": 0,
|
|
"debug_logging_enabled": true
|
|
}
|
|
},
|
|
"allow_workspace_renames": true,
|
|
"autobuild_poll_interval": 0,
|
|
"browser_only": true,
|
|
"cache_directory": "string",
|
|
"cli_upgrade_message": "string",
|
|
"cluster": {
|
|
"host": "string"
|
|
},
|
|
"config": "string",
|
|
"config_ssh": {
|
|
"deploymentName": "string",
|
|
"sshconfigOptions": [
|
|
"string"
|
|
]
|
|
},
|
|
"dangerous": {
|
|
"allow_all_cors": true,
|
|
"allow_path_app_sharing": true,
|
|
"allow_path_app_site_owner_access": true
|
|
},
|
|
"derp": {
|
|
"config": {
|
|
"block_direct": true,
|
|
"force_websockets": true,
|
|
"path": "string",
|
|
"url": "string"
|
|
},
|
|
"server": {
|
|
"enable": true,
|
|
"region_code": "string",
|
|
"region_id": 0,
|
|
"region_name": "string",
|
|
"relay_url": {
|
|
"forceQuery": true,
|
|
"fragment": "string",
|
|
"host": "string",
|
|
"omitHost": true,
|
|
"opaque": "string",
|
|
"path": "string",
|
|
"rawFragment": "string",
|
|
"rawPath": "string",
|
|
"rawQuery": "string",
|
|
"scheme": "string",
|
|
"user": {}
|
|
},
|
|
"stun_addresses": [
|
|
"string"
|
|
]
|
|
}
|
|
},
|
|
"disable_chat_sharing": true,
|
|
"disable_owner_workspace_exec": true,
|
|
"disable_password_auth": true,
|
|
"disable_path_apps": true,
|
|
"disable_workspace_sharing": true,
|
|
"docs_url": {
|
|
"forceQuery": true,
|
|
"fragment": "string",
|
|
"host": "string",
|
|
"omitHost": true,
|
|
"opaque": "string",
|
|
"path": "string",
|
|
"rawFragment": "string",
|
|
"rawPath": "string",
|
|
"rawQuery": "string",
|
|
"scheme": "string",
|
|
"user": {}
|
|
},
|
|
"enable_authz_recording": true,
|
|
"enable_terraform_debug_mode": true,
|
|
"ephemeral_deployment": true,
|
|
"experiments": [
|
|
"string"
|
|
],
|
|
"external_auth": {
|
|
"value": [
|
|
{
|
|
"api_base_url": "string",
|
|
"app_install_url": "string",
|
|
"app_installations_url": "string",
|
|
"auth_url": "string",
|
|
"client_id": "string",
|
|
"code_challenge_methods_supported": [
|
|
"string"
|
|
],
|
|
"device_code_url": "string",
|
|
"device_flow": true,
|
|
"display_icon": "string",
|
|
"display_name": "string",
|
|
"id": "string",
|
|
"mcp_tool_allow_regex": "string",
|
|
"mcp_tool_deny_regex": "string",
|
|
"mcp_url": "string",
|
|
"no_refresh": true,
|
|
"regex": "string",
|
|
"revoke_url": "string",
|
|
"scopes": [
|
|
"string"
|
|
],
|
|
"token_url": "string",
|
|
"type": "string",
|
|
"validate_url": "string"
|
|
}
|
|
]
|
|
},
|
|
"external_auth_github_default_provider_enable": true,
|
|
"external_token_encryption_keys": [
|
|
"string"
|
|
],
|
|
"healthcheck": {
|
|
"refresh": 0,
|
|
"threshold_database": 0
|
|
},
|
|
"hide_ai_tasks": true,
|
|
"http_address": "string",
|
|
"http_cookies": {
|
|
"host_prefix": true,
|
|
"same_site": "string",
|
|
"secure_auth_cookie": true
|
|
},
|
|
"job_hang_detector_interval": 0,
|
|
"logging": {
|
|
"human": "string",
|
|
"json": "string",
|
|
"log_filter": [
|
|
"string"
|
|
],
|
|
"stackdriver": "string"
|
|
},
|
|
"metrics_cache_refresh_interval": 0,
|
|
"notifications": {
|
|
"dispatch_timeout": 0,
|
|
"email": {
|
|
"auth": {
|
|
"identity": "string",
|
|
"password": "string",
|
|
"password_file": "string",
|
|
"username": "string"
|
|
},
|
|
"force_tls": true,
|
|
"from": "string",
|
|
"hello": "string",
|
|
"smarthost": "string",
|
|
"tls": {
|
|
"ca_file": "string",
|
|
"cert_file": "string",
|
|
"insecure_skip_verify": true,
|
|
"key_file": "string",
|
|
"server_name": "string",
|
|
"start_tls": true
|
|
}
|
|
},
|
|
"fetch_interval": 0,
|
|
"inbox": {
|
|
"enabled": true
|
|
},
|
|
"lease_count": 0,
|
|
"lease_period": 0,
|
|
"max_send_attempts": 0,
|
|
"method": "string",
|
|
"retry_interval": 0,
|
|
"sync_buffer_size": 0,
|
|
"sync_interval": 0,
|
|
"webhook": {
|
|
"endpoint": {
|
|
"forceQuery": true,
|
|
"fragment": "string",
|
|
"host": "string",
|
|
"omitHost": true,
|
|
"opaque": "string",
|
|
"path": "string",
|
|
"rawFragment": "string",
|
|
"rawPath": "string",
|
|
"rawQuery": "string",
|
|
"scheme": "string",
|
|
"user": {}
|
|
}
|
|
}
|
|
},
|
|
"oauth2": {
|
|
"github": {
|
|
"allow_everyone": true,
|
|
"allow_signups": true,
|
|
"allowed_orgs": [
|
|
"string"
|
|
],
|
|
"allowed_teams": [
|
|
"string"
|
|
],
|
|
"client_id": "string",
|
|
"client_secret": "string",
|
|
"default_provider_enable": true,
|
|
"device_flow": true,
|
|
"enterprise_base_url": "string"
|
|
}
|
|
},
|
|
"oidc": {
|
|
"allow_signups": true,
|
|
"auth_url_params": {},
|
|
"auto_repair_links": true,
|
|
"client_cert_file": "string",
|
|
"client_id": "string",
|
|
"client_key_file": "string",
|
|
"client_secret": "string",
|
|
"email_domain": [
|
|
"string"
|
|
],
|
|
"email_fallback": true,
|
|
"email_field": "string",
|
|
"group_allow_list": [
|
|
"string"
|
|
],
|
|
"group_auto_create": true,
|
|
"group_mapping": {},
|
|
"group_regex_filter": {},
|
|
"groups_field": "string",
|
|
"icon_url": {
|
|
"forceQuery": true,
|
|
"fragment": "string",
|
|
"host": "string",
|
|
"omitHost": true,
|
|
"opaque": "string",
|
|
"path": "string",
|
|
"rawFragment": "string",
|
|
"rawPath": "string",
|
|
"rawQuery": "string",
|
|
"scheme": "string",
|
|
"user": {}
|
|
},
|
|
"ignore_email_verified": true,
|
|
"ignore_user_info": true,
|
|
"issuer_url": "string",
|
|
"name_field": "string",
|
|
"organization_assign_default": true,
|
|
"organization_field": "string",
|
|
"organization_mapping": {},
|
|
"redirect_allowed_hosts": [
|
|
"string"
|
|
],
|
|
"redirect_url": {
|
|
"forceQuery": true,
|
|
"fragment": "string",
|
|
"host": "string",
|
|
"omitHost": true,
|
|
"opaque": "string",
|
|
"path": "string",
|
|
"rawFragment": "string",
|
|
"rawPath": "string",
|
|
"rawQuery": "string",
|
|
"scheme": "string",
|
|
"user": {}
|
|
},
|
|
"scopes": [
|
|
"string"
|
|
],
|
|
"sign_in_text": "string",
|
|
"signups_disabled_text": "string",
|
|
"skip_issuer_checks": true,
|
|
"source_user_info_from_access_token": true,
|
|
"user_role_field": "string",
|
|
"user_role_mapping": {},
|
|
"user_roles_default": [
|
|
"string"
|
|
],
|
|
"username_field": "string"
|
|
},
|
|
"pg_auth": "string",
|
|
"pg_conn_max_idle": "string",
|
|
"pg_conn_max_open": 0,
|
|
"pg_connection_url": "string",
|
|
"pprof": {
|
|
"address": {
|
|
"host": "string",
|
|
"port": "string"
|
|
},
|
|
"enable": true
|
|
},
|
|
"prometheus": {
|
|
"address": {
|
|
"host": "string",
|
|
"port": "string"
|
|
},
|
|
"aggregate_agent_stats_by": [
|
|
"string"
|
|
],
|
|
"collect_agent_stats": true,
|
|
"collect_db_metrics": true,
|
|
"enable": true
|
|
},
|
|
"provisioner": {
|
|
"daemon_poll_interval": 0,
|
|
"daemon_poll_jitter": 0,
|
|
"daemon_psk": "string",
|
|
"daemon_types": [
|
|
"string"
|
|
],
|
|
"daemons": 0,
|
|
"force_cancel_interval": 0
|
|
},
|
|
"proxy_health_status_interval": 0,
|
|
"proxy_trusted_headers": [
|
|
"string"
|
|
],
|
|
"proxy_trusted_origins": [
|
|
"string"
|
|
],
|
|
"rate_limit": {
|
|
"api": 0,
|
|
"disable_all": true
|
|
},
|
|
"redirect_to_access_url": true,
|
|
"retention": {
|
|
"api_keys": 0,
|
|
"audit_logs": 0,
|
|
"boundary_logs": 0,
|
|
"connection_logs": 0,
|
|
"workspace_agent_logs": 0
|
|
},
|
|
"scim_api_key": "string",
|
|
"scim_use_legacy": true,
|
|
"session_lifetime": {
|
|
"default_duration": 0,
|
|
"default_token_lifetime": 0,
|
|
"disable_expiry_refresh": true,
|
|
"max_admin_token_lifetime": 0,
|
|
"max_token_lifetime": 0,
|
|
"refresh_default_duration": 0
|
|
},
|
|
"ssh_keygen_algorithm": "string",
|
|
"stats_collection": {
|
|
"usage_stats": {
|
|
"enable": true
|
|
}
|
|
},
|
|
"strict_transport_security": 0,
|
|
"strict_transport_security_options": [
|
|
"string"
|
|
],
|
|
"support": {
|
|
"links": {
|
|
"value": [
|
|
{
|
|
"icon": "bug",
|
|
"location": "navbar",
|
|
"name": "string",
|
|
"target": "string"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"swagger": {
|
|
"enable": true
|
|
},
|
|
"telemetry": {
|
|
"enable": true,
|
|
"trace": true,
|
|
"url": {
|
|
"forceQuery": true,
|
|
"fragment": "string",
|
|
"host": "string",
|
|
"omitHost": true,
|
|
"opaque": "string",
|
|
"path": "string",
|
|
"rawFragment": "string",
|
|
"rawPath": "string",
|
|
"rawQuery": "string",
|
|
"scheme": "string",
|
|
"user": {}
|
|
}
|
|
},
|
|
"template_builder": {
|
|
"disabled": true,
|
|
"registry_url": "string"
|
|
},
|
|
"terms_of_service_url": "string",
|
|
"tls": {
|
|
"address": {
|
|
"host": "string",
|
|
"port": "string"
|
|
},
|
|
"allow_insecure_ciphers": true,
|
|
"cert_file": [
|
|
"string"
|
|
],
|
|
"client_auth": "string",
|
|
"client_ca_file": "string",
|
|
"client_cert_file": "string",
|
|
"client_key_file": "string",
|
|
"enable": true,
|
|
"key_file": [
|
|
"string"
|
|
],
|
|
"min_version": "string",
|
|
"redirect_http": true,
|
|
"supported_ciphers": [
|
|
"string"
|
|
]
|
|
},
|
|
"trace": {
|
|
"capture_logs": true,
|
|
"data_dog": true,
|
|
"enable": true,
|
|
"honeycomb_api_key": "string"
|
|
},
|
|
"update_check": true,
|
|
"user_quiet_hours_schedule": {
|
|
"allow_user_custom": true,
|
|
"default_schedule": "string"
|
|
},
|
|
"verbose": true,
|
|
"web_terminal_renderer": "string",
|
|
"wgtunnel_host": "string",
|
|
"wildcard_access_url": "string",
|
|
"workspace_hostname_suffix": "string",
|
|
"workspace_prebuilds": {
|
|
"failure_hard_limit": 0,
|
|
"reconciliation_backoff_interval": 0,
|
|
"reconciliation_backoff_lookback": 0,
|
|
"reconciliation_interval": 0
|
|
},
|
|
"write_config": true
|
|
},
|
|
"options": [
|
|
{
|
|
"annotations": {
|
|
"property1": "string",
|
|
"property2": "string"
|
|
},
|
|
"default": "string",
|
|
"description": "string",
|
|
"env": "string",
|
|
"flag": "string",
|
|
"flag_shorthand": "string",
|
|
"group": {
|
|
"description": "string",
|
|
"name": "string",
|
|
"parent": {
|
|
"description": "string",
|
|
"name": "string",
|
|
"parent": {},
|
|
"yaml": "string"
|
|
},
|
|
"yaml": "string"
|
|
},
|
|
"hidden": true,
|
|
"name": "string",
|
|
"required": true,
|
|
"use_instead": [
|
|
{}
|
|
],
|
|
"value": null,
|
|
"value_source": "",
|
|
"yaml": "string"
|
|
}
|
|
]
|
|
}
|
|
```
|
|
|
|
### Responses
|
|
|
|
| Status | Meaning | Description | Schema |
|
|
|--------|---------------------------------------------------------|-------------|------------------------------------------------------------------|
|
|
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.DeploymentConfig](schemas.md#codersdkdeploymentconfig) |
|
|
|
|
To perform this operation, you must be authenticated. [Learn more](authentication.md).
|
|
|
|
## SSH Config
|
|
|
|
### Code samples
|
|
|
|
```sh
|
|
# Example request using curl
|
|
curl -X GET http://coder-server:8080/api/v2/deployment/ssh \
|
|
-H 'Accept: application/json' \
|
|
-H 'Coder-Session-Token: API_KEY'
|
|
```
|
|
|
|
`GET /api/v2/deployment/ssh`
|
|
|
|
### Example responses
|
|
|
|
> 200 Response
|
|
|
|
```json
|
|
{
|
|
"hostname_prefix": "string",
|
|
"hostname_suffix": "string",
|
|
"ssh_config_options": {
|
|
"property1": "string",
|
|
"property2": "string"
|
|
}
|
|
}
|
|
```
|
|
|
|
### Responses
|
|
|
|
| Status | Meaning | Description | Schema |
|
|
|--------|---------------------------------------------------------|-------------|--------------------------------------------------------------------|
|
|
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.SSHConfigResponse](schemas.md#codersdksshconfigresponse) |
|
|
|
|
To perform this operation, you must be authenticated. [Learn more](authentication.md).
|
|
|
|
## Get deployment stats
|
|
|
|
### Code samples
|
|
|
|
```sh
|
|
# Example request using curl
|
|
curl -X GET http://coder-server:8080/api/v2/deployment/stats \
|
|
-H 'Accept: application/json' \
|
|
-H 'Coder-Session-Token: API_KEY'
|
|
```
|
|
|
|
`GET /api/v2/deployment/stats`
|
|
|
|
### Example responses
|
|
|
|
> 200 Response
|
|
|
|
```json
|
|
{
|
|
"aggregated_from": "2019-08-24T14:15:22Z",
|
|
"collected_at": "2019-08-24T14:15:22Z",
|
|
"next_update_at": "2019-08-24T14:15:22Z",
|
|
"session_count": {
|
|
"jetbrains": 0,
|
|
"reconnecting_pty": 0,
|
|
"ssh": 0,
|
|
"vscode": 0
|
|
},
|
|
"workspaces": {
|
|
"building": 0,
|
|
"connection_latency_ms": {
|
|
"p50": 0,
|
|
"p95": 0
|
|
},
|
|
"failed": 0,
|
|
"pending": 0,
|
|
"running": 0,
|
|
"rx_bytes": 0,
|
|
"stopped": 0,
|
|
"tx_bytes": 0
|
|
}
|
|
}
|
|
```
|
|
|
|
### Responses
|
|
|
|
| Status | Meaning | Description | Schema |
|
|
|--------|---------------------------------------------------------|-------------|----------------------------------------------------------------|
|
|
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.DeploymentStats](schemas.md#codersdkdeploymentstats) |
|
|
|
|
To perform this operation, you must be authenticated. [Learn more](authentication.md).
|
|
|
|
## Get enabled experiments
|
|
|
|
### Code samples
|
|
|
|
```sh
|
|
# Example request using curl
|
|
curl -X GET http://coder-server:8080/api/v2/experiments \
|
|
-H 'Accept: application/json' \
|
|
-H 'Coder-Session-Token: API_KEY'
|
|
```
|
|
|
|
`GET /api/v2/experiments`
|
|
|
|
### Example responses
|
|
|
|
> 200 Response
|
|
|
|
```json
|
|
[
|
|
"example"
|
|
]
|
|
```
|
|
|
|
### Responses
|
|
|
|
| Status | Meaning | Description | Schema |
|
|
|--------|---------------------------------------------------------|-------------|---------------------------------------------------------------|
|
|
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | array of [codersdk.Experiment](schemas.md#codersdkexperiment) |
|
|
|
|
<h3 id="get-enabled-experiments-responseschema">Response Schema</h3>
|
|
|
|
Status Code **200**
|
|
|
|
| Name | Type | Required | Restrictions | Description |
|
|
|----------------|-------|----------|--------------|-------------|
|
|
| `[array item]` | array | false | | |
|
|
|
|
To perform this operation, you must be authenticated. [Learn more](authentication.md).
|
|
|
|
## Get safe experiments
|
|
|
|
### Code samples
|
|
|
|
```sh
|
|
# Example request using curl
|
|
curl -X GET http://coder-server:8080/api/v2/experiments/available \
|
|
-H 'Accept: application/json' \
|
|
-H 'Coder-Session-Token: API_KEY'
|
|
```
|
|
|
|
`GET /api/v2/experiments/available`
|
|
|
|
### Example responses
|
|
|
|
> 200 Response
|
|
|
|
```json
|
|
[
|
|
"example"
|
|
]
|
|
```
|
|
|
|
### Responses
|
|
|
|
| Status | Meaning | Description | Schema |
|
|
|--------|---------------------------------------------------------|-------------|---------------------------------------------------------------|
|
|
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | array of [codersdk.Experiment](schemas.md#codersdkexperiment) |
|
|
|
|
<h3 id="get-safe-experiments-responseschema">Response Schema</h3>
|
|
|
|
Status Code **200**
|
|
|
|
| Name | Type | Required | Restrictions | Description |
|
|
|----------------|-------|----------|--------------|-------------|
|
|
| `[array item]` | array | false | | |
|
|
|
|
To perform this operation, you must be authenticated. [Learn more](authentication.md).
|
|
|
|
## Update check
|
|
|
|
### Code samples
|
|
|
|
```sh
|
|
# Example request using curl
|
|
curl -X GET http://coder-server:8080/api/v2/updatecheck \
|
|
-H 'Accept: application/json'
|
|
```
|
|
|
|
`GET /api/v2/updatecheck`
|
|
|
|
### Example responses
|
|
|
|
> 200 Response
|
|
|
|
```json
|
|
{
|
|
"current": true,
|
|
"url": "string",
|
|
"version": "string"
|
|
}
|
|
```
|
|
|
|
### Responses
|
|
|
|
| Status | Meaning | Description | Schema |
|
|
|--------|---------------------------------------------------------|-------------|------------------------------------------------------------------------|
|
|
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.UpdateCheckResponse](schemas.md#codersdkupdatecheckresponse) |
|
|
|
|
## Get token config
|
|
|
|
### Code samples
|
|
|
|
```sh
|
|
# Example request using curl
|
|
curl -X GET http://coder-server:8080/api/v2/users/{user}/keys/tokens/tokenconfig \
|
|
-H 'Accept: application/json' \
|
|
-H 'Coder-Session-Token: API_KEY'
|
|
```
|
|
|
|
`GET /api/v2/users/{user}/keys/tokens/tokenconfig`
|
|
|
|
### Parameters
|
|
|
|
| Name | In | Type | Required | Description |
|
|
|--------|------|--------|----------|----------------------|
|
|
| `user` | path | string | true | User ID, name, or me |
|
|
|
|
### Example responses
|
|
|
|
> 200 Response
|
|
|
|
```json
|
|
{
|
|
"max_token_lifetime": 0
|
|
}
|
|
```
|
|
|
|
### Responses
|
|
|
|
| Status | Meaning | Description | Schema |
|
|
|--------|---------------------------------------------------------|-------------|--------------------------------------------------------|
|
|
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.TokenConfig](schemas.md#codersdktokenconfig) |
|
|
|
|
To perform this operation, you must be authenticated. [Learn more](authentication.md).
|