2022-12-19 17:43:46 +00:00
# Schemas
2023-01-29 21:47:24 +00:00
## agentsdk.AWSInstanceIdentityToken
```json
{
"document": "string",
"signature": "string"
}
```
### Properties
| Name | Type | Required | Restrictions | Description |
| ----------- | ------ | -------- | ------------ | ----------- |
| `document` | string | true | | |
| `signature` | string | true | | |
2023-04-27 10:34:00 +00:00
## agentsdk.AgentMetric
```json
{
2023-05-25 10:52:36 +00:00
"labels": [
{
"name": "string",
"value": "string"
}
],
2023-04-27 10:34:00 +00:00
"name": "string",
"type": "counter",
"value": 0
}
```
### Properties
2023-05-25 10:52:36 +00:00
| Name | Type | Required | Restrictions | Description |
| -------- | --------------------------------------------------------------- | -------- | ------------ | ----------- |
| `labels` | array of [agentsdk.AgentMetricLabel ](#agentsdkagentmetriclabel ) | false | | |
| `name` | string | true | | |
| `type` | [agentsdk.AgentMetricType ](#agentsdkagentmetrictype ) | true | | |
| `value` | number | true | | |
2023-04-27 10:34:00 +00:00
#### Enumerated Values
| Property | Value |
| -------- | --------- |
| `type` | `counter` |
| `type` | `gauge` |
2023-05-25 10:52:36 +00:00
## agentsdk.AgentMetricLabel
```json
{
"name": "string",
"value": "string"
}
```
### Properties
| Name | Type | Required | Restrictions | Description |
| ------- | ------ | -------- | ------------ | ----------- |
| `name` | string | true | | |
| `value` | string | true | | |
2023-04-27 10:34:00 +00:00
## agentsdk.AgentMetricType
```json
"counter"
```
### Properties
#### Enumerated Values
| Value |
| --------- |
| `counter` |
| `gauge` |
2023-01-29 21:47:24 +00:00
## agentsdk.AuthenticateResponse
```json
{
"session_token": "string"
}
```
### Properties
| Name | Type | Required | Restrictions | Description |
| --------------- | ------ | -------- | ------------ | ----------- |
| `session_token` | string | false | | |
## agentsdk.AzureInstanceIdentityToken
```json
{
"encoding": "string",
"signature": "string"
}
```
### Properties
| Name | Type | Required | Restrictions | Description |
| ----------- | ------ | -------- | ------------ | ----------- |
| `encoding` | string | true | | |
| `signature` | string | true | | |
2023-10-09 23:04:35 +00:00
## agentsdk.ExternalAuthResponse
2023-01-29 21:47:24 +00:00
```json
{
2023-10-09 23:04:35 +00:00
"access_token": "string",
2023-01-29 21:47:24 +00:00
"password": "string",
2023-10-10 04:02:16 +00:00
"token_extra": {},
2023-10-09 23:04:35 +00:00
"type": "string",
2023-01-29 21:47:24 +00:00
"url": "string",
"username": "string"
}
```
### Properties
2023-10-09 23:04:35 +00:00
| Name | Type | Required | Restrictions | Description |
| -------------- | ------ | -------- | ------------ | ---------------------------------------------------------------------------------------- |
| `access_token` | string | false | | |
| `password` | string | false | | |
2023-10-10 04:02:16 +00:00
| `token_extra` | object | false | | |
2023-10-09 23:04:35 +00:00
| `type` | string | false | | |
| `url` | string | false | | |
| `username` | string | false | | Deprecated: Only supported on `/workspaceagents/me/gitauth` for backwards compatibility. |
2023-01-29 21:47:24 +00:00
## agentsdk.GitSSHKey
```json
{
"private_key": "string",
"public_key": "string"
}
```
### Properties
| Name | Type | Required | Restrictions | Description |
| ------------- | ------ | -------- | ------------ | ----------- |
| `private_key` | string | false | | |
| `public_key` | string | false | | |
## agentsdk.GoogleInstanceIdentityToken
```json
{
"json_web_token": "string"
}
```
### Properties
| Name | Type | Required | Restrictions | Description |
| ---------------- | ------ | -------- | ------------ | ----------- |
| `json_web_token` | string | true | | |
2023-07-28 15:57:23 +00:00
## agentsdk.Log
```json
{
"created_at": "string",
"level": "trace",
2023-09-25 21:47:17 +00:00
"output": "string"
2023-07-28 15:57:23 +00:00
}
```
### Properties
2023-09-25 21:47:17 +00:00
| Name | Type | Required | Restrictions | Description |
| ------------ | -------------------------------------- | -------- | ------------ | ----------- |
| `created_at` | string | false | | |
| `level` | [codersdk.LogLevel ](#codersdkloglevel ) | false | | |
| `output` | string | false | | |
2023-07-28 15:57:23 +00:00
2023-03-31 20:26:19 +00:00
## agentsdk.Manifest
2023-01-29 21:47:24 +00:00
```json
{
2023-07-12 22:37:31 +00:00
"agent_id": "string",
2024-01-02 18:46:18 +00:00
"agent_name": "string",
2023-01-29 21:47:24 +00:00
"apps": [
{
"command": "string",
"display_name": "string",
"external": true,
"health": "disabled",
"healthcheck": {
"interval": 0,
"threshold": 0,
"url": "string"
},
"icon": "string",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"sharing_level": "owner",
"slug": "string",
"subdomain": true,
2023-09-12 13:25:10 +00:00
"subdomain_name": "string",
2023-01-29 21:47:24 +00:00
"url": "string"
}
],
2023-08-24 17:22:31 +00:00
"derp_force_websockets": true,
2023-01-29 21:47:24 +00:00
"derpmap": {
2023-08-09 19:50:26 +00:00
"homeParams": {
"regionScore": {
"property1": 0,
"property2": 0
}
},
2023-01-29 21:47:24 +00:00
"omitDefaultRegions": true,
"regions": {
"property1": {
"avoid": true,
"embeddedRelay": true,
"nodes": [
{
2023-08-09 19:50:26 +00:00
"canPort80": true,
2023-01-29 21:47:24 +00:00
"certName": "string",
"derpport": 0,
"forceHTTP": true,
"hostName": "string",
"insecureForTests": true,
"ipv4": "string",
"ipv6": "string",
"name": "string",
"regionID": 0,
"stunonly": true,
"stunport": 0,
"stuntestIP": "string"
}
],
"regionCode": "string",
"regionID": 0,
"regionName": "string"
},
"property2": {
"avoid": true,
"embeddedRelay": true,
"nodes": [
{
2023-08-09 19:50:26 +00:00
"canPort80": true,
2023-01-29 21:47:24 +00:00
"certName": "string",
"derpport": 0,
"forceHTTP": true,
"hostName": "string",
"insecureForTests": true,
"ipv4": "string",
"ipv6": "string",
"name": "string",
"regionID": 0,
"stunonly": true,
"stunport": 0,
"stuntestIP": "string"
}
],
"regionCode": "string",
"regionID": 0,
"regionName": "string"
}
}
},
"directory": "string",
2023-06-21 22:02:05 +00:00
"disable_direct_connections": true,
2023-01-29 21:47:24 +00:00
"environment_variables": {
"property1": "string",
"property2": "string"
},
"git_auth_configs": 0,
2023-03-31 20:26:19 +00:00
"metadata": [
{
"display_name": "string",
"interval": 0,
"key": "string",
"script": "string",
"timeout": 0
}
],
2023-01-29 21:47:24 +00:00
"motd_file": "string",
2023-12-03 21:41:54 +00:00
"owner_name": "string",
2023-09-25 21:47:17 +00:00
"scripts": [
{
"cron": "string",
"log_path": "string",
"log_source_id": "4197ab25-95cf-4b91-9c78-f7f2af5d353a",
"run_on_start": true,
"run_on_stop": true,
"script": "string",
"start_blocks_login": true,
"timeout": 0
}
],
2023-12-03 21:41:54 +00:00
"vscode_port_proxy_uri": "string",
2024-01-02 18:46:18 +00:00
"workspace_id": "string",
"workspace_name": "string"
2023-01-29 21:47:24 +00:00
}
```
### Properties
2023-12-03 21:41:54 +00:00
| Name | Type | Required | Restrictions | Description |
| ---------------------------- | ------------------------------------------------------------------------------------------------- | -------- | ------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `agent_id` | string | false | | |
2024-01-02 18:46:18 +00:00
| `agent_name` | string | false | | |
2023-12-03 21:41:54 +00:00
| `apps` | array of [codersdk.WorkspaceApp ](#codersdkworkspaceapp ) | false | | |
| `derp_force_websockets` | boolean | false | | |
| `derpmap` | [tailcfg.DERPMap ](#tailcfgderpmap ) | false | | |
| `directory` | string | false | | |
| `disable_direct_connections` | boolean | false | | |
| `environment_variables` | object | false | | |
| » `[any property]` | string | false | | |
| `git_auth_configs` | integer | false | | Git auth configs stores the number of Git configurations the Coder deployment has. If this number is >0, we set up special configuration in the workspace. |
| `metadata` | array of [codersdk.WorkspaceAgentMetadataDescription ](#codersdkworkspaceagentmetadatadescription ) | false | | |
| `motd_file` | string | false | | |
| `owner_name` | string | false | | Owner name and WorkspaceID are used by an open-source user to identify the workspace. We do not provide insurance that this will not be removed in the future, but if it's easy to persist lets keep it around. |
| `scripts` | array of [codersdk.WorkspaceAgentScript ](#codersdkworkspaceagentscript ) | false | | |
| `vscode_port_proxy_uri` | string | false | | |
| `workspace_id` | string | false | | |
2024-01-02 18:46:18 +00:00
| `workspace_name` | string | false | | |
2023-01-29 21:47:24 +00:00
2023-10-13 13:37:55 +00:00
## agentsdk.Metadata
```json
{
"age": 0,
"collected_at": "2019-08-24T14:15:22Z",
"error": "string",
"key": "string",
"value": "string"
}
```
### Properties
| Name | Type | Required | Restrictions | Description |
| -------------- | ------- | -------- | ------------ | --------------------------------------------------------------------------------------------------------------------------------------- |
| `age` | integer | false | | Age is the number of seconds since the metadata was collected. It is provided in addition to CollectedAt to protect against clock skew. |
| `collected_at` | string | false | | |
| `error` | string | false | | |
| `key` | string | false | | |
| `value` | string | false | | |
2023-07-28 15:57:23 +00:00
## agentsdk.PatchLogs
2023-03-23 19:09:13 +00:00
```json
{
2023-09-25 21:47:17 +00:00
"log_source_id": "string",
2023-03-23 19:09:13 +00:00
"logs": [
{
"created_at": "string",
2023-04-10 19:29:59 +00:00
"level": "trace",
2023-09-25 21:47:17 +00:00
"output": "string"
2023-03-23 19:09:13 +00:00
}
]
}
```
### Properties
2023-09-25 21:47:17 +00:00
| Name | Type | Required | Restrictions | Description |
| --------------- | ------------------------------------- | -------- | ------------ | ----------- |
| `log_source_id` | string | false | | |
| `logs` | array of [agentsdk.Log ](#agentsdklog ) | false | | |
2023-03-23 19:09:13 +00:00
2023-01-29 21:47:24 +00:00
## agentsdk.PostAppHealthsRequest
```json
{
"healths": {
"property1": "disabled",
"property2": "disabled"
}
}
```
### Properties
| Name | Type | Required | Restrictions | Description |
| ------------------ | ---------------------------------------------------------- | -------- | ------------ | --------------------------------------------------------------------- |
| `healths` | object | false | | Healths is a map of the workspace app name and the health of the app. |
| » `[any property]` | [codersdk.WorkspaceAppHealth ](#codersdkworkspaceapphealth ) | false | | |
## agentsdk.PostLifecycleRequest
```json
{
2023-06-20 11:41:55 +00:00
"changed_at": "string",
2023-01-29 21:47:24 +00:00
"state": "created"
}
```
### Properties
2023-06-20 11:41:55 +00:00
| Name | Type | Required | Restrictions | Description |
| ------------ | -------------------------------------------------------------------- | -------- | ------------ | ----------- |
| `changed_at` | string | false | | |
| `state` | [codersdk.WorkspaceAgentLifecycle ](#codersdkworkspaceagentlifecycle ) | false | | |
2023-01-29 21:47:24 +00:00
2023-03-31 20:26:19 +00:00
## agentsdk.PostMetadataRequest
2023-10-13 13:37:55 +00:00
```json
{
"metadata": [
{
"age": 0,
"collected_at": "2019-08-24T14:15:22Z",
"error": "string",
"key": "string",
"value": "string"
}
]
}
```
### Properties
| Name | Type | Required | Restrictions | Description |
| ---------- | ----------------------------------------------- | -------- | ------------ | ----------- |
| `metadata` | array of [agentsdk.Metadata ](#agentsdkmetadata ) | false | | |
## agentsdk.PostMetadataRequestDeprecated
2023-03-31 20:26:19 +00:00
```json
{
"age": 0,
"collected_at": "2019-08-24T14:15:22Z",
"error": "string",
"value": "string"
}
```
### Properties
| Name | Type | Required | Restrictions | Description |
| -------------- | ------- | -------- | ------------ | --------------------------------------------------------------------------------------------------------------------------------------- |
| `age` | integer | false | | Age is the number of seconds since the metadata was collected. It is provided in addition to CollectedAt to protect against clock skew. |
| `collected_at` | string | false | | |
| `error` | string | false | | |
| `value` | string | false | | |
2023-02-07 21:35:09 +00:00
## agentsdk.PostStartupRequest
2023-01-29 21:47:24 +00:00
```json
{
2023-02-07 21:35:09 +00:00
"expanded_directory": "string",
2023-08-09 05:10:28 +00:00
"subsystems": ["envbox"],
2023-01-29 21:47:24 +00:00
"version": "string"
}
```
### Properties
2023-08-09 05:10:28 +00:00
| Name | Type | Required | Restrictions | Description |
| -------------------- | ----------------------------------------------------------- | -------- | ------------ | ----------- |
| `expanded_directory` | string | false | | |
| `subsystems` | array of [codersdk.AgentSubsystem ](#codersdkagentsubsystem ) | false | | |
| `version` | string | false | | |
2023-01-29 21:47:24 +00:00
## agentsdk.Stats
```json
{
2023-03-02 14:06:00 +00:00
"connection_count": 0,
"connection_median_latency_ms": 0,
"connections_by_proto": {
2023-01-29 21:47:24 +00:00
"property1": 0,
"property2": 0
},
2023-04-27 10:34:00 +00:00
"metrics": [
{
2023-05-25 10:52:36 +00:00
"labels": [
{
"name": "string",
"value": "string"
}
],
2023-04-27 10:34:00 +00:00
"name": "string",
"type": "counter",
"value": 0
}
],
2023-01-29 21:47:24 +00:00
"rx_bytes": 0,
"rx_packets": 0,
2023-03-02 14:06:00 +00:00
"session_count_jetbrains": 0,
"session_count_reconnecting_pty": 0,
"session_count_ssh": 0,
"session_count_vscode": 0,
2023-01-29 21:47:24 +00:00
"tx_bytes": 0,
"tx_packets": 0
}
```
### Properties
2023-04-27 10:34:00 +00:00
| Name | Type | Required | Restrictions | Description |
| -------------------------------- | ----------------------------------------------------- | -------- | ------------ | ----------------------------------------------------------------------------------------------------------------------------- |
| `connection_count` | integer | false | | Connection count is the number of connections received by an agent. |
| `connection_median_latency_ms` | number | false | | Connection median latency ms is the median latency of all connections in milliseconds. |
| `connections_by_proto` | object | false | | Connections by proto is a count of connections by protocol. |
| » `[any property]` | integer | false | | |
| `metrics` | array of [agentsdk.AgentMetric ](#agentsdkagentmetric ) | false | | Metrics collected by the agent |
| `rx_bytes` | integer | false | | Rx bytes is the number of received bytes. |
| `rx_packets` | integer | false | | Rx packets is the number of received packets. |
| `session_count_jetbrains` | integer | false | | Session count jetbrains is the number of connections received by an agent that are from our JetBrains extension. |
| `session_count_reconnecting_pty` | integer | false | | Session count reconnecting pty is the number of connections received by an agent that are from the reconnecting web terminal. |
| `session_count_ssh` | integer | false | | Session count ssh is the number of connections received by an agent that are normal, non-tagged SSH sessions. |
| `session_count_vscode` | integer | false | | Session count vscode is the number of connections received by an agent that are from our VS Code extension. |
| `tx_bytes` | integer | false | | Tx bytes is the number of transmitted bytes. |
| `tx_packets` | integer | false | | Tx packets is the number of transmitted bytes. |
2023-01-29 21:47:24 +00:00
## agentsdk.StatsResponse
```json
{
"report_interval": 0
}
```
### Properties
| Name | Type | Required | Restrictions | Description |
| ----------------- | ------- | -------- | ------------ | ------------------------------------------------------------------------------ |
| `report_interval` | integer | false | | Report interval is the duration after which the agent should send stats again. |
2023-03-07 21:10:01 +00:00
## clibase.Annotations
```json
{
"property1": "string",
"property2": "string"
}
```
### Properties
| Name | Type | Required | Restrictions | Description |
| ---------------- | ------ | -------- | ------------ | ----------- |
| `[any property]` | string | false | | |
## clibase.Group
```json
{
"description": "string",
"name": "string",
"parent": {
"description": "string",
"name": "string",
2023-04-07 22:58:21 +00:00
"parent": {},
"yaml": "string"
},
"yaml": "string"
2023-03-07 21:10:01 +00:00
}
```
### Properties
2023-04-07 22:58:21 +00:00
| Name | Type | Required | Restrictions | Description |
| ------------- | ------------------------------ | -------- | ------------ | ----------- |
| `description` | string | false | | |
| `name` | string | false | | |
| `parent` | [clibase.Group ](#clibasegroup ) | false | | |
| `yaml` | string | false | | |
2023-03-07 21:10:01 +00:00
## clibase.HostPort
```json
{
"host": "string",
"port": "string"
}
```
### Properties
| Name | Type | Required | Restrictions | Description |
| ------ | ------ | -------- | ------------ | ----------- |
| `host` | string | false | | |
| `port` | string | false | | |
## clibase.Option
```json
{
"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",
2023-04-07 22:58:21 +00:00
"parent": {},
"yaml": "string"
},
"yaml": "string"
2023-03-07 21:10:01 +00:00
},
"hidden": true,
"name": "string",
2023-07-11 13:59:55 +00:00
"required": true,
2023-03-07 21:10:01 +00:00
"use_instead": [
{
"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",
2023-04-07 22:58:21 +00:00
"parent": {},
"yaml": "string"
},
"yaml": "string"
2023-03-07 21:10:01 +00:00
},
"hidden": true,
"name": "string",
2023-07-11 13:59:55 +00:00
"required": true,
2023-03-07 21:10:01 +00:00
"use_instead": [],
"value": null,
2023-04-07 22:58:21 +00:00
"value_source": "",
2023-03-07 21:10:01 +00:00
"yaml": "string"
}
],
"value": null,
2023-04-07 22:58:21 +00:00
"value_source": "",
2023-03-07 21:10:01 +00:00
"yaml": "string"
}
```
### Properties
2023-07-11 13:59:55 +00:00
| Name | Type | Required | Restrictions | Description |
| ---------------- | ------------------------------------------ | -------- | ------------ | -------------------------------------------------------------------------------------------------------------------------------------------------- |
| `annotations` | [clibase.Annotations ](#clibaseannotations ) | false | | Annotations enable extensions to clibase higher up in the stack. It's useful for help formatting and documentation generation. |
| `default` | string | false | | Default is parsed into Value if set. |
| `description` | string | false | | |
| `env` | string | false | | Env is the environment variable used to configure this option. If unset, environment configuring is disabled. |
| `flag` | string | false | | Flag is the long name of the flag used to configure this option. If unset, flag configuring is disabled. |
| `flag_shorthand` | string | false | | Flag shorthand is the one-character shorthand for the flag. If unset, no shorthand is used. |
| `group` | [clibase.Group ](#clibasegroup ) | false | | Group is a group hierarchy that helps organize this option in help, configs and other documentation. |
| `hidden` | boolean | false | | |
| `name` | string | false | | |
| `required` | boolean | false | | Required means this value must be set by some means. It requires `ValueSource != ValueSourceNone` If `Default` is set, then `Required` is ignored. |
| `use_instead` | array of [clibase.Option ](#clibaseoption ) | false | | Use instead is a list of options that should be used instead of this one. The field is used to generate a deprecation warning. |
| `value` | any | false | | Value includes the types listed in values.go. |
| `value_source` | [clibase.ValueSource ](#clibasevaluesource ) | false | | |
| `yaml` | string | false | | Yaml is the YAML key used to configure this option. If unset, YAML configuring is disabled. |
2023-03-07 21:10:01 +00:00
2023-08-08 16:37:49 +00:00
## clibase.Regexp
```json
{}
```
### Properties
_None_
2023-10-03 14:04:39 +00:00
## clibase.Struct-array_codersdk_ExternalAuthConfig
2023-03-07 21:10:01 +00:00
```json
{
"value": [
{
2023-06-29 18:58:01 +00:00
"app_install_url": "string",
"app_installations_url": "string",
2023-03-07 21:10:01 +00:00
"auth_url": "string",
"client_id": "string",
2023-06-29 18:58:01 +00:00
"device_code_url": "string",
"device_flow": true,
2023-10-03 14:04:39 +00:00
"display_icon": "string",
"display_name": "string",
2023-10-09 23:49:30 +00:00
"extra_token_keys": ["string"],
2023-03-07 21:10:01 +00:00
"id": "string",
"no_refresh": true,
"regex": "string",
"scopes": ["string"],
"token_url": "string",
"type": "string",
"validate_url": "string"
}
]
}
```
### Properties
2023-10-03 14:04:39 +00:00
| Name | Type | Required | Restrictions | Description |
| ------- | ------------------------------------------------------------------- | -------- | ------------ | ----------- |
| `value` | array of [codersdk.ExternalAuthConfig ](#codersdkexternalauthconfig ) | false | | |
2023-03-07 21:10:01 +00:00
## clibase.Struct-array_codersdk_LinkConfig
```json
{
"value": [
{
2024-01-15 15:56:01 +00:00
"icon": "bug",
2023-03-07 21:10:01 +00:00
"name": "string",
"target": "string"
}
]
}
```
### Properties
| Name | Type | Required | Restrictions | Description |
| ------- | --------------------------------------------------- | -------- | ------------ | ----------- |
| `value` | array of [codersdk.LinkConfig ](#codersdklinkconfig ) | false | | |
## clibase.URL
```json
{
"forceQuery": true,
"fragment": "string",
"host": "string",
"omitHost": true,
"opaque": "string",
"path": "string",
"rawFragment": "string",
"rawPath": "string",
"rawQuery": "string",
"scheme": "string",
"user": {}
}
```
### Properties
| Name | Type | Required | Restrictions | Description |
| ------------- | ---------------------------- | -------- | ------------ | -------------------------------------------------- |
| `forceQuery` | boolean | false | | append a query ('?') even if RawQuery is empty |
| `fragment` | string | false | | fragment for references, without '#' |
| `host` | string | false | | host or host:port |
| `omitHost` | boolean | false | | do not emit empty host (authority) |
| `opaque` | string | false | | encoded opaque data |
| `path` | string | false | | path (relative paths may omit leading slash) |
| `rawFragment` | string | false | | encoded fragment hint (see EscapedFragment method) |
| `rawPath` | string | false | | encoded path hint (see EscapedPath method) |
| `rawQuery` | string | false | | encoded query values, without '?' |
| `scheme` | string | false | | |
| `user` | [url.Userinfo ](#urluserinfo ) | false | | username and password information |
2023-04-07 22:58:21 +00:00
## clibase.ValueSource
```json
""
```
### Properties
#### Enumerated Values
| Value |
| --------- |
| `` |
| `flag` |
| `env` |
| `yaml` |
| `default` |
2023-01-11 15:05:42 +00:00
## coderd.SCIMUser
```json
{
"active": true,
"emails": [
{
"display": "string",
"primary": true,
"type": "string",
"value": "user@example.com"
}
],
"groups": [null],
"id": "string",
"meta": {
"resourceType": "string"
},
"name": {
"familyName": "string",
"givenName": "string"
},
"schemas": ["string"],
"userName": "string"
}
```
### Properties
| Name | Type | Required | Restrictions | Description |
| ---------------- | ------------------ | -------- | ------------ | ----------- |
| `active` | boolean | false | | |
| `emails` | array of object | false | | |
| `» display` | string | false | | |
| `» primary` | boolean | false | | |
| `» type` | string | false | | |
| `» value` | string | false | | |
| `groups` | array of undefined | false | | |
| `id` | string | false | | |
| `meta` | object | false | | |
| `» resourceType` | string | false | | |
| `name` | object | false | | |
| `» familyName` | string | false | | |
| `» givenName` | string | false | | |
| `schemas` | array of string | false | | |
| `userName` | string | false | | |
2022-12-22 14:53:14 +00:00
## coderd.cspViolation
```json
{
"csp-report": {}
}
```
### Properties
| Name | Type | Required | Restrictions | Description |
| ------------ | ------ | -------- | ------------ | ----------- |
| `csp-report` | object | false | | |
2023-07-26 14:33:48 +00:00
## codersdk.ACLAvailable
```json
{
"groups": [
{
"avatar_url": "string",
2023-08-02 15:53:06 +00:00
"display_name": "string",
2023-07-26 14:33:48 +00:00
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"members": [
{
"avatar_url": "http://example.com",
"created_at": "2019-08-24T14:15:22Z",
"email": "user@example.com",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"last_seen_at": "2019-08-24T14:15:22Z",
2023-08-11 01:04:35 +00:00
"login_type": "",
2024-01-17 12:20:45 +00:00
"name": "string",
2023-07-26 14:33:48 +00:00
"organization_ids": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"],
"roles": [
{
"display_name": "string",
"name": "string"
}
],
"status": "active",
2023-12-14 17:38:44 +00:00
"theme_preference": "string",
2023-07-26 14:33:48 +00:00
"username": "string"
}
],
"name": "string",
"organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
2023-08-08 16:37:49 +00:00
"quota_allowance": 0,
"source": "user"
2023-07-26 14:33:48 +00:00
}
],
"users": [
{
"avatar_url": "http://example.com",
"created_at": "2019-08-24T14:15:22Z",
"email": "user@example.com",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"last_seen_at": "2019-08-24T14:15:22Z",
2023-08-11 01:04:35 +00:00
"login_type": "",
2024-01-17 12:20:45 +00:00
"name": "string",
2023-07-26 14:33:48 +00:00
"organization_ids": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"],
"roles": [
{
"display_name": "string",
"name": "string"
}
],
"status": "active",
2023-12-14 17:38:44 +00:00
"theme_preference": "string",
2023-07-26 14:33:48 +00:00
"username": "string"
}
]
}
```
### Properties
| Name | Type | Required | Restrictions | Description |
| -------- | ----------------------------------------- | -------- | ------------ | ----------- |
| `groups` | array of [codersdk.Group ](#codersdkgroup ) | false | | |
| `users` | array of [codersdk.User ](#codersdkuser ) | false | | |
2023-01-11 13:08:04 +00:00
## codersdk.APIKey
```json
{
"created_at": "2019-08-24T14:15:22Z",
"expires_at": "2019-08-24T14:15:22Z",
"id": "string",
"last_used": "2019-08-24T14:15:22Z",
"lifetime_seconds": 0,
"login_type": "password",
"scope": "all",
2023-03-02 17:39:38 +00:00
"token_name": "string",
2023-01-11 13:08:04 +00:00
"updated_at": "2019-08-24T14:15:22Z",
"user_id": "a169451c-8525-4352-b8ca-070dd449a1a5"
}
```
### Properties
2023-01-11 15:05:42 +00:00
| Name | Type | Required | Restrictions | Description |
| ------------------ | -------------------------------------------- | -------- | ------------ | ----------- |
| `created_at` | string | true | | |
| `expires_at` | string | true | | |
| `id` | string | true | | |
| `last_used` | string | true | | |
| `lifetime_seconds` | integer | true | | |
| `login_type` | [codersdk.LoginType ](#codersdklogintype ) | true | | |
| `scope` | [codersdk.APIKeyScope ](#codersdkapikeyscope ) | true | | |
2023-03-02 17:39:38 +00:00
| `token_name` | string | true | | |
2023-01-11 15:05:42 +00:00
| `updated_at` | string | true | | |
| `user_id` | string | true | | |
2023-01-11 13:08:04 +00:00
#### Enumerated Values
| Property | Value |
| ------------ | --------------------- |
| `login_type` | `password` |
| `login_type` | `github` |
| `login_type` | `oidc` |
| `login_type` | `token` |
| `scope` | `all` |
| `scope` | `application_connect` |
## codersdk.APIKeyScope
```json
"all"
```
### Properties
#### Enumerated Values
| Value |
| --------------------- |
| `all` |
| `application_connect` |
2023-01-11 15:05:42 +00:00
## codersdk.AddLicenseRequest
```json
{
"license": "string"
}
2023-01-29 21:47:24 +00:00
```
### Properties
| Name | Type | Required | Restrictions | Description |
| --------- | ------ | -------- | ------------ | ----------- |
| `license` | string | true | | |
2023-01-05 14:27:10 +00:00
2023-05-18 03:49:25 +00:00
## codersdk.AgentSubsystem
```json
"envbox"
```
### Properties
#### Enumerated Values
2023-08-09 05:10:28 +00:00
| Value |
| ------------ |
| `envbox` |
| `envbuilder` |
| `exectrace` |
2023-05-18 03:49:25 +00:00
2023-01-29 21:47:24 +00:00
## codersdk.AppHostResponse
2023-01-05 14:27:10 +00:00
```json
{
2023-01-29 21:47:24 +00:00
"host": "string"
2023-01-05 14:27:10 +00:00
}
```
### Properties
2023-01-29 21:47:24 +00:00
| Name | Type | Required | Restrictions | Description |
| ------ | ------ | -------- | ------------ | ------------------------------------------------------------- |
| `host` | string | false | | Host is the externally accessible URL for the Coder instance. |
2023-01-05 14:27:10 +00:00
2023-01-11 15:05:42 +00:00
## codersdk.AppearanceConfig
```json
{
2023-09-27 15:02:18 +00:00
"application_name": "string",
2023-01-11 15:05:42 +00:00
"logo_url": "string",
"service_banner": {
"background_color": "string",
"enabled": true,
"message": "string"
2023-02-27 08:25:04 +00:00
},
"support_links": [
{
2024-01-15 15:56:01 +00:00
"icon": "bug",
2023-02-27 08:25:04 +00:00
"name": "string",
"target": "string"
}
]
2023-01-11 15:05:42 +00:00
}
```
### Properties
2023-09-27 15:02:18 +00:00
| Name | Type | Required | Restrictions | Description |
| ------------------ | ------------------------------------------------------------ | -------- | ------------ | ----------- |
| `application_name` | string | false | | |
| `logo_url` | string | false | | |
| `service_banner` | [codersdk.ServiceBannerConfig ](#codersdkservicebannerconfig ) | false | | |
| `support_links` | array of [codersdk.LinkConfig ](#codersdklinkconfig ) | false | | |
2023-01-11 15:05:42 +00:00
2023-10-11 14:26:22 +00:00
## codersdk.ArchiveTemplateVersionsRequest
```json
{
"all": true
}
```
### Properties
| Name | Type | Required | Restrictions | Description |
| ----- | ------- | -------- | ------------ | ------------------------------------------------------------------------------------------------------------------------ |
| `all` | boolean | false | | By default, only failed versions are archived. Set this to true to archive all unused versions regardless of job status. |
2023-01-11 11:16:09 +00:00
## codersdk.AssignableRoles
```json
{
"assignable": true,
"display_name": "string",
"name": "string"
}
```
### Properties
| Name | Type | Required | Restrictions | Description |
| -------------- | ------- | -------- | ------------ | ----------- |
| `assignable` | boolean | false | | |
| `display_name` | string | false | | |
| `name` | string | false | | |
2023-01-10 14:47:08 +00:00
## codersdk.AuditAction
```json
"create"
```
### Properties
#### Enumerated Values
2023-04-12 18:46:16 +00:00
| Value |
| ---------- |
| `create` |
| `write` |
| `delete` |
| `start` |
| `stop` |
| `login` |
| `logout` |
| `register` |
2023-01-10 14:47:08 +00:00
2023-01-03 18:21:10 +00:00
## codersdk.AuditDiff
```json
{
"property1": {
"new": null,
"old": null,
"secret": true
},
"property2": {
"new": null,
"old": null,
"secret": true
}
}
```
### Properties
| Name | Type | Required | Restrictions | Description |
| ---------------- | -------------------------------------------------- | -------- | ------------ | ----------- |
| `[any property]` | [codersdk.AuditDiffField ](#codersdkauditdifffield ) | false | | |
## codersdk.AuditDiffField
```json
{
"new": null,
"old": null,
"secret": true
}
```
### Properties
| Name | Type | Required | Restrictions | Description |
| -------- | ------- | -------- | ------------ | ----------- |
| `new` | any | false | | |
| `old` | any | false | | |
| `secret` | boolean | false | | |
## codersdk.AuditLog
```json
{
2023-01-10 14:47:08 +00:00
"action": "create",
2023-01-03 18:21:10 +00:00
"additional_fields": [0],
"description": "string",
"diff": {
"property1": {
"new": null,
"old": null,
"secret": true
},
"property2": {
"new": null,
"old": null,
"secret": true
}
},
2023-01-13 11:27:21 +00:00
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
2023-01-10 14:47:08 +00:00
"ip": "string",
2023-01-03 18:21:10 +00:00
"is_deleted": true,
2023-01-13 11:27:21 +00:00
"organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
"request_id": "266ea41d-adf5-480b-af50-15b940c2b846",
2023-01-03 18:21:10 +00:00
"resource_icon": "string",
2023-01-13 11:27:21 +00:00
"resource_id": "4d5215ed-38bb-48ed-879a-fdb9ca58522f",
2023-01-03 18:21:10 +00:00
"resource_link": "string",
"resource_target": "string",
2023-01-26 23:14:09 +00:00
"resource_type": "template",
2023-01-03 18:21:10 +00:00
"status_code": 0,
2023-01-13 11:27:21 +00:00
"time": "2019-08-24T14:15:22Z",
2023-01-03 18:21:10 +00:00
"user": {
2023-01-11 11:16:09 +00:00
"avatar_url": "http://example.com",
"created_at": "2019-08-24T14:15:22Z",
2023-01-11 13:08:04 +00:00
"email": "user@example.com",
2023-01-11 11:16:09 +00:00
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"last_seen_at": "2019-08-24T14:15:22Z",
2023-08-11 01:04:35 +00:00
"login_type": "",
2024-01-17 12:20:45 +00:00
"name": "string",
2023-01-11 11:16:09 +00:00
"organization_ids": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"],
2023-01-03 18:21:10 +00:00
"roles": [
{
"display_name": "string",
"name": "string"
}
],
2023-01-10 14:47:08 +00:00
"status": "active",
2023-12-14 17:38:44 +00:00
"theme_preference": "string",
2023-01-03 18:21:10 +00:00
"username": "string"
},
"user_agent": "string"
}
```
### Properties
2023-01-10 14:47:08 +00:00
| Name | Type | Required | Restrictions | Description |
| ------------------- | ---------------------------------------------- | -------- | ------------ | -------------------------------------------- |
| `action` | [codersdk.AuditAction ](#codersdkauditaction ) | false | | |
| `additional_fields` | array of integer | false | | |
| `description` | string | false | | |
| `diff` | [codersdk.AuditDiff ](#codersdkauditdiff ) | false | | |
| `id` | string | false | | |
| `ip` | string | false | | |
| `is_deleted` | boolean | false | | |
| `organization_id` | string | false | | |
| `request_id` | string | false | | |
| `resource_icon` | string | false | | |
| `resource_id` | string | false | | |
| `resource_link` | string | false | | |
| `resource_target` | string | false | | Resource target is the name of the resource. |
| `resource_type` | [codersdk.ResourceType ](#codersdkresourcetype ) | false | | |
| `status_code` | integer | false | | |
| `time` | string | false | | |
| `user` | [codersdk.User ](#codersdkuser ) | false | | |
| `user_agent` | string | false | | |
2023-01-03 18:21:10 +00:00
## codersdk.AuditLogResponse
```json
{
"audit_logs": [
{
2023-01-10 14:47:08 +00:00
"action": "create",
2023-01-03 18:21:10 +00:00
"additional_fields": [0],
"description": "string",
"diff": {
"property1": {
"new": null,
"old": null,
"secret": true
},
"property2": {
"new": null,
"old": null,
"secret": true
}
},
2023-01-13 11:27:21 +00:00
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
2023-01-10 14:47:08 +00:00
"ip": "string",
2023-01-03 18:21:10 +00:00
"is_deleted": true,
2023-01-13 11:27:21 +00:00
"organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
"request_id": "266ea41d-adf5-480b-af50-15b940c2b846",
2023-01-03 18:21:10 +00:00
"resource_icon": "string",
2023-01-13 11:27:21 +00:00
"resource_id": "4d5215ed-38bb-48ed-879a-fdb9ca58522f",
2023-01-03 18:21:10 +00:00
"resource_link": "string",
"resource_target": "string",
2023-01-26 23:14:09 +00:00
"resource_type": "template",
2023-01-03 18:21:10 +00:00
"status_code": 0,
2023-01-13 11:27:21 +00:00
"time": "2019-08-24T14:15:22Z",
2023-01-03 18:21:10 +00:00
"user": {
2023-01-11 11:16:09 +00:00
"avatar_url": "http://example.com",
"created_at": "2019-08-24T14:15:22Z",
2023-01-11 13:08:04 +00:00
"email": "user@example.com",
2023-01-11 11:16:09 +00:00
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"last_seen_at": "2019-08-24T14:15:22Z",
2023-08-11 01:04:35 +00:00
"login_type": "",
2024-01-17 12:20:45 +00:00
"name": "string",
2023-01-11 11:16:09 +00:00
"organization_ids": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"],
2023-01-03 18:21:10 +00:00
"roles": [
{
"display_name": "string",
"name": "string"
}
],
2023-01-10 14:47:08 +00:00
"status": "active",
2023-12-14 17:38:44 +00:00
"theme_preference": "string",
2023-01-03 18:21:10 +00:00
"username": "string"
},
"user_agent": "string"
}
],
"count": 0
}
```
### Properties
| Name | Type | Required | Restrictions | Description |
| ------------ | ----------------------------------------------- | -------- | ------------ | ----------- |
| `audit_logs` | array of [codersdk.AuditLog ](#codersdkauditlog ) | false | | |
| `count` | integer | false | | |
2023-01-31 18:33:25 +00:00
## codersdk.AuthMethod
```json
{
"enabled": true
}
```
### Properties
| Name | Type | Required | Restrictions | Description |
| --------- | ------- | -------- | ------------ | ----------- |
| `enabled` | boolean | false | | |
2023-01-11 13:08:04 +00:00
## codersdk.AuthMethods
```json
{
2023-01-31 18:33:25 +00:00
"github": {
"enabled": true
},
"oidc": {
"enabled": true,
"iconUrl": "string",
"signInText": "string"
},
"password": {
"enabled": true
}
2023-01-11 13:08:04 +00:00
}
```
### Properties
2023-07-31 15:30:34 +00:00
| Name | Type | Required | Restrictions | Description |
| ---------- | -------------------------------------------------- | -------- | ------------ | ----------- |
| `github` | [codersdk.AuthMethod ](#codersdkauthmethod ) | false | | |
| `oidc` | [codersdk.OIDCAuthMethod ](#codersdkoidcauthmethod ) | false | | |
| `password` | [codersdk.AuthMethod ](#codersdkauthmethod ) | false | | |
2023-01-11 13:08:04 +00:00
2022-12-21 14:37:30 +00:00
## codersdk.AuthorizationCheck
```json
{
"action": "create",
"object": {
"organization_id": "string",
"owner_id": "string",
"resource_id": "string",
2023-04-11 13:57:23 +00:00
"resource_type": "workspace"
2022-12-21 14:37:30 +00:00
}
}
```
AuthorizationCheck is used to check if the currently authenticated user (or the specified user) can do a given action to a given set of objects.
### Properties
2023-01-10 14:47:08 +00:00
| Name | Type | Required | Restrictions | Description |
| -------- | ------------------------------------------------------------ | -------- | ------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `action` | string | false | | |
| `object` | [codersdk.AuthorizationObject ](#codersdkauthorizationobject ) | false | | Object can represent a "set" of objects, such as: all workspaces in an organization, all workspaces owned by me, and all workspaces across the entire product. When defining an object, use the most specific language when possible to produce the smallest set. Meaning to set as many fields on 'Object' as you can. Example, if you want to check if you can update all workspaces owned by 'me', try to also add an 'OrganizationID' to the settings. Omitting the 'OrganizationID' could produce the incorrect value, as workspaces have both `user` and `organization` owners. |
2022-12-21 14:37:30 +00:00
#### Enumerated Values
2022-12-22 14:53:14 +00:00
| Property | Value |
| -------- | -------- |
| `action` | `create` |
| `action` | `read` |
| `action` | `update` |
| `action` | `delete` |
2022-12-21 14:37:30 +00:00
## codersdk.AuthorizationObject
```json
{
"organization_id": "string",
"owner_id": "string",
"resource_id": "string",
2023-04-11 13:57:23 +00:00
"resource_type": "workspace"
2022-12-21 14:37:30 +00:00
}
```
AuthorizationObject can represent a "set" of objects, such as: all workspaces in an organization, all workspaces owned by me, all workspaces across the entire product.
### Properties
2023-04-11 13:57:23 +00:00
| Name | Type | Required | Restrictions | Description |
| ----------------- | ---------------------------------------------- | -------- | ------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `organization_id` | string | false | | Organization ID (optional) adds the set constraint to all resources owned by a given organization. |
| `owner_id` | string | false | | Owner ID (optional) adds the set constraint to all resources owned by a given user. |
| `resource_id` | string | false | | Resource ID (optional) reduces the set to a singular resource. This assigns a resource ID to the resource type, eg: a single workspace. The rbac library will not fetch the resource from the database, so if you are using this option, you should also set the owner ID and organization ID if possible. Be as specific as possible using all the fields relevant. |
| `resource_type` | [codersdk.RBACResource ](#codersdkrbacresource ) | false | | Resource type is the name of the resource. `./coderd/rbac/object.go` has the list of valid resource types. |
2023-01-03 18:21:10 +00:00
## codersdk.AuthorizationRequest
```json
{
"checks": {
"property1": {
"action": "create",
"object": {
"organization_id": "string",
"owner_id": "string",
"resource_id": "string",
2023-04-11 13:57:23 +00:00
"resource_type": "workspace"
2023-01-03 18:21:10 +00:00
}
},
"property2": {
"action": "create",
"object": {
"organization_id": "string",
"owner_id": "string",
"resource_id": "string",
2023-04-11 13:57:23 +00:00
"resource_type": "workspace"
2023-01-03 18:21:10 +00:00
}
}
}
}
```
### Properties
| Name | Type | Required | Restrictions | Description |
| ------------------ | ---------------------------------------------------------- | -------- | ------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `checks` | object | false | | Checks is a map keyed with an arbitrary string to a permission check. The key can be any string that is helpful to the caller, and allows multiple permission checks to be run in a single request. The key ensures that each permission check has the same key in the response. |
| » `[any property]` | [codersdk.AuthorizationCheck ](#codersdkauthorizationcheck ) | false | | It is used to check if the currently authenticated user (or the specified user) can do a given action to a given set of objects. |
## codersdk.AuthorizationResponse
```json
{
"property1": true,
"property2": true
}
```
### Properties
| Name | Type | Required | Restrictions | Description |
| ---------------- | ------- | -------- | ------------ | ----------- |
| `[any property]` | boolean | false | | |
2023-10-06 09:27:12 +00:00
## codersdk.AutomaticUpdates
```json
"always"
```
### Properties
#### Enumerated Values
| Value |
| -------- |
| `always` |
| `never` |
2023-01-03 18:21:10 +00:00
## codersdk.BuildInfoResponse
```json
{
2023-12-08 08:50:25 +00:00
"agent_api_version": "string",
2023-04-17 19:57:21 +00:00
"dashboard_url": "string",
2023-01-03 18:21:10 +00:00
"external_url": "string",
2024-01-30 23:11:37 +00:00
"upgrade_message": "string",
2023-04-17 19:57:21 +00:00
"version": "string",
"workspace_proxy": true
2023-01-03 18:21:10 +00:00
}
```
### Properties
2023-12-08 08:50:25 +00:00
| Name | Type | Required | Restrictions | Description |
| ------------------- | ------- | -------- | ------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `agent_api_version` | string | false | | Agent api version is the current version of the Agent API (back versions MAY still be supported). |
| `dashboard_url` | string | false | | Dashboard URL is the URL to hit the deployment's dashboard. For external workspace proxies, this is the coderd they are connected to. |
| `external_url` | string | false | | External URL references the current Coder version. For production builds, this will link directly to a release. For development builds, this will link to a commit. |
2024-01-30 23:11:37 +00:00
| `upgrade_message` | string | false | | Upgrade message is the message displayed to users when an outdated client is detected. |
2023-12-08 08:50:25 +00:00
| `version` | string | false | | Version returns the semantic version of the build. |
| `workspace_proxy` | boolean | false | | |
2023-01-03 18:21:10 +00:00
2023-01-10 14:47:08 +00:00
## codersdk.BuildReason
```json
"initiator"
```
### Properties
#### Enumerated Values
| Value |
| ----------- |
| `initiator` |
| `autostart` |
| `autostop` |
2023-07-21 18:00:19 +00:00
## codersdk.ConnectionLatency
```json
{
"p50": 31.312,
"p95": 119.832
}
```
### Properties
| Name | Type | Required | Restrictions | Description |
| ----- | ------ | -------- | ------------ | ----------- |
| `p50` | number | false | | |
| `p95` | number | false | | |
2023-06-30 12:38:48 +00:00
## codersdk.ConvertLoginRequest
```json
{
"password": "string",
2023-08-11 01:04:35 +00:00
"to_type": ""
2023-06-30 12:38:48 +00:00
}
```
### Properties
| Name | Type | Required | Restrictions | Description |
| ---------- | ---------------------------------------- | -------- | ------------ | ---------------------------------------- |
| `password` | string | true | | |
| `to_type` | [codersdk.LoginType ](#codersdklogintype ) | true | | To type is the login type to convert to. |
2023-01-11 13:08:04 +00:00
## codersdk.CreateFirstUserRequest
```json
{
"email": "string",
"password": "string",
"trial": true,
2024-01-17 00:19:16 +00:00
"trial_info": {
"company_name": "string",
"country": "string",
"developers": "string",
"first_name": "string",
"job_title": "string",
"last_name": "string",
"phone_number": "string"
},
2023-01-11 13:08:04 +00:00
"username": "string"
}
```
### Properties
2024-01-17 00:19:16 +00:00
| Name | Type | Required | Restrictions | Description |
| ------------ | ---------------------------------------------------------------------- | -------- | ------------ | ----------- |
| `email` | string | true | | |
| `password` | string | true | | |
| `trial` | boolean | false | | |
| `trial_info` | [codersdk.CreateFirstUserTrialInfo ](#codersdkcreatefirstusertrialinfo ) | false | | |
| `username` | string | true | | |
2023-01-11 13:08:04 +00:00
## codersdk.CreateFirstUserResponse
```json
{
"organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
"user_id": "a169451c-8525-4352-b8ca-070dd449a1a5"
}
```
### Properties
| Name | Type | Required | Restrictions | Description |
| ----------------- | ------ | -------- | ------------ | ----------- |
| `organization_id` | string | false | | |
| `user_id` | string | false | | |
2024-01-17 00:19:16 +00:00
## codersdk.CreateFirstUserTrialInfo
```json
{
"company_name": "string",
"country": "string",
"developers": "string",
"first_name": "string",
"job_title": "string",
"last_name": "string",
"phone_number": "string"
}
```
### Properties
| Name | Type | Required | Restrictions | Description |
| -------------- | ------ | -------- | ------------ | ----------- |
| `company_name` | string | false | | |
| `country` | string | false | | |
| `developers` | string | false | | |
| `first_name` | string | false | | |
| `job_title` | string | false | | |
| `last_name` | string | false | | |
| `phone_number` | string | false | | |
2023-01-11 15:05:42 +00:00
## codersdk.CreateGroupRequest
```json
{
"avatar_url": "string",
2023-08-02 15:53:06 +00:00
"display_name": "string",
2023-01-11 15:05:42 +00:00
"name": "string",
"quota_allowance": 0
}
```
### Properties
| Name | Type | Required | Restrictions | Description |
| ----------------- | ------- | -------- | ------------ | ----------- |
| `avatar_url` | string | false | | |
2023-08-02 15:53:06 +00:00
| `display_name` | string | false | | |
2023-01-11 15:05:42 +00:00
| `name` | string | false | | |
| `quota_allowance` | integer | false | | |
2023-01-11 11:16:09 +00:00
## codersdk.CreateOrganizationRequest
```json
{
"name": "string"
}
```
### Properties
| Name | Type | Required | Restrictions | Description |
| ------ | ------ | -------- | ------------ | ----------- |
| `name` | string | true | | |
2023-01-03 18:21:10 +00:00
## codersdk.CreateTemplateRequest
```json
{
2024-02-13 07:00:35 +00:00
"activity_bump_ms": 0,
2023-04-04 12:48:35 +00:00
"allow_user_autostart": true,
"allow_user_autostop": true,
2023-01-03 18:21:10 +00:00
"allow_user_cancel_workspace_jobs": true,
2023-10-13 16:57:18 +00:00
"autostart_requirement": {
"days_of_week": ["monday"]
},
2023-08-29 18:35:05 +00:00
"autostop_requirement": {
"days_of_week": ["monday"],
"weeks": 0
},
2023-01-03 18:21:10 +00:00
"default_ttl_ms": 0,
2023-08-24 18:25:54 +00:00
"delete_ttl_ms": 0,
2023-01-03 18:21:10 +00:00
"description": "string",
2023-06-14 16:08:58 +00:00
"disable_everyone_group_access": true,
2023-01-03 18:21:10 +00:00
"display_name": "string",
2023-08-24 18:25:54 +00:00
"dormant_ttl_ms": 0,
2023-05-05 15:19:26 +00:00
"failure_ttl_ms": 0,
2023-01-03 18:21:10 +00:00
"icon": "string",
2023-03-07 14:14:58 +00:00
"max_ttl_ms": 0,
2023-01-03 18:21:10 +00:00
"name": "string",
2023-10-18 22:07:21 +00:00
"require_active_version": true,
2023-01-13 11:27:21 +00:00
"template_version_id": "0ba39c92-1f1b-4c32-aa3e-9925d7713eb1"
2023-01-03 18:21:10 +00:00
}
```
### Properties
2023-10-13 16:57:18 +00:00
| Name | Type | Required | Restrictions | Description |
| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------ | -------- | ------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
2024-02-13 07:00:35 +00:00
| `activity_bump_ms` | integer | false | | Activity bump ms allows optionally specifying the activity bump duration for all workspaces created from this template. Defaults to 1h but can be set to 0 to disable activity bumping. |
2023-10-13 16:57:18 +00:00
| `allow_user_autostart` | boolean | false | | Allow user autostart allows users to set a schedule for autostarting their workspace. By default this is true. This can only be disabled when using an enterprise license. |
| `allow_user_autostop` | boolean | false | | Allow user autostop allows users to set a custom workspace TTL to use in place of the template's DefaultTTL field. By default this is true. If false, the DefaultTTL will always be used. This can only be disabled when using an enterprise license. |
| `allow_user_cancel_workspace_jobs` | boolean | false | | Allow users to cancel in-progress workspace jobs. \*bool as the default value is "true". |
| `autostart_requirement` | [codersdk.TemplateAutostartRequirement ](#codersdktemplateautostartrequirement ) | false | | Autostart requirement allows optionally specifying the autostart allowed days for workspaces created from this template. This is an enterprise feature. |
2023-12-15 08:27:56 +00:00
| `autostop_requirement` | [codersdk.TemplateAutostopRequirement ](#codersdktemplateautostoprequirement ) | false | | Autostop requirement allows optionally specifying the autostop requirement for workspaces created from this template. This is an enterprise feature. Only one of MaxTTLMillis or AutostopRequirement can be specified. |
2023-10-13 16:57:18 +00:00
| `default_ttl_ms` | integer | false | | Default ttl ms allows optionally specifying the default TTL for all workspaces created from this template. |
| `delete_ttl_ms` | integer | false | | Delete ttl ms allows optionally specifying the max lifetime before Coder permanently deletes dormant workspaces created from this template. |
| `description` | string | false | | Description is a description of what the template contains. It must be less than 128 bytes. |
| `disable_everyone_group_access` | boolean | false | | Disable everyone group access allows optionally disabling the default behavior of granting the 'everyone' group access to use the template. If this is set to true, the template will not be available to all users, and must be explicitly granted to users or groups in the permissions settings of the template. |
| `display_name` | string | false | | Display name is the displayed name of the template. |
| `dormant_ttl_ms` | integer | false | | Dormant ttl ms allows optionally specifying the max lifetime before Coder locks inactive workspaces created from this template. |
| `failure_ttl_ms` | integer | false | | Failure ttl ms allows optionally specifying the max lifetime before Coder stops all resources for failed workspaces created from this template. |
| `icon` | string | false | | Icon is a relative path or external URL that specifies an icon to be displayed in the dashboard. |
2023-12-15 08:27:56 +00:00
| `max_ttl_ms` | integer | false | | Max ttl ms remove max_ttl once autostop_requirement is matured Only one of MaxTTLMillis or AutostopRequirement can be specified. |
2023-10-13 16:57:18 +00:00
| `name` | string | true | | Name is the name of the template. |
2023-10-18 22:07:21 +00:00
| `require_active_version` | boolean | false | | Require active version mandates that workspaces are built with the active template version. |
2023-10-13 16:57:18 +00:00
| `template_version_id` | string | true | | Template version ID is an in-progress or completed job to use as an initial version of the template. |
2023-01-03 18:21:10 +00:00
| This is required on creation to enable a user-flow of validating a template works. There is no reason the data-model cannot support empty templates, but it doesn't make sense for users. |
2023-01-11 11:16:09 +00:00
## codersdk.CreateTemplateVersionDryRunRequest
```json
{
2023-01-23 14:01:22 +00:00
"rich_parameter_values": [
{
"name": "string",
"value": "string"
}
],
2023-02-15 17:24:15 +00:00
"user_variable_values": [
{
"name": "string",
"value": "string"
}
],
2023-01-11 11:16:09 +00:00
"workspace_name": "string"
}
```
### Properties
2023-06-02 09:16:46 +00:00
| Name | Type | Required | Restrictions | Description |
| ----------------------- | ----------------------------------------------------------------------------- | -------- | ------------ | ----------- |
| `rich_parameter_values` | array of [codersdk.WorkspaceBuildParameter ](#codersdkworkspacebuildparameter ) | false | | |
| `user_variable_values` | array of [codersdk.VariableValue ](#codersdkvariablevalue ) | false | | |
| `workspace_name` | string | false | | |
2023-01-11 11:16:09 +00:00
2023-03-02 13:11:16 +00:00
## codersdk.CreateTemplateVersionRequest
```json
{
"example_id": "string",
"file_id": "8a0cfb4f-ddc9-436d-91bb-75133c583767",
2023-07-11 10:11:08 +00:00
"message": "string",
2023-03-02 13:11:16 +00:00
"name": "string",
"provisioner": "terraform",
"storage_method": "file",
"tags": {
"property1": "string",
"property2": "string"
},
"template_id": "c6d67e98-83ea-49f0-8812-e4abae2b68bc",
"user_variable_values": [
{
"name": "string",
"value": "string"
}
]
}
```
### Properties
2023-06-02 09:16:46 +00:00
| Name | Type | Required | Restrictions | Description |
| ---------------------- | ---------------------------------------------------------------------- | -------- | ------------ | ------------------------------------------------------------ |
| `example_id` | string | false | | |
| `file_id` | string | false | | |
2023-07-11 10:11:08 +00:00
| `message` | string | false | | |
2023-06-02 09:16:46 +00:00
| `name` | string | false | | |
| `provisioner` | string | true | | |
| `storage_method` | [codersdk.ProvisionerStorageMethod ](#codersdkprovisionerstoragemethod ) | true | | |
| `tags` | object | false | | |
| » `[any property]` | string | false | | |
| `template_id` | string | false | | Template ID optionally associates a version with a template. |
| `user_variable_values` | array of [codersdk.VariableValue ](#codersdkvariablevalue ) | false | | |
2023-03-02 13:11:16 +00:00
#### Enumerated Values
| Property | Value |
| ---------------- | ----------- |
| `provisioner` | `terraform` |
| `provisioner` | `echo` |
| `storage_method` | `file` |
2023-01-03 18:21:10 +00:00
## codersdk.CreateTestAuditLogRequest
```json
{
"action": "create",
2023-01-30 18:43:29 +00:00
"additional_fields": [0],
2023-01-24 20:34:29 +00:00
"build_reason": "autostart",
2023-01-13 11:27:21 +00:00
"resource_id": "4d5215ed-38bb-48ed-879a-fdb9ca58522f",
2023-01-26 23:14:09 +00:00
"resource_type": "template",
2023-01-13 11:27:21 +00:00
"time": "2019-08-24T14:15:22Z"
2023-01-03 18:21:10 +00:00
}
```
### Properties
2023-01-30 18:43:29 +00:00
| Name | Type | Required | Restrictions | Description |
| ------------------- | ---------------------------------------------- | -------- | ------------ | ----------- |
| `action` | [codersdk.AuditAction ](#codersdkauditaction ) | false | | |
| `additional_fields` | array of integer | false | | |
| `build_reason` | [codersdk.BuildReason ](#codersdkbuildreason ) | false | | |
| `resource_id` | string | false | | |
| `resource_type` | [codersdk.ResourceType ](#codersdkresourcetype ) | false | | |
| `time` | string | false | | |
2023-01-03 18:21:10 +00:00
#### Enumerated Values
| Property | Value |
| --------------- | ------------------ |
| `action` | `create` |
| `action` | `write` |
| `action` | `delete` |
| `action` | `start` |
| `action` | `stop` |
2023-01-24 20:34:29 +00:00
| `build_reason` | `autostart` |
| `build_reason` | `autostop` |
| `build_reason` | `initiator` |
2023-01-03 18:21:10 +00:00
| `resource_type` | `template` |
| `resource_type` | `template_version` |
| `resource_type` | `user` |
| `resource_type` | `workspace` |
| `resource_type` | `workspace_build` |
| `resource_type` | `git_ssh_key` |
2023-01-26 23:14:09 +00:00
| `resource_type` | `auditable_group` |
2023-01-03 18:21:10 +00:00
2023-01-11 13:08:04 +00:00
## codersdk.CreateTokenRequest
```json
{
"lifetime": 0,
2023-03-02 17:39:38 +00:00
"scope": "all",
"token_name": "string"
2023-01-11 13:08:04 +00:00
}
```
### Properties
2023-03-02 17:39:38 +00:00
| Name | Type | Required | Restrictions | Description |
| ------------ | -------------------------------------------- | -------- | ------------ | ----------- |
| `lifetime` | integer | false | | |
| `scope` | [codersdk.APIKeyScope ](#codersdkapikeyscope ) | false | | |
| `token_name` | string | false | | |
2023-01-11 13:08:04 +00:00
#### Enumerated Values
| Property | Value |
| -------- | --------------------- |
| `scope` | `all` |
| `scope` | `application_connect` |
## codersdk.CreateUserRequest
```json
{
2023-06-14 17:48:43 +00:00
"disable_login": true,
2023-01-11 13:08:04 +00:00
"email": "user@example.com",
2023-08-11 01:04:35 +00:00
"login_type": "",
2023-01-11 13:08:04 +00:00
"organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
"password": "string",
"username": "string"
}
```
### Properties
2023-08-11 01:04:35 +00:00
| Name | Type | Required | Restrictions | Description |
| ----------------- | ---------------------------------------- | -------- | ------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `disable_login` | boolean | false | | Disable login sets the user's login type to 'none'. This prevents the user from being able to use a password or any other authentication method to login. Deprecated: Set UserLoginType=LoginTypeDisabled instead. |
| `email` | string | true | | |
| `login_type` | [codersdk.LoginType ](#codersdklogintype ) | false | | Login type defaults to LoginTypePassword. |
| `organization_id` | string | false | | |
| `password` | string | false | | |
| `username` | string | true | | |
2023-01-11 13:08:04 +00:00
2023-01-05 14:27:10 +00:00
## codersdk.CreateWorkspaceBuildRequest
```json
{
"dry_run": true,
2023-03-30 14:00:33 +00:00
"log_level": "debug",
2023-01-05 14:27:10 +00:00
"orphan": true,
2023-01-17 15:24:45 +00:00
"rich_parameter_values": [
{
"name": "string",
"value": "string"
}
],
2023-01-05 14:27:10 +00:00
"state": [0],
2023-01-13 11:27:21 +00:00
"template_version_id": "0ba39c92-1f1b-4c32-aa3e-9925d7713eb1",
2023-01-05 14:27:10 +00:00
"transition": "create"
}
```
### Properties
2023-06-02 09:16:46 +00:00
| Name | Type | Required | Restrictions | Description |
| ----------------------- | ----------------------------------------------------------------------------- | -------- | ------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `dry_run` | boolean | false | | |
| `log_level` | [codersdk.ProvisionerLogLevel ](#codersdkprovisionerloglevel ) | false | | Log level changes the default logging verbosity of a provider ("info" if empty). |
| `orphan` | boolean | false | | Orphan may be set for the Destroy transition. |
| `rich_parameter_values` | array of [codersdk.WorkspaceBuildParameter ](#codersdkworkspacebuildparameter ) | false | | Rich parameter values are optional. It will write params to the 'workspace' scope. This will overwrite any existing parameters with the same name. This will not delete old params not included in this list. |
| `state` | array of integer | false | | |
| `template_version_id` | string | false | | |
| `transition` | [codersdk.WorkspaceTransition ](#codersdkworkspacetransition ) | true | | |
2023-01-05 14:27:10 +00:00
#### Enumerated Values
| Property | Value |
| ------------ | -------- |
2023-03-30 14:00:33 +00:00
| `log_level` | `debug` |
2023-01-05 14:27:10 +00:00
| `transition` | `create` |
| `transition` | `start` |
| `transition` | `stop` |
| `transition` | `delete` |
2023-04-04 20:07:29 +00:00
## codersdk.CreateWorkspaceProxyRequest
```json
{
"display_name": "string",
"icon": "string",
2023-04-21 02:09:14 +00:00
"name": "string"
2023-04-04 20:07:29 +00:00
}
```
### Properties
2023-04-21 02:09:14 +00:00
| Name | Type | Required | Restrictions | Description |
| -------------- | ------ | -------- | ------------ | ----------- |
| `display_name` | string | false | | |
| `icon` | string | false | | |
2023-05-03 15:12:56 +00:00
| `name` | string | true | | |
2023-04-04 20:07:29 +00:00
2023-02-09 14:02:03 +00:00
## codersdk.CreateWorkspaceRequest
```json
{
2023-10-06 09:27:12 +00:00
"automatic_updates": "always",
2023-02-09 14:02:03 +00:00
"autostart_schedule": "string",
"name": "string",
"rich_parameter_values": [
{
"name": "string",
"value": "string"
}
],
"template_id": "c6d67e98-83ea-49f0-8812-e4abae2b68bc",
2023-08-31 21:07:58 +00:00
"template_version_id": "0ba39c92-1f1b-4c32-aa3e-9925d7713eb1",
2023-02-09 14:02:03 +00:00
"ttl_ms": 0
}
```
### Properties
2023-08-31 21:07:58 +00:00
| Name | Type | Required | Restrictions | Description |
| ----------------------- | ----------------------------------------------------------------------------- | -------- | ------------ | ------------------------------------------------------------------------------------------------------- |
2023-10-06 09:27:12 +00:00
| `automatic_updates` | [codersdk.AutomaticUpdates ](#codersdkautomaticupdates ) | false | | |
2023-08-31 21:07:58 +00:00
| `autostart_schedule` | string | false | | |
| `name` | string | true | | |
| `rich_parameter_values` | array of [codersdk.WorkspaceBuildParameter ](#codersdkworkspacebuildparameter ) | false | | Rich parameter values allows for additional parameters to be provided during the initial provision. |
| `template_id` | string | false | | Template ID specifies which template should be used for creating the workspace. |
| `template_version_id` | string | false | | Template version ID can be used to specify a specific version of a template for creating the workspace. |
| `ttl_ms` | integer | false | | |
2023-02-09 14:02:03 +00:00
2023-01-11 11:16:09 +00:00
## codersdk.DAUEntry
```json
{
"amount": 0,
2024-01-31 22:01:50 +00:00
"date": "string"
2023-01-11 11:16:09 +00:00
}
```
### Properties
2024-01-31 22:01:50 +00:00
| Name | Type | Required | Restrictions | Description |
| -------- | ------- | -------- | ------------ | ---------------------------------------------------------------------------------------- |
| `amount` | integer | false | | |
| `date` | string | false | | Date is a string formatted as 2024-01-31. Timezone and time information is not included. |
2023-01-11 11:16:09 +00:00
2023-05-30 17:18:27 +00:00
## codersdk.DAUsResponse
```json
{
"entries": [
{
"amount": 0,
2024-01-31 22:01:50 +00:00
"date": "string"
2023-05-30 17:18:27 +00:00
}
],
"tz_hour_offset": 0
}
```
### Properties
| Name | Type | Required | Restrictions | Description |
| ---------------- | ----------------------------------------------- | -------- | ------------ | ----------- |
| `entries` | array of [codersdk.DAUEntry ](#codersdkdauentry ) | false | | |
| `tz_hour_offset` | integer | false | | |
2023-01-03 18:21:10 +00:00
## codersdk.DERP
```json
{
"config": {
2023-06-21 22:02:05 +00:00
"block_direct": true,
2023-08-24 17:22:31 +00:00
"force_websockets": true,
2023-03-07 21:10:01 +00:00
"path": "string",
"url": "string"
2023-01-03 18:21:10 +00:00
},
"server": {
2023-03-07 21:10:01 +00:00
"enable": true,
"region_code": "string",
"region_id": 0,
"region_name": "string",
2023-01-03 18:21:10 +00:00
"relay_url": {
2023-03-07 21:10:01 +00:00
"forceQuery": true,
"fragment": "string",
"host": "string",
"omitHost": true,
"opaque": "string",
"path": "string",
"rawFragment": "string",
"rawPath": "string",
"rawQuery": "string",
"scheme": "string",
"user": {}
2023-01-03 18:21:10 +00:00
},
2023-03-07 21:10:01 +00:00
"stun_addresses": ["string"]
2023-01-03 18:21:10 +00:00
}
}
```
### Properties
| Name | Type | Required | Restrictions | Description |
| -------- | ------------------------------------------------------ | -------- | ------------ | ----------- |
| `config` | [codersdk.DERPConfig ](#codersdkderpconfig ) | false | | |
| `server` | [codersdk.DERPServerConfig ](#codersdkderpserverconfig ) | false | | |
## codersdk.DERPConfig
```json
{
2023-06-21 22:02:05 +00:00
"block_direct": true,
2023-08-24 17:22:31 +00:00
"force_websockets": true,
2023-03-07 21:10:01 +00:00
"path": "string",
"url": "string"
2023-01-03 18:21:10 +00:00
}
```
### Properties
2023-08-24 17:22:31 +00:00
| Name | Type | Required | Restrictions | Description |
| ------------------ | ------- | -------- | ------------ | ----------- |
| `block_direct` | boolean | false | | |
| `force_websockets` | boolean | false | | |
| `path` | string | false | | |
| `url` | string | false | | |
2023-01-03 18:21:10 +00:00
## codersdk.DERPRegion
```json
{
"latency_ms": 0,
"preferred": true
}
```
### Properties
| Name | Type | Required | Restrictions | Description |
| ------------ | ------- | -------- | ------------ | ----------- |
| `latency_ms` | number | false | | |
| `preferred` | boolean | false | | |
## codersdk.DERPServerConfig
```json
{
2023-03-07 21:10:01 +00:00
"enable": true,
"region_code": "string",
"region_id": 0,
"region_name": "string",
2023-01-03 18:21:10 +00:00
"relay_url": {
2023-03-07 21:10:01 +00:00
"forceQuery": true,
"fragment": "string",
"host": "string",
"omitHost": true,
"opaque": "string",
"path": "string",
"rawFragment": "string",
"rawPath": "string",
"rawQuery": "string",
"scheme": "string",
"user": {}
2023-01-03 18:21:10 +00:00
},
2023-03-07 21:10:01 +00:00
"stun_addresses": ["string"]
2023-01-03 18:21:10 +00:00
}
```
### Properties
2023-03-07 21:10:01 +00:00
| Name | Type | Required | Restrictions | Description |
| ---------------- | -------------------------- | -------- | ------------ | ----------- |
| `enable` | boolean | false | | |
| `region_code` | string | false | | |
| `region_id` | integer | false | | |
| `region_name` | string | false | | |
| `relay_url` | [clibase.URL ](#clibaseurl ) | false | | |
| `stun_addresses` | array of string | false | | |
2023-01-03 18:21:10 +00:00
2023-01-18 22:56:14 +00:00
## codersdk.DangerousConfig
```json
{
2023-05-22 18:02:39 +00:00
"allow_all_cors": true,
2023-03-07 21:10:01 +00:00
"allow_path_app_sharing": true,
"allow_path_app_site_owner_access": true
2023-01-18 22:56:14 +00:00
}
```
### Properties
2023-03-07 21:10:01 +00:00
| Name | Type | Required | Restrictions | Description |
| ---------------------------------- | ------- | -------- | ------------ | ----------- |
2023-05-22 18:02:39 +00:00
| `allow_all_cors` | boolean | false | | |
2023-03-07 21:10:01 +00:00
| `allow_path_app_sharing` | boolean | false | | |
| `allow_path_app_site_owner_access` | boolean | false | | |
2023-01-18 22:56:14 +00:00
2024-02-13 14:31:20 +00:00
## codersdk.DeleteWorkspaceAgentPortShareRequest
```json
{
"agent_name": "string",
"port": 0
}
```
### Properties
| Name | Type | Required | Restrictions | Description |
| ------------ | ------- | -------- | ------------ | ----------- |
| `agent_name` | string | false | | |
| `port` | integer | false | | |
2023-01-03 18:21:10 +00:00
## codersdk.DeploymentConfig
```json
{
2023-03-07 21:10:01 +00:00
"config": {
"access_url": {
"forceQuery": true,
"fragment": "string",
"host": "string",
"omitHost": true,
"opaque": "string",
"path": "string",
"rawFragment": "string",
"rawPath": "string",
"rawQuery": "string",
"scheme": "string",
"user": {}
2023-01-18 22:56:14 +00:00
},
2023-03-07 21:10:01 +00:00
"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,
2023-12-15 18:38:47 +00:00
"allow_workspace_renames": true,
2023-03-07 21:10:01 +00:00
"autobuild_poll_interval": 0,
"browser_only": true,
"cache_directory": "string",
2024-01-30 23:11:37 +00:00
"cli_upgrade_message": "string",
2023-03-07 21:10:01 +00:00
"config": "string",
2023-03-16 18:03:37 +00:00
"config_ssh": {
"deploymentName": "string",
"sshconfigOptions": ["string"]
},
2023-03-07 21:10:01 +00:00
"dangerous": {
2023-05-22 18:02:39 +00:00
"allow_all_cors": true,
2023-03-07 21:10:01 +00:00
"allow_path_app_sharing": true,
"allow_path_app_site_owner_access": true
},
"derp": {
"config": {
2023-06-21 22:02:05 +00:00
"block_direct": true,
2023-08-24 17:22:31 +00:00
"force_websockets": true,
2023-03-07 21:10:01 +00:00
"path": "string",
"url": "string"
2023-01-03 18:21:10 +00:00
},
2023-03-07 21:10:01 +00:00
"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"]
2023-01-03 18:21:10 +00:00
}
},
2023-04-11 13:57:23 +00:00
"disable_owner_workspace_exec": true,
2023-03-07 21:10:01 +00:00
"disable_password_auth": true,
"disable_path_apps": true,
"disable_session_expiry_refresh": true,
2023-07-19 11:31:17 +00:00
"docs_url": {
"forceQuery": true,
"fragment": "string",
"host": "string",
"omitHost": true,
"opaque": "string",
"path": "string",
"rawFragment": "string",
"rawPath": "string",
"rawQuery": "string",
"scheme": "string",
"user": {}
},
2023-06-29 13:22:21 +00:00
"enable_terraform_debug_mode": true,
2023-03-07 21:10:01 +00:00
"experiments": ["string"],
2023-10-03 14:04:39 +00:00
"external_auth": {
2023-03-07 21:10:01 +00:00
"value": [
{
2023-06-29 18:58:01 +00:00
"app_install_url": "string",
"app_installations_url": "string",
2023-03-07 21:10:01 +00:00
"auth_url": "string",
"client_id": "string",
2023-06-29 18:58:01 +00:00
"device_code_url": "string",
"device_flow": true,
2023-10-03 14:04:39 +00:00
"display_icon": "string",
"display_name": "string",
2023-10-09 23:49:30 +00:00
"extra_token_keys": ["string"],
2023-03-07 21:10:01 +00:00
"id": "string",
"no_refresh": true,
"regex": "string",
"scopes": ["string"],
"token_url": "string",
"type": "string",
"validate_url": "string"
}
]
},
2023-10-03 14:04:39 +00:00
"external_token_encryption_keys": ["string"],
2023-11-13 14:14:43 +00:00
"healthcheck": {
"refresh": 0,
"threshold_database": 0
},
2023-03-07 21:10:01 +00:00
"http_address": "string",
"in_memory_database": true,
2023-06-25 13:17:00 +00:00
"job_hang_detector_interval": 0,
2023-03-07 21:10:01 +00:00
"logging": {
"human": "string",
"json": "string",
2023-07-26 21:46:22 +00:00
"log_filter": ["string"],
2023-03-07 21:10:01 +00:00
"stackdriver": "string"
},
"max_session_expiry": 0,
"max_token_lifetime": 0,
"metrics_cache_refresh_interval": 0,
"oauth2": {
"github": {
"allow_everyone": true,
"allow_signups": true,
"allowed_orgs": ["string"],
"allowed_teams": ["string"],
"client_id": "string",
"client_secret": "string",
"enterprise_base_url": "string"
}
},
"oidc": {
"allow_signups": true,
2023-03-30 08:36:57 +00:00
"auth_url_params": {},
2023-08-14 22:33:13 +00:00
"client_cert_file": "string",
2023-03-07 21:10:01 +00:00
"client_id": "string",
2023-08-14 22:33:13 +00:00
"client_key_file": "string",
2023-03-07 21:10:01 +00:00
"client_secret": "string",
"email_domain": ["string"],
2023-03-30 08:36:57 +00:00
"email_field": "string",
2023-12-08 16:14:19 +00:00
"group_allow_list": ["string"],
2023-08-08 16:37:49 +00:00
"group_auto_create": true,
2023-03-21 19:25:45 +00:00
"group_mapping": {},
2023-08-08 16:37:49 +00:00
"group_regex_filter": {},
2023-03-10 05:31:38 +00:00
"groups_field": "string",
2023-03-07 21:10:01 +00:00
"icon_url": {
"forceQuery": true,
"fragment": "string",
"host": "string",
"omitHost": true,
"opaque": "string",
"path": "string",
"rawFragment": "string",
"rawPath": "string",
"rawQuery": "string",
"scheme": "string",
"user": {}
2023-01-03 18:21:10 +00:00
},
2023-03-07 21:10:01 +00:00
"ignore_email_verified": true,
2023-04-05 08:07:43 +00:00
"ignore_user_info": true,
2023-03-07 21:10:01 +00:00
"issuer_url": "string",
"scopes": ["string"],
"sign_in_text": "string",
2024-02-01 17:01:25 +00:00
"signups_disabled_text": "string",
2023-07-24 12:34:24 +00:00
"user_role_field": "string",
"user_role_mapping": {},
"user_roles_default": ["string"],
2023-03-07 21:10:01 +00:00
"username_field": "string"
},
"pg_connection_url": "string",
"pprof": {
"address": {
"host": "string",
"port": "string"
2023-01-03 18:21:10 +00:00
},
2023-03-07 21:10:01 +00:00
"enable": true
},
"prometheus": {
"address": {
"host": "string",
"port": "string"
2023-01-03 18:21:10 +00:00
},
2023-04-14 14:14:52 +00:00
"collect_agent_stats": true,
2023-06-15 11:34:16 +00:00
"collect_db_metrics": true,
2023-03-07 21:10:01 +00:00
"enable": true
2023-01-03 18:21:10 +00:00
},
2023-03-07 21:10:01 +00:00
"provisioner": {
"daemon_poll_interval": 0,
"daemon_poll_jitter": 0,
2023-08-04 08:32:28 +00:00
"daemon_psk": "string",
2023-03-07 21:10:01 +00:00
"daemons": 0,
2023-06-22 00:21:40 +00:00
"daemons_echo": true,
2023-03-07 21:10:01 +00:00
"force_cancel_interval": 0
2023-01-03 18:21:10 +00:00
},
2023-06-08 17:58:24 +00:00
"proxy_health_status_interval": 0,
2023-03-07 21:10:01 +00:00
"proxy_trusted_headers": ["string"],
"proxy_trusted_origins": ["string"],
"rate_limit": {
"api": 0,
"disable_all": true
2023-01-03 18:21:10 +00:00
},
2023-03-07 21:10:01 +00:00
"redirect_to_access_url": true,
"scim_api_key": "string",
"secure_auth_cookie": true,
"ssh_keygen_algorithm": "string",
"strict_transport_security": 0,
"strict_transport_security_options": ["string"],
"support": {
"links": {
"value": [
{
2024-01-15 15:56:01 +00:00
"icon": "bug",
2023-03-07 21:10:01 +00:00
"name": "string",
"target": "string"
}
]
}
2023-01-03 18:21:10 +00:00
},
2023-03-07 21:10:01 +00:00
"swagger": {
"enable": true
2023-01-03 18:21:10 +00:00
},
2023-03-07 21:10:01 +00:00
"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": {}
}
2023-01-03 18:21:10 +00:00
},
2023-03-07 21:10:01 +00:00
"tls": {
"address": {
"host": "string",
"port": "string"
},
2023-11-07 14:55:39 +00:00
"allow_insecure_ciphers": true,
2023-03-07 21:10:01 +00:00
"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",
2023-11-07 14:55:39 +00:00
"redirect_http": true,
"supported_ciphers": ["string"]
2023-03-07 21:10:01 +00:00
},
"trace": {
"capture_logs": true,
2023-08-29 22:14:28 +00:00
"data_dog": true,
2023-03-07 21:10:01 +00:00
"enable": true,
"honeycomb_api_key": "string"
},
"update_check": true,
2023-07-20 13:35:41 +00:00
"user_quiet_hours_schedule": {
2023-12-15 09:33:51 +00:00
"allow_user_custom": true,
2023-07-20 13:35:41 +00:00
"default_schedule": "string"
},
2023-03-07 21:10:01 +00:00
"verbose": true,
2023-10-10 18:18:02 +00:00
"web_terminal_renderer": "string",
2023-03-22 13:13:48 +00:00
"wgtunnel_host": "string",
2024-01-17 16:41:42 +00:00
"wildcard_access_url": "string",
2023-03-07 21:10:01 +00:00
"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",
2023-04-07 22:58:21 +00:00
"parent": {},
"yaml": "string"
},
"yaml": "string"
2023-03-07 21:10:01 +00:00
},
"hidden": true,
"name": "string",
2023-07-11 13:59:55 +00:00
"required": true,
2023-03-07 21:10:01 +00:00
"use_instead": [{}],
"value": null,
2023-04-07 22:58:21 +00:00
"value_source": "",
2023-03-07 21:10:01 +00:00
"yaml": "string"
}
]
2023-01-03 18:21:10 +00:00
}
```
### Properties
2023-03-07 21:10:01 +00:00
| Name | Type | Required | Restrictions | Description |
| --------- | ------------------------------------------------------ | -------- | ------------ | ----------- |
| `config` | [codersdk.DeploymentValues ](#codersdkdeploymentvalues ) | false | | |
| `options` | array of [clibase.Option ](#clibaseoption ) | false | | |
2023-01-03 18:21:10 +00:00
2023-03-09 03:05:45 +00:00
## codersdk.DeploymentStats
```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
}
}
```
### Properties
| Name | Type | Required | Restrictions | Description |
| ----------------- | ---------------------------------------------------------------------------- | -------- | ------------ | --------------------------------------------------------------------------------------------------------------------------- |
| `aggregated_from` | string | false | | Aggregated from is the time in which stats are aggregated from. This might be back in time a specific duration or interval. |
| `collected_at` | string | false | | Collected at is the time in which stats are collected at. |
| `next_update_at` | string | false | | Next update at is the time when the next batch of stats will be updated. |
| `session_count` | [codersdk.SessionCountDeploymentStats ](#codersdksessioncountdeploymentstats ) | false | | |
| `workspaces` | [codersdk.WorkspaceDeploymentStats ](#codersdkworkspacedeploymentstats ) | false | | |
2023-03-07 21:10:01 +00:00
## codersdk.DeploymentValues
```json
{
"access_url": {
"forceQuery": true,
"fragment": "string",
"host": "string",
"omitHost": true,
"opaque": "string",
"path": "string",
"rawFragment": "string",
"rawPath": "string",
"rawQuery": "string",
"scheme": "string",
"user": {}
},
"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,
2023-12-15 18:38:47 +00:00
"allow_workspace_renames": true,
2023-03-07 21:10:01 +00:00
"autobuild_poll_interval": 0,
"browser_only": true,
"cache_directory": "string",
2024-01-30 23:11:37 +00:00
"cli_upgrade_message": "string",
2023-03-07 21:10:01 +00:00
"config": "string",
2023-03-16 18:03:37 +00:00
"config_ssh": {
"deploymentName": "string",
"sshconfigOptions": ["string"]
},
2023-03-07 21:10:01 +00:00
"dangerous": {
2023-05-22 18:02:39 +00:00
"allow_all_cors": true,
2023-03-07 21:10:01 +00:00
"allow_path_app_sharing": true,
"allow_path_app_site_owner_access": true
},
"derp": {
"config": {
2023-06-21 22:02:05 +00:00
"block_direct": true,
2023-08-24 17:22:31 +00:00
"force_websockets": true,
2023-03-07 21:10:01 +00:00
"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"]
}
},
2023-04-11 13:57:23 +00:00
"disable_owner_workspace_exec": true,
2023-03-07 21:10:01 +00:00
"disable_password_auth": true,
"disable_path_apps": true,
"disable_session_expiry_refresh": true,
2023-07-19 11:31:17 +00:00
"docs_url": {
"forceQuery": true,
"fragment": "string",
"host": "string",
"omitHost": true,
"opaque": "string",
"path": "string",
"rawFragment": "string",
"rawPath": "string",
"rawQuery": "string",
"scheme": "string",
"user": {}
},
2023-06-29 13:22:21 +00:00
"enable_terraform_debug_mode": true,
2023-03-07 21:10:01 +00:00
"experiments": ["string"],
2023-10-03 14:04:39 +00:00
"external_auth": {
2023-03-07 21:10:01 +00:00
"value": [
{
2023-06-29 18:58:01 +00:00
"app_install_url": "string",
"app_installations_url": "string",
2023-03-07 21:10:01 +00:00
"auth_url": "string",
"client_id": "string",
2023-06-29 18:58:01 +00:00
"device_code_url": "string",
"device_flow": true,
2023-10-03 14:04:39 +00:00
"display_icon": "string",
"display_name": "string",
2023-10-09 23:49:30 +00:00
"extra_token_keys": ["string"],
2023-03-07 21:10:01 +00:00
"id": "string",
"no_refresh": true,
"regex": "string",
"scopes": ["string"],
"token_url": "string",
"type": "string",
"validate_url": "string"
}
]
},
2023-10-03 14:04:39 +00:00
"external_token_encryption_keys": ["string"],
2023-11-13 14:14:43 +00:00
"healthcheck": {
"refresh": 0,
"threshold_database": 0
},
2023-03-07 21:10:01 +00:00
"http_address": "string",
"in_memory_database": true,
2023-06-25 13:17:00 +00:00
"job_hang_detector_interval": 0,
2023-03-07 21:10:01 +00:00
"logging": {
"human": "string",
"json": "string",
2023-07-26 21:46:22 +00:00
"log_filter": ["string"],
2023-03-07 21:10:01 +00:00
"stackdriver": "string"
},
"max_session_expiry": 0,
"max_token_lifetime": 0,
"metrics_cache_refresh_interval": 0,
"oauth2": {
"github": {
"allow_everyone": true,
"allow_signups": true,
"allowed_orgs": ["string"],
"allowed_teams": ["string"],
"client_id": "string",
"client_secret": "string",
"enterprise_base_url": "string"
}
},
"oidc": {
"allow_signups": true,
2023-03-30 08:36:57 +00:00
"auth_url_params": {},
2023-08-14 22:33:13 +00:00
"client_cert_file": "string",
2023-03-07 21:10:01 +00:00
"client_id": "string",
2023-08-14 22:33:13 +00:00
"client_key_file": "string",
2023-03-07 21:10:01 +00:00
"client_secret": "string",
"email_domain": ["string"],
2023-03-30 08:36:57 +00:00
"email_field": "string",
2023-12-08 16:14:19 +00:00
"group_allow_list": ["string"],
2023-08-08 16:37:49 +00:00
"group_auto_create": true,
2023-03-21 19:25:45 +00:00
"group_mapping": {},
2023-08-08 16:37:49 +00:00
"group_regex_filter": {},
2023-03-10 05:31:38 +00:00
"groups_field": "string",
2023-03-07 21:10:01 +00:00
"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,
2023-04-05 08:07:43 +00:00
"ignore_user_info": true,
2023-03-07 21:10:01 +00:00
"issuer_url": "string",
"scopes": ["string"],
"sign_in_text": "string",
2024-02-01 17:01:25 +00:00
"signups_disabled_text": "string",
2023-07-24 12:34:24 +00:00
"user_role_field": "string",
"user_role_mapping": {},
"user_roles_default": ["string"],
2023-03-07 21:10:01 +00:00
"username_field": "string"
},
"pg_connection_url": "string",
"pprof": {
"address": {
"host": "string",
"port": "string"
},
"enable": true
},
"prometheus": {
"address": {
"host": "string",
"port": "string"
},
2023-04-14 14:14:52 +00:00
"collect_agent_stats": true,
2023-06-15 11:34:16 +00:00
"collect_db_metrics": true,
2023-03-07 21:10:01 +00:00
"enable": true
},
"provisioner": {
"daemon_poll_interval": 0,
"daemon_poll_jitter": 0,
2023-08-04 08:32:28 +00:00
"daemon_psk": "string",
2023-03-07 21:10:01 +00:00
"daemons": 0,
2023-06-22 00:21:40 +00:00
"daemons_echo": true,
2023-03-07 21:10:01 +00:00
"force_cancel_interval": 0
},
2023-06-08 17:58:24 +00:00
"proxy_health_status_interval": 0,
2023-03-07 21:10:01 +00:00
"proxy_trusted_headers": ["string"],
"proxy_trusted_origins": ["string"],
"rate_limit": {
"api": 0,
"disable_all": true
},
"redirect_to_access_url": true,
"scim_api_key": "string",
"secure_auth_cookie": true,
"ssh_keygen_algorithm": "string",
"strict_transport_security": 0,
"strict_transport_security_options": ["string"],
"support": {
"links": {
"value": [
{
2024-01-15 15:56:01 +00:00
"icon": "bug",
2023-03-07 21:10:01 +00:00
"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": {}
}
},
"tls": {
"address": {
"host": "string",
"port": "string"
},
2023-11-07 14:55:39 +00:00
"allow_insecure_ciphers": true,
2023-03-07 21:10:01 +00:00
"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",
2023-11-07 14:55:39 +00:00
"redirect_http": true,
"supported_ciphers": ["string"]
2023-03-07 21:10:01 +00:00
},
"trace": {
"capture_logs": true,
2023-08-29 22:14:28 +00:00
"data_dog": true,
2023-03-07 21:10:01 +00:00
"enable": true,
"honeycomb_api_key": "string"
},
"update_check": true,
2023-07-20 13:35:41 +00:00
"user_quiet_hours_schedule": {
2023-12-15 09:33:51 +00:00
"allow_user_custom": true,
2023-07-20 13:35:41 +00:00
"default_schedule": "string"
},
2023-03-07 21:10:01 +00:00
"verbose": true,
2023-10-10 18:18:02 +00:00
"web_terminal_renderer": "string",
2023-03-22 13:13:48 +00:00
"wgtunnel_host": "string",
2024-01-17 16:41:42 +00:00
"wildcard_access_url": "string",
2023-03-07 21:10:01 +00:00
"write_config": true
}
```
### Properties
2023-10-03 14:04:39 +00:00
| Name | Type | Required | Restrictions | Description |
| ------------------------------------ | ---------------------------------------------------------------------------------------------------- | -------- | ------------ | ------------------------------------------------------------------ |
| `access_url` | [clibase.URL ](#clibaseurl ) | false | | |
| `address` | [clibase.HostPort ](#clibasehostport ) | false | | Address Use HTTPAddress or TLS.Address instead. |
| `agent_fallback_troubleshooting_url` | [clibase.URL ](#clibaseurl ) | false | | |
| `agent_stat_refresh_interval` | integer | false | | |
2023-12-15 18:38:47 +00:00
| `allow_workspace_renames` | boolean | false | | |
2023-10-03 14:04:39 +00:00
| `autobuild_poll_interval` | integer | false | | |
| `browser_only` | boolean | false | | |
| `cache_directory` | string | false | | |
2024-01-30 23:11:37 +00:00
| `cli_upgrade_message` | string | false | | |
2023-10-03 14:04:39 +00:00
| `config` | string | false | | |
| `config_ssh` | [codersdk.SSHConfig ](#codersdksshconfig ) | false | | |
| `dangerous` | [codersdk.DangerousConfig ](#codersdkdangerousconfig ) | false | | |
| `derp` | [codersdk.DERP ](#codersdkderp ) | false | | |
| `disable_owner_workspace_exec` | boolean | false | | |
| `disable_password_auth` | boolean | false | | |
| `disable_path_apps` | boolean | false | | |
| `disable_session_expiry_refresh` | boolean | false | | |
| `docs_url` | [clibase.URL ](#clibaseurl ) | false | | |
| `enable_terraform_debug_mode` | boolean | false | | |
| `experiments` | array of string | false | | |
| `external_auth` | [clibase.Struct-array_codersdk_ExternalAuthConfig ](#clibasestruct-array_codersdk_externalauthconfig ) | false | | |
| `external_token_encryption_keys` | array of string | false | | |
2023-11-13 14:14:43 +00:00
| `healthcheck` | [codersdk.HealthcheckConfig ](#codersdkhealthcheckconfig ) | false | | |
2023-10-03 14:04:39 +00:00
| `http_address` | string | false | | Http address is a string because it may be set to zero to disable. |
| `in_memory_database` | boolean | false | | |
| `job_hang_detector_interval` | integer | false | | |
| `logging` | [codersdk.LoggingConfig ](#codersdkloggingconfig ) | false | | |
| `max_session_expiry` | integer | false | | |
| `max_token_lifetime` | integer | false | | |
| `metrics_cache_refresh_interval` | integer | false | | |
| `oauth2` | [codersdk.OAuth2Config ](#codersdkoauth2config ) | false | | |
| `oidc` | [codersdk.OIDCConfig ](#codersdkoidcconfig ) | false | | |
| `pg_connection_url` | string | false | | |
| `pprof` | [codersdk.PprofConfig ](#codersdkpprofconfig ) | false | | |
| `prometheus` | [codersdk.PrometheusConfig ](#codersdkprometheusconfig ) | false | | |
| `provisioner` | [codersdk.ProvisionerConfig ](#codersdkprovisionerconfig ) | false | | |
| `proxy_health_status_interval` | integer | false | | |
| `proxy_trusted_headers` | array of string | false | | |
| `proxy_trusted_origins` | array of string | false | | |
| `rate_limit` | [codersdk.RateLimitConfig ](#codersdkratelimitconfig ) | false | | |
| `redirect_to_access_url` | boolean | false | | |
| `scim_api_key` | string | false | | |
| `secure_auth_cookie` | boolean | false | | |
| `ssh_keygen_algorithm` | string | false | | |
| `strict_transport_security` | integer | false | | |
| `strict_transport_security_options` | array of string | false | | |
| `support` | [codersdk.SupportConfig ](#codersdksupportconfig ) | false | | |
| `swagger` | [codersdk.SwaggerConfig ](#codersdkswaggerconfig ) | false | | |
| `telemetry` | [codersdk.TelemetryConfig ](#codersdktelemetryconfig ) | false | | |
| `tls` | [codersdk.TLSConfig ](#codersdktlsconfig ) | false | | |
| `trace` | [codersdk.TraceConfig ](#codersdktraceconfig ) | false | | |
| `update_check` | boolean | false | | |
| `user_quiet_hours_schedule` | [codersdk.UserQuietHoursScheduleConfig ](#codersdkuserquiethoursscheduleconfig ) | false | | |
| `verbose` | boolean | false | | |
2023-10-10 18:18:02 +00:00
| `web_terminal_renderer` | string | false | | |
2023-10-03 14:04:39 +00:00
| `wgtunnel_host` | string | false | | |
2024-01-17 16:41:42 +00:00
| `wildcard_access_url` | string | false | | |
2023-10-03 14:04:39 +00:00
| `write_config` | boolean | false | | |
2023-03-07 21:10:01 +00:00
2023-08-30 19:53:42 +00:00
## codersdk.DisplayApp
```json
"vscode"
```
### Properties
#### Enumerated Values
| Value |
| ------------------------ |
| `vscode` |
| `vscode_insiders` |
| `web_terminal` |
| `port_forwarding_helper` |
| `ssh_helper` |
2023-01-11 15:05:42 +00:00
## codersdk.Entitlement
```json
"entitled"
```
### Properties
#### Enumerated Values
| Value |
| -------------- |
| `entitled` |
| `grace_period` |
| `not_entitled` |
## codersdk.Entitlements
```json
{
"errors": ["string"],
"features": {
"property1": {
"actual": 0,
"enabled": true,
"entitlement": "entitled",
"limit": 0
},
"property2": {
"actual": 0,
"enabled": true,
"entitlement": "entitled",
"limit": 0
}
},
"has_license": true,
2023-08-22 14:26:43 +00:00
"refreshed_at": "2019-08-24T14:15:22Z",
2023-02-14 20:26:47 +00:00
"require_telemetry": true,
2023-01-11 15:05:42 +00:00
"trial": true,
"warnings": ["string"]
}
```
### Properties
2023-03-07 21:10:01 +00:00
| Name | Type | Required | Restrictions | Description |
| ------------------- | ------------------------------------ | -------- | ------------ | ----------- |
| `errors` | array of string | false | | |
| `features` | object | false | | |
| » `[any property]` | [codersdk.Feature ](#codersdkfeature ) | false | | |
| `has_license` | boolean | false | | |
2023-08-22 14:26:43 +00:00
| `refreshed_at` | string | false | | |
2023-03-07 21:10:01 +00:00
| `require_telemetry` | boolean | false | | |
| `trial` | boolean | false | | |
| `warnings` | array of string | false | | |
2023-01-18 19:12:53 +00:00
2023-01-25 21:35:53 +00:00
## codersdk.Experiment
```json
2024-01-11 21:03:10 +00:00
"example"
2023-01-25 21:35:53 +00:00
```
### Properties
#### Enumerated Values
2024-02-13 14:31:20 +00:00
| Value |
| -------------- |
| `example` |
| `shared-ports` |
2023-01-25 21:35:53 +00:00
2023-09-30 19:30:01 +00:00
## codersdk.ExternalAuth
```json
{
"app_install_url": "string",
"app_installable": true,
"authenticated": true,
"device": true,
2023-10-03 14:04:39 +00:00
"display_name": "string",
2023-09-30 19:30:01 +00:00
"installations": [
{
"account": {
"avatar_url": "string",
"login": "string",
"name": "string",
"profile_url": "string"
},
"configure_url": "string",
"id": 0
}
],
"user": {
"avatar_url": "string",
"login": "string",
"name": "string",
"profile_url": "string"
}
}
```
### Properties
| Name | Type | Required | Restrictions | Description |
| ----------------- | ------------------------------------------------------------------------------------- | -------- | ------------ | ----------------------------------------------------------------------- |
| `app_install_url` | string | false | | App install URL is the URL to install the app. |
| `app_installable` | boolean | false | | App installable is true if the request for app installs was successful. |
| `authenticated` | boolean | false | | |
| `device` | boolean | false | | |
2023-10-03 14:04:39 +00:00
| `display_name` | string | false | | |
2023-09-30 19:30:01 +00:00
| `installations` | array of [codersdk.ExternalAuthAppInstallation ](#codersdkexternalauthappinstallation ) | false | | Installations are the installations that the user has access to. |
| `user` | [codersdk.ExternalAuthUser ](#codersdkexternalauthuser ) | false | | User is the user that authenticated with the provider. |
## codersdk.ExternalAuthAppInstallation
```json
{
"account": {
"avatar_url": "string",
"login": "string",
"name": "string",
"profile_url": "string"
},
"configure_url": "string",
"id": 0
}
```
### Properties
| Name | Type | Required | Restrictions | Description |
| --------------- | ------------------------------------------------------ | -------- | ------------ | ----------- |
| `account` | [codersdk.ExternalAuthUser ](#codersdkexternalauthuser ) | false | | |
| `configure_url` | string | false | | |
| `id` | integer | false | | |
2023-10-03 14:04:39 +00:00
## codersdk.ExternalAuthConfig
```json
{
"app_install_url": "string",
"app_installations_url": "string",
"auth_url": "string",
"client_id": "string",
"device_code_url": "string",
"device_flow": true,
"display_icon": "string",
"display_name": "string",
2023-10-09 23:49:30 +00:00
"extra_token_keys": ["string"],
2023-10-03 14:04:39 +00:00
"id": "string",
"no_refresh": true,
"regex": "string",
"scopes": ["string"],
"token_url": "string",
"type": "string",
"validate_url": "string"
}
```
### Properties
| Name | Type | Required | Restrictions | Description |
| -------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------- | -------- | ------------ | --------------------------------------------------------------------------------------------------------- |
| `app_install_url` | string | false | | |
| `app_installations_url` | string | false | | |
| `auth_url` | string | false | | |
| `client_id` | string | false | | |
| `device_code_url` | string | false | | |
| `device_flow` | boolean | false | | |
| `display_icon` | string | false | | Display icon is a URL to an icon to display in the UI. |
| `display_name` | string | false | | Display name is shown in the UI to identify the auth config. |
2023-10-09 23:49:30 +00:00
| `extra_token_keys` | array of string | false | | |
2023-10-03 14:04:39 +00:00
| `id` | string | false | | ID is a unique identifier for the auth config. It defaults to `type` when not provided. |
| `no_refresh` | boolean | false | | |
| `regex` | string | false | | Regex allows API requesters to match an auth config by a string (e.g. coder.com) instead of by it's type. |
| Git clone makes use of this by parsing the URL from: 'Username for "https://github.com":' And sending it to the Coder server to match against the Regex. |
| `scopes` | array of string | false | | |
| `token_url` | string | false | | |
| `type` | string | false | | Type is the type of external auth config. |
| `validate_url` | string | false | | |
2023-09-30 19:30:01 +00:00
## codersdk.ExternalAuthDevice
```json
{
"device_code": "string",
"expires_in": 0,
"interval": 0,
"user_code": "string",
"verification_uri": "string"
}
```
### Properties
| Name | Type | Required | Restrictions | Description |
| ------------------ | ------- | -------- | ------------ | ----------- |
| `device_code` | string | false | | |
| `expires_in` | integer | false | | |
| `interval` | integer | false | | |
| `user_code` | string | false | | |
| `verification_uri` | string | false | | |
2023-12-05 20:03:44 +00:00
## codersdk.ExternalAuthLink
```json
{
2023-12-06 14:41:45 +00:00
"authenticated": true,
2023-12-05 20:03:44 +00:00
"created_at": "2019-08-24T14:15:22Z",
"expires": "2019-08-24T14:15:22Z",
"has_refresh_token": true,
"provider_id": "string",
2023-12-06 14:41:45 +00:00
"updated_at": "2019-08-24T14:15:22Z",
"validate_error": "string"
2023-12-05 20:03:44 +00:00
}
```
### Properties
| Name | Type | Required | Restrictions | Description |
| ------------------- | ------- | -------- | ------------ | ----------- |
2023-12-06 14:41:45 +00:00
| `authenticated` | boolean | false | | |
2023-12-05 20:03:44 +00:00
| `created_at` | string | false | | |
| `expires` | string | false | | |
| `has_refresh_token` | boolean | false | | |
| `provider_id` | string | false | | |
| `updated_at` | string | false | | |
2023-12-06 14:41:45 +00:00
| `validate_error` | string | false | | |
2023-12-05 20:03:44 +00:00
2023-09-30 19:30:01 +00:00
## codersdk.ExternalAuthUser
```json
{
"avatar_url": "string",
"login": "string",
"name": "string",
"profile_url": "string"
}
```
### Properties
| Name | Type | Required | Restrictions | Description |
| ------------- | ------ | -------- | ------------ | ----------- |
| `avatar_url` | string | false | | |
| `login` | string | false | | |
| `name` | string | false | | |
| `profile_url` | string | false | | |
2023-01-11 15:05:42 +00:00
## codersdk.Feature
```json
{
"actual": 0,
"enabled": true,
"entitlement": "entitled",
"limit": 0
}
```
### Properties
| Name | Type | Required | Restrictions | Description |
| ------------- | -------------------------------------------- | -------- | ------------ | ----------- |
| `actual` | integer | false | | |
| `enabled` | boolean | false | | |
| `entitlement` | [codersdk.Entitlement ](#codersdkentitlement ) | false | | |
| `limit` | integer | false | | |
2023-01-11 13:08:04 +00:00
## codersdk.GenerateAPIKeyResponse
```json
{
"key": "string"
}
```
### Properties
| Name | Type | Required | Restrictions | Description |
| ----- | ------ | -------- | ------------ | ----------- |
| `key` | string | false | | |
## codersdk.GetUsersResponse
```json
{
"count": 0,
"users": [
{
"avatar_url": "http://example.com",
"created_at": "2019-08-24T14:15:22Z",
"email": "user@example.com",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"last_seen_at": "2019-08-24T14:15:22Z",
2023-08-11 01:04:35 +00:00
"login_type": "",
2024-01-17 12:20:45 +00:00
"name": "string",
2023-01-11 13:08:04 +00:00
"organization_ids": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"],
"roles": [
{
"display_name": "string",
"name": "string"
}
],
"status": "active",
2023-12-14 17:38:44 +00:00
"theme_preference": "string",
2023-01-11 13:08:04 +00:00
"username": "string"
}
]
}
```
### Properties
| Name | Type | Required | Restrictions | Description |
| ------- | --------------------------------------- | -------- | ------------ | ----------- |
| `count` | integer | false | | |
| `users` | array of [codersdk.User ](#codersdkuser ) | false | | |
## codersdk.GitSSHKey
```json
{
"created_at": "2019-08-24T14:15:22Z",
"public_key": "string",
"updated_at": "2019-08-24T14:15:22Z",
"user_id": "a169451c-8525-4352-b8ca-070dd449a1a5"
}
```
### Properties
| Name | Type | Required | Restrictions | Description |
| ------------ | ------ | -------- | ------------ | ----------- |
| `created_at` | string | false | | |
| `public_key` | string | false | | |
| `updated_at` | string | false | | |
| `user_id` | string | false | | |
2023-01-11 15:05:42 +00:00
## codersdk.Group
```json
{
"avatar_url": "string",
2023-08-02 15:53:06 +00:00
"display_name": "string",
2023-01-11 15:05:42 +00:00
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"members": [
{
"avatar_url": "http://example.com",
"created_at": "2019-08-24T14:15:22Z",
"email": "user@example.com",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"last_seen_at": "2019-08-24T14:15:22Z",
2023-08-11 01:04:35 +00:00
"login_type": "",
2024-01-17 12:20:45 +00:00
"name": "string",
2023-01-11 15:05:42 +00:00
"organization_ids": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"],
"roles": [
{
"display_name": "string",
"name": "string"
}
],
"status": "active",
2023-12-14 17:38:44 +00:00
"theme_preference": "string",
2023-01-11 15:05:42 +00:00
"username": "string"
}
],
"name": "string",
"organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
2023-08-08 16:37:49 +00:00
"quota_allowance": 0,
"source": "user"
2023-01-11 15:05:42 +00:00
}
```
### Properties
2023-08-08 16:37:49 +00:00
| Name | Type | Required | Restrictions | Description |
| ----------------- | -------------------------------------------- | -------- | ------------ | ----------- |
| `avatar_url` | string | false | | |
| `display_name` | string | false | | |
| `id` | string | false | | |
| `members` | array of [codersdk.User ](#codersdkuser ) | false | | |
| `name` | string | false | | |
| `organization_id` | string | false | | |
| `quota_allowance` | integer | false | | |
| `source` | [codersdk.GroupSource ](#codersdkgroupsource ) | false | | |
## codersdk.GroupSource
```json
"user"
```
### Properties
#### Enumerated Values
| Value |
| ------ |
| `user` |
| `oidc` |
2023-01-11 15:05:42 +00:00
2023-12-05 20:00:27 +00:00
## codersdk.HealthSection
```json
"DERP"
```
### Properties
#### Enumerated Values
2024-01-08 09:29:04 +00:00
| Value |
| -------------------- |
| `DERP` |
| `AccessURL` |
| `Websocket` |
| `Database` |
| `WorkspaceProxy` |
| `ProvisionerDaemons` |
2023-12-05 20:00:27 +00:00
2023-11-28 17:15:17 +00:00
## codersdk.HealthSettings
```json
{
2023-12-05 20:00:27 +00:00
"dismissed_healthchecks": ["DERP"]
2023-11-28 17:15:17 +00:00
}
```
### Properties
2023-12-05 20:00:27 +00:00
| Name | Type | Required | Restrictions | Description |
| ------------------------ | --------------------------------------------------------- | -------- | ------------ | ----------- |
| `dismissed_healthchecks` | array of [codersdk.HealthSection ](#codersdkhealthsection ) | false | | |
2023-11-28 17:15:17 +00:00
2023-01-03 18:21:10 +00:00
## codersdk.Healthcheck
```json
{
"interval": 0,
"threshold": 0,
"url": "string"
}
```
### Properties
| Name | Type | Required | Restrictions | Description |
| ----------- | ------- | -------- | ------------ | ------------------------------------------------------------------------------------------------ |
| `interval` | integer | false | | Interval specifies the seconds between each health check. |
| `threshold` | integer | false | | Threshold specifies the number of consecutive failed health checks before returning "unhealthy". |
| `url` | string | false | | URL specifies the endpoint to check for the app health. |
2022-12-21 14:37:30 +00:00
2023-11-13 14:14:43 +00:00
## codersdk.HealthcheckConfig
```json
{
"refresh": 0,
"threshold_database": 0
}
```
### Properties
| Name | Type | Required | Restrictions | Description |
| -------------------- | ------- | -------- | ------------ | ----------- |
| `refresh` | integer | false | | |
| `threshold_database` | integer | false | | |
2023-07-21 18:00:19 +00:00
## codersdk.InsightsReportInterval
```json
"day"
```
### Properties
#### Enumerated Values
2023-09-19 11:06:19 +00:00
| Value |
| ------ |
| `day` |
| `week` |
2023-07-21 18:00:19 +00:00
2023-04-20 23:59:45 +00:00
## codersdk.IssueReconnectingPTYSignedTokenRequest
```json
{
"agentID": "bc282582-04f9-45ce-b904-3e3bfab66958",
"url": "string"
}
```
### Properties
| Name | Type | Required | Restrictions | Description |
| --------- | ------ | -------- | ------------ | ---------------------------------------------------------------------- |
| `agentID` | string | true | | |
| `url` | string | true | | URL is the URL of the reconnecting-pty endpoint you are connecting to. |
## codersdk.IssueReconnectingPTYSignedTokenResponse
```json
{
"signed_token": "string"
}
```
### Properties
| Name | Type | Required | Restrictions | Description |
| -------------- | ------ | -------- | ------------ | ----------- |
| `signed_token` | string | false | | |
2024-01-30 01:30:02 +00:00
## codersdk.JFrogXrayScan
```json
{
"agent_id": "2b1e3b65-2c04-4fa2-a2d7-467901e98978",
"critical": 0,
"high": 0,
"medium": 0,
"results_url": "string",
"workspace_id": "0967198e-ec7b-4c6b-b4d3-f71244cadbe9"
}
```
### Properties
| Name | Type | Required | Restrictions | Description |
| -------------- | ------- | -------- | ------------ | ----------- |
| `agent_id` | string | false | | |
| `critical` | integer | false | | |
| `high` | integer | false | | |
| `medium` | integer | false | | |
| `results_url` | string | false | | |
| `workspace_id` | string | false | | |
2023-03-08 15:32:00 +00:00
## codersdk.JobErrorCode
```json
2023-08-23 16:18:38 +00:00
"REQUIRED_TEMPLATE_VARIABLES"
2023-03-08 15:32:00 +00:00
```
### Properties
#### Enumerated Values
| Value |
| ----------------------------- |
| `REQUIRED_TEMPLATE_VARIABLES` |
2023-01-11 15:05:42 +00:00
## codersdk.License
```json
{
"claims": {},
"id": 0,
"uploaded_at": "2019-08-24T14:15:22Z",
"uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"
}
```
### Properties
| Name | Type | Required | Restrictions | Description |
| ------------- | ------- | -------- | ------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `claims` | object | false | | Claims are the JWT claims asserted by the license. Here we use a generic string map to ensure that all data from the server is parsed verbatim, not just the fields this version of Coder understands. |
| `id` | integer | false | | |
| `uploaded_at` | string | false | | |
| `uuid` | string | false | | |
2023-02-27 08:25:04 +00:00
## codersdk.LinkConfig
```json
{
2024-01-15 15:56:01 +00:00
"icon": "bug",
2023-02-27 08:25:04 +00:00
"name": "string",
"target": "string"
}
```
### Properties
| Name | Type | Required | Restrictions | Description |
| -------- | ------ | -------- | ------------ | ----------- |
| `icon` | string | false | | |
| `name` | string | false | | |
| `target` | string | false | | |
2024-01-15 15:56:01 +00:00
#### Enumerated Values
| Property | Value |
| -------- | ------ |
| `icon` | `bug` |
| `icon` | `chat` |
| `icon` | `docs` |
2023-01-10 14:47:08 +00:00
## codersdk.LogLevel
```json
"trace"
```
### Properties
#### Enumerated Values
| Value |
| ------- |
| `trace` |
| `debug` |
| `info` |
| `warn` |
| `error` |
## codersdk.LogSource
```json
"provisioner_daemon"
```
### Properties
#### Enumerated Values
| Value |
| -------------------- |
| `provisioner_daemon` |
| `provisioner` |
2023-01-13 02:08:23 +00:00
## codersdk.LoggingConfig
```json
{
2023-03-07 21:10:01 +00:00
"human": "string",
"json": "string",
2023-07-26 21:46:22 +00:00
"log_filter": ["string"],
2023-03-07 21:10:01 +00:00
"stackdriver": "string"
2023-01-13 02:08:23 +00:00
}
```
### Properties
2023-07-26 21:46:22 +00:00
| Name | Type | Required | Restrictions | Description |
| ------------- | --------------- | -------- | ------------ | ----------- |
| `human` | string | false | | |
| `json` | string | false | | |
| `log_filter` | array of string | false | | |
| `stackdriver` | string | false | | |
2023-01-13 02:08:23 +00:00
2023-01-11 13:08:04 +00:00
## codersdk.LoginType
```json
2023-08-11 01:04:35 +00:00
""
2023-01-11 13:08:04 +00:00
```
### Properties
#### Enumerated Values
| Value |
| ---------- |
2023-08-11 01:04:35 +00:00
| `` |
2023-01-11 13:08:04 +00:00
| `password` |
| `github` |
| `oidc` |
| `token` |
2023-06-14 17:48:43 +00:00
| `none` |
2023-01-11 13:08:04 +00:00
## codersdk.LoginWithPasswordRequest
```json
{
"email": "user@example.com",
"password": "string"
}
```
### Properties
| Name | Type | Required | Restrictions | Description |
| ---------- | ------ | -------- | ------------ | ----------- |
| `email` | string | true | | |
| `password` | string | true | | |
## codersdk.LoginWithPasswordResponse
```json
{
"session_token": "string"
}
```
### Properties
| Name | Type | Required | Restrictions | Description |
| --------------- | ------ | -------- | ------------ | ----------- |
| `session_token` | string | true | | |
2023-07-25 13:14:38 +00:00
## codersdk.MinimalUser
```json
{
"avatar_url": "http://example.com",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"username": "string"
}
```
### Properties
| Name | Type | Required | Restrictions | Description |
| ------------ | ------ | -------- | ------------ | ----------- |
| `avatar_url` | string | false | | |
| `id` | string | true | | |
| `username` | string | true | | |
2024-01-22 22:25:25 +00:00
## codersdk.OAuth2AppEndpoints
```json
{
"authorization": "string",
"device_authorization": "string",
"token": "string"
}
```
### Properties
| Name | Type | Required | Restrictions | Description |
| ---------------------- | ------ | -------- | ------------ | --------------------------------- |
| `authorization` | string | false | | |
| `device_authorization` | string | false | | Device authorization is optional. |
| `token` | string | false | | |
2023-01-03 18:21:10 +00:00
## codersdk.OAuth2Config
2022-12-21 14:37:30 +00:00
```json
{
2023-01-03 18:21:10 +00:00
"github": {
2023-03-07 21:10:01 +00:00
"allow_everyone": true,
"allow_signups": true,
"allowed_orgs": ["string"],
"allowed_teams": ["string"],
"client_id": "string",
"client_secret": "string",
"enterprise_base_url": "string"
2022-12-21 14:37:30 +00:00
}
}
```
### Properties
2023-01-03 18:21:10 +00:00
| Name | Type | Required | Restrictions | Description |
| -------- | ---------------------------------------------------------- | -------- | ------------ | ----------- |
| `github` | [codersdk.OAuth2GithubConfig ](#codersdkoauth2githubconfig ) | false | | |
2022-12-21 14:37:30 +00:00
2023-01-03 18:21:10 +00:00
## codersdk.OAuth2GithubConfig
2022-12-21 14:37:30 +00:00
```json
{
2023-03-07 21:10:01 +00:00
"allow_everyone": true,
"allow_signups": true,
"allowed_orgs": ["string"],
"allowed_teams": ["string"],
"client_id": "string",
"client_secret": "string",
"enterprise_base_url": "string"
2022-12-21 14:37:30 +00:00
}
```
### Properties
2023-03-07 21:10:01 +00:00
| Name | Type | Required | Restrictions | Description |
| --------------------- | --------------- | -------- | ------------ | ----------- |
| `allow_everyone` | boolean | false | | |
| `allow_signups` | boolean | false | | |
| `allowed_orgs` | array of string | false | | |
| `allowed_teams` | array of string | false | | |
| `client_id` | string | false | | |
| `client_secret` | string | false | | |
| `enterprise_base_url` | string | false | | |
2022-12-21 14:37:30 +00:00
2023-12-21 21:38:42 +00:00
## codersdk.OAuth2ProviderApp
```json
{
"callback_url": "string",
2024-01-22 22:25:25 +00:00
"endpoints": {
"authorization": "string",
"device_authorization": "string",
"token": "string"
},
2023-12-21 21:38:42 +00:00
"icon": "string",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string"
}
```
### Properties
2024-01-22 22:25:25 +00:00
| Name | Type | Required | Restrictions | Description |
| -------------- | ---------------------------------------------------------- | -------- | ------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `callback_url` | string | false | | |
| `endpoints` | [codersdk.OAuth2AppEndpoints ](#codersdkoauth2appendpoints ) | false | | Endpoints are included in the app response for easier discovery. The OAuth2 spec does not have a defined place to find these (for comparison, OIDC has a '/.well-known/openid-configuration' endpoint). |
| `icon` | string | false | | |
| `id` | string | false | | |
| `name` | string | false | | |
2023-12-21 21:38:42 +00:00
## codersdk.OAuth2ProviderAppSecret
```json
{
"client_secret_truncated": "string",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"last_used_at": "string"
}
```
### Properties
| Name | Type | Required | Restrictions | Description |
| ------------------------- | ------ | -------- | ------------ | ----------- |
| `client_secret_truncated` | string | false | | |
| `id` | string | false | | |
| `last_used_at` | string | false | | |
## codersdk.OAuth2ProviderAppSecretFull
```json
{
"client_secret_full": "string",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
```
### Properties
| Name | Type | Required | Restrictions | Description |
| -------------------- | ------ | -------- | ------------ | ----------- |
| `client_secret_full` | string | false | | |
| `id` | string | false | | |
2023-06-30 12:38:48 +00:00
## codersdk.OAuthConversionResponse
```json
{
"expires_at": "2019-08-24T14:15:22Z",
"state_string": "string",
2023-08-11 01:04:35 +00:00
"to_type": "",
2023-06-30 12:38:48 +00:00
"user_id": "a169451c-8525-4352-b8ca-070dd449a1a5"
}
```
### Properties
| Name | Type | Required | Restrictions | Description |
| -------------- | ---------------------------------------- | -------- | ------------ | ----------- |
| `expires_at` | string | false | | |
| `state_string` | string | false | | |
| `to_type` | [codersdk.LoginType ](#codersdklogintype ) | false | | |
| `user_id` | string | false | | |
2023-01-31 18:33:25 +00:00
## codersdk.OIDCAuthMethod
```json
{
"enabled": true,
"iconUrl": "string",
"signInText": "string"
}
```
### Properties
| Name | Type | Required | Restrictions | Description |
| ------------ | ------- | -------- | ------------ | ----------- |
| `enabled` | boolean | false | | |
| `iconUrl` | string | false | | |
| `signInText` | string | false | | |
2023-01-03 18:21:10 +00:00
## codersdk.OIDCConfig
2022-12-22 14:53:14 +00:00
```json
{
2023-03-07 21:10:01 +00:00
"allow_signups": true,
2023-03-30 08:36:57 +00:00
"auth_url_params": {},
2023-08-14 22:33:13 +00:00
"client_cert_file": "string",
2023-03-07 21:10:01 +00:00
"client_id": "string",
2023-08-14 22:33:13 +00:00
"client_key_file": "string",
2023-03-07 21:10:01 +00:00
"client_secret": "string",
"email_domain": ["string"],
2023-03-30 08:36:57 +00:00
"email_field": "string",
2023-12-08 16:14:19 +00:00
"group_allow_list": ["string"],
2023-08-08 16:37:49 +00:00
"group_auto_create": true,
2023-03-21 19:25:45 +00:00
"group_mapping": {},
2023-08-08 16:37:49 +00:00
"group_regex_filter": {},
2023-03-10 05:31:38 +00:00
"groups_field": "string",
2023-01-31 18:33:25 +00:00
"icon_url": {
2023-03-07 21:10:01 +00:00
"forceQuery": true,
"fragment": "string",
"host": "string",
"omitHost": true,
"opaque": "string",
"path": "string",
"rawFragment": "string",
"rawPath": "string",
"rawQuery": "string",
"scheme": "string",
"user": {}
2023-01-04 21:16:31 +00:00
},
2023-03-07 21:10:01 +00:00
"ignore_email_verified": true,
2023-04-05 08:07:43 +00:00
"ignore_user_info": true,
2023-03-07 21:10:01 +00:00
"issuer_url": "string",
"scopes": ["string"],
"sign_in_text": "string",
2024-02-01 17:01:25 +00:00
"signups_disabled_text": "string",
2023-07-24 12:34:24 +00:00
"user_role_field": "string",
"user_role_mapping": {},
"user_roles_default": ["string"],
2023-03-07 21:10:01 +00:00
"username_field": "string"
2022-12-22 14:53:14 +00:00
}
```
### Properties
2023-08-14 22:33:13 +00:00
| Name | Type | Required | Restrictions | Description |
| ----------------------- | -------------------------------- | -------- | ------------ | -------------------------------------------------------------------------------- |
| `allow_signups` | boolean | false | | |
| `auth_url_params` | object | false | | |
| `client_cert_file` | string | false | | |
| `client_id` | string | false | | |
| `client_key_file` | string | false | | Client key file & ClientCertFile are used in place of ClientSecret for PKI auth. |
| `client_secret` | string | false | | |
| `email_domain` | array of string | false | | |
| `email_field` | string | false | | |
2023-12-08 16:14:19 +00:00
| `group_allow_list` | array of string | false | | |
2023-08-14 22:33:13 +00:00
| `group_auto_create` | boolean | false | | |
| `group_mapping` | object | false | | |
| `group_regex_filter` | [clibase.Regexp ](#clibaseregexp ) | false | | |
| `groups_field` | string | false | | |
| `icon_url` | [clibase.URL ](#clibaseurl ) | false | | |
| `ignore_email_verified` | boolean | false | | |
| `ignore_user_info` | boolean | false | | |
| `issuer_url` | string | false | | |
| `scopes` | array of string | false | | |
| `sign_in_text` | string | false | | |
2024-02-01 17:01:25 +00:00
| `signups_disabled_text` | string | false | | |
2023-08-14 22:33:13 +00:00
| `user_role_field` | string | false | | |
| `user_role_mapping` | object | false | | |
| `user_roles_default` | array of string | false | | |
| `username_field` | string | false | | |
2022-12-22 14:53:14 +00:00
2023-01-11 11:16:09 +00:00
## codersdk.Organization
```json
{
"created_at": "2019-08-24T14:15:22Z",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"updated_at": "2019-08-24T14:15:22Z"
}
```
### Properties
| Name | Type | Required | Restrictions | Description |
| ------------ | ------ | -------- | ------------ | ----------- |
| `created_at` | string | true | | |
| `id` | string | true | | |
| `name` | string | true | | |
| `updated_at` | string | true | | |
## codersdk.OrganizationMember
```json
{
"created_at": "2019-08-24T14:15:22Z",
"organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
"roles": [
{
"display_name": "string",
"name": "string"
}
],
"updated_at": "2019-08-24T14:15:22Z",
"user_id": "a169451c-8525-4352-b8ca-070dd449a1a5"
}
```
### Properties
| Name | Type | Required | Restrictions | Description |
| ----------------- | --------------------------------------- | -------- | ------------ | ----------- |
| `created_at` | string | false | | |
| `organization_id` | string | false | | |
| `roles` | array of [codersdk.Role ](#codersdkrole ) | false | | |
| `updated_at` | string | false | | |
| `user_id` | string | false | | |
2023-08-15 15:29:15 +00:00
## codersdk.PatchGroupRequest
```json
{
"add_users": ["string"],
"avatar_url": "string",
"display_name": "string",
"name": "string",
"quota_allowance": 0,
"remove_users": ["string"]
}
```
### Properties
| Name | Type | Required | Restrictions | Description |
| ----------------- | --------------- | -------- | ------------ | ----------- |
| `add_users` | array of string | false | | |
| `avatar_url` | string | false | | |
| `display_name` | string | false | | |
| `name` | string | false | | |
| `quota_allowance` | integer | false | | |
| `remove_users` | array of string | false | | |
2023-03-23 16:26:50 +00:00
## codersdk.PatchTemplateVersionRequest
```json
{
2023-07-13 13:36:10 +00:00
"message": "string",
2023-03-23 16:26:50 +00:00
"name": "string"
}
```
### Properties
2023-07-13 13:36:10 +00:00
| Name | Type | Required | Restrictions | Description |
| --------- | ------ | -------- | ------------ | ----------- |
| `message` | string | false | | |
| `name` | string | false | | |
2023-03-23 16:26:50 +00:00
2023-05-09 18:46:50 +00:00
## codersdk.PatchWorkspaceProxy
```json
{
"display_name": "string",
"icon": "string",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"regenerate_token": true
}
```
### Properties
| Name | Type | Required | Restrictions | Description |
| ------------------ | ------- | -------- | ------------ | ----------- |
| `display_name` | string | true | | |
| `icon` | string | true | | |
| `id` | string | true | | |
| `name` | string | true | | |
| `regenerate_token` | boolean | false | | |
2023-12-21 21:38:42 +00:00
## codersdk.PostOAuth2ProviderAppRequest
```json
{
"callback_url": "string",
"icon": "string",
"name": "string"
}
```
### Properties
| Name | Type | Required | Restrictions | Description |
| -------------- | ------ | -------- | ------------ | ----------- |
| `callback_url` | string | true | | |
| `icon` | string | false | | |
| `name` | string | true | | |
2023-01-03 18:21:10 +00:00
## codersdk.PprofConfig
2022-12-19 17:43:46 +00:00
```json
{
2023-01-03 18:21:10 +00:00
"address": {
2023-03-07 21:10:01 +00:00
"host": "string",
"port": "string"
2023-01-03 18:21:10 +00:00
},
2023-03-07 21:10:01 +00:00
"enable": true
2022-12-19 17:43:46 +00:00
}
```
### Properties
2023-03-07 21:10:01 +00:00
| Name | Type | Required | Restrictions | Description |
| --------- | ------------------------------------ | -------- | ------------ | ----------- |
| `address` | [clibase.HostPort ](#clibasehostport ) | false | | |
| `enable` | boolean | false | | |
2022-12-21 14:37:30 +00:00
2023-01-03 18:21:10 +00:00
## codersdk.PrometheusConfig
2022-12-21 14:37:30 +00:00
```json
{
2023-01-03 18:21:10 +00:00
"address": {
2023-03-07 21:10:01 +00:00
"host": "string",
"port": "string"
2023-01-03 18:21:10 +00:00
},
2023-04-14 14:14:52 +00:00
"collect_agent_stats": true,
2023-06-15 11:34:16 +00:00
"collect_db_metrics": true,
2023-03-07 21:10:01 +00:00
"enable": true
2022-12-21 14:37:30 +00:00
}
```
### Properties
2023-04-14 14:14:52 +00:00
| Name | Type | Required | Restrictions | Description |
| --------------------- | ------------------------------------ | -------- | ------------ | ----------- |
| `address` | [clibase.HostPort ](#clibasehostport ) | false | | |
| `collect_agent_stats` | boolean | false | | |
2023-06-15 11:34:16 +00:00
| `collect_db_metrics` | boolean | false | | |
2023-04-14 14:14:52 +00:00
| `enable` | boolean | false | | |
2022-12-19 17:43:46 +00:00
2023-01-03 18:21:10 +00:00
## codersdk.ProvisionerConfig
2022-12-19 17:43:46 +00:00
```json
{
2023-03-07 21:10:01 +00:00
"daemon_poll_interval": 0,
"daemon_poll_jitter": 0,
2023-08-04 08:32:28 +00:00
"daemon_psk": "string",
2023-03-07 21:10:01 +00:00
"daemons": 0,
2023-06-22 00:21:40 +00:00
"daemons_echo": true,
2023-03-07 21:10:01 +00:00
"force_cancel_interval": 0
2022-12-19 17:43:46 +00:00
}
```
### Properties
2023-03-07 21:10:01 +00:00
| Name | Type | Required | Restrictions | Description |
| ----------------------- | ------- | -------- | ------------ | ----------- |
| `daemon_poll_interval` | integer | false | | |
| `daemon_poll_jitter` | integer | false | | |
2023-08-04 08:32:28 +00:00
| `daemon_psk` | string | false | | |
2023-03-07 21:10:01 +00:00
| `daemons` | integer | false | | |
2023-06-22 00:21:40 +00:00
| `daemons_echo` | boolean | false | | |
2023-03-07 21:10:01 +00:00
| `force_cancel_interval` | integer | false | | |
2022-12-19 17:43:46 +00:00
2023-01-11 15:05:42 +00:00
## codersdk.ProvisionerDaemon
```json
{
2024-01-03 09:01:57 +00:00
"api_version": "string",
2023-01-11 15:05:42 +00:00
"created_at": "2019-08-24T14:15:22Z",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
2023-12-05 13:54:38 +00:00
"last_seen_at": "2019-08-24T14:15:22Z",
2023-01-11 15:05:42 +00:00
"name": "string",
"provisioners": ["string"],
"tags": {
"property1": "string",
"property2": "string"
},
2023-12-05 13:54:38 +00:00
"version": "string"
2023-01-11 15:05:42 +00:00
}
```
### Properties
2023-12-05 15:40:45 +00:00
| Name | Type | Required | Restrictions | Description |
| ------------------ | --------------- | -------- | ------------ | ----------- |
2024-01-03 09:01:57 +00:00
| `api_version` | string | false | | |
2023-12-05 15:40:45 +00:00
| `created_at` | string | false | | |
| `id` | string | false | | |
| `last_seen_at` | string | false | | |
| `name` | string | false | | |
| `provisioners` | array of string | false | | |
| `tags` | object | false | | |
| » `[any property]` | string | false | | |
| `version` | string | false | | |
2023-01-11 15:05:42 +00:00
2022-12-19 17:43:46 +00:00
## codersdk.ProvisionerJob
```json
{
2023-01-05 14:27:10 +00:00
"canceled_at": "2019-08-24T14:15:22Z",
"completed_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z",
2022-12-19 17:43:46 +00:00
"error": "string",
2023-08-23 16:18:38 +00:00
"error_code": "REQUIRED_TEMPLATE_VARIABLES",
2023-01-05 14:27:10 +00:00
"file_id": "8a0cfb4f-ddc9-436d-91bb-75133c583767",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
2023-06-20 20:07:18 +00:00
"queue_position": 0,
"queue_size": 0,
2023-01-05 14:27:10 +00:00
"started_at": "2019-08-24T14:15:22Z",
"status": "pending",
2022-12-19 17:43:46 +00:00
"tags": {
"property1": "string",
"property2": "string"
},
2023-01-05 14:27:10 +00:00
"worker_id": "ae5fa6f7-c55b-40c1-b40a-b36ac467652b"
2022-12-19 17:43:46 +00:00
}
```
### Properties
2023-01-10 14:47:08 +00:00
| Name | Type | Required | Restrictions | Description |
| ------------------ | -------------------------------------------------------------- | -------- | ------------ | ----------- |
| `canceled_at` | string | false | | |
| `completed_at` | string | false | | |
| `created_at` | string | false | | |
| `error` | string | false | | |
2023-03-08 15:32:00 +00:00
| `error_code` | [codersdk.JobErrorCode ](#codersdkjoberrorcode ) | false | | |
2023-01-10 14:47:08 +00:00
| `file_id` | string | false | | |
| `id` | string | false | | |
2023-06-20 20:07:18 +00:00
| `queue_position` | integer | false | | |
| `queue_size` | integer | false | | |
2023-01-10 14:47:08 +00:00
| `started_at` | string | false | | |
| `status` | [codersdk.ProvisionerJobStatus ](#codersdkprovisionerjobstatus ) | false | | |
| `tags` | object | false | | |
| » `[any property]` | string | false | | |
| `worker_id` | string | false | | |
2022-12-19 17:43:46 +00:00
2023-01-05 14:27:10 +00:00
#### Enumerated Values
2023-03-08 15:32:00 +00:00
| Property | Value |
| ------------ | ----------------------------- |
| `error_code` | `REQUIRED_TEMPLATE_VARIABLES` |
| `status` | `pending` |
| `status` | `running` |
| `status` | `succeeded` |
| `status` | `canceling` |
| `status` | `canceled` |
| `status` | `failed` |
2023-01-05 14:27:10 +00:00
## codersdk.ProvisionerJobLog
```json
{
"created_at": "2019-08-24T14:15:22Z",
"id": 0,
"log_level": "trace",
2023-01-10 14:47:08 +00:00
"log_source": "provisioner_daemon",
2023-01-05 14:27:10 +00:00
"output": "string",
"stage": "string"
}
```
### Properties
2023-01-10 14:47:08 +00:00
| Name | Type | Required | Restrictions | Description |
| ------------ | ---------------------------------------- | -------- | ------------ | ----------- |
| `created_at` | string | false | | |
| `id` | integer | false | | |
| `log_level` | [codersdk.LogLevel ](#codersdkloglevel ) | false | | |
| `log_source` | [codersdk.LogSource ](#codersdklogsource ) | false | | |
| `output` | string | false | | |
| `stage` | string | false | | |
2023-01-05 14:27:10 +00:00
#### Enumerated Values
| Property | Value |
| ----------- | ------- |
| `log_level` | `trace` |
| `log_level` | `debug` |
| `log_level` | `info` |
| `log_level` | `warn` |
| `log_level` | `error` |
2023-01-10 14:47:08 +00:00
## codersdk.ProvisionerJobStatus
```json
"pending"
```
### Properties
#### Enumerated Values
| Value |
| ----------- |
| `pending` |
| `running` |
| `succeeded` |
| `canceling` |
| `canceled` |
| `failed` |
2023-10-05 01:57:46 +00:00
| `unknown` |
2023-01-10 14:47:08 +00:00
2023-03-30 14:00:33 +00:00
## codersdk.ProvisionerLogLevel
```json
"debug"
```
### Properties
#### Enumerated Values
| Value |
| ------- |
| `debug` |
2023-03-02 13:11:16 +00:00
## codersdk.ProvisionerStorageMethod
```json
"file"
```
### Properties
#### Enumerated Values
| Value |
| ------ |
| `file` |
2023-04-24 15:25:35 +00:00
## codersdk.ProxyHealthReport
```json
{
"errors": ["string"],
"warnings": ["string"]
}
```
### Properties
| Name | Type | Required | Restrictions | Description |
| ---------- | --------------- | -------- | ------------ | ---------------------------------------------------------------------------------------- |
| `errors` | array of string | false | | Errors are problems that prevent the workspace proxy from being healthy |
| `warnings` | array of string | false | | Warnings do not prevent the workspace proxy from being healthy, but should be addressed. |
## codersdk.ProxyHealthStatus
```json
2023-05-11 00:23:16 +00:00
"ok"
2023-04-24 15:25:35 +00:00
```
### Properties
#### Enumerated Values
| Value |
| -------------- |
2023-05-11 00:23:16 +00:00
| `ok` |
2023-04-24 15:25:35 +00:00
| `unreachable` |
| `unhealthy` |
| `unregistered` |
2022-12-19 17:43:46 +00:00
## codersdk.PutExtendWorkspaceRequest
```json
{
2023-01-13 11:27:21 +00:00
"deadline": "2019-08-24T14:15:22Z"
2022-12-19 17:43:46 +00:00
}
```
### Properties
| Name | Type | Required | Restrictions | Description |
| ---------- | ------ | -------- | ------------ | ----------- |
2022-12-21 14:37:30 +00:00
| `deadline` | string | true | | |
2022-12-19 17:43:46 +00:00
2023-12-21 21:38:42 +00:00
## codersdk.PutOAuth2ProviderAppRequest
```json
{
"callback_url": "string",
"icon": "string",
"name": "string"
}
```
### Properties
| Name | Type | Required | Restrictions | Description |
| -------------- | ------ | -------- | ------------ | ----------- |
| `callback_url` | string | true | | |
| `icon` | string | false | | |
| `name` | string | true | | |
2023-04-11 13:57:23 +00:00
## codersdk.RBACResource
```json
"workspace"
```
### Properties
#### Enumerated Values
2024-01-30 22:02:21 +00:00
| Value |
| --------------------------------- |
| `workspace` |
| `workspace_proxy` |
| `workspace_execution` |
| `application_connect` |
| `audit_log` |
| `template` |
| `group` |
| `file` |
| `provisioner_daemon` |
| `organization` |
| `assign_role` |
| `assign_org_role` |
| `api_key` |
| `user` |
| `user_data` |
| `user_workspace_build_parameters` |
| `organization_member` |
| `license` |
| `deployment_config` |
| `deployment_stats` |
| `replicas` |
| `debug_info` |
| `system` |
| `template_insights` |
2023-04-11 13:57:23 +00:00
2023-01-05 18:05:20 +00:00
## codersdk.RateLimitConfig
```json
{
2023-03-07 21:10:01 +00:00
"api": 0,
"disable_all": true
2023-01-05 18:05:20 +00:00
}
```
### Properties
2023-03-07 21:10:01 +00:00
| Name | Type | Required | Restrictions | Description |
| ------------- | ------- | -------- | ------------ | ----------- |
| `api` | integer | false | | |
| `disable_all` | boolean | false | | |
2023-01-05 18:05:20 +00:00
2023-04-25 14:37:52 +00:00
## codersdk.Region
```json
{
"display_name": "string",
"healthy": true,
"icon_url": "string",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"path_app_url": "string",
"wildcard_hostname": "string"
}
```
### Properties
| Name | Type | Required | Restrictions | Description |
| ------------------- | ------- | -------- | ------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `display_name` | string | false | | |
| `healthy` | boolean | false | | |
| `icon_url` | string | false | | |
| `id` | string | false | | |
| `name` | string | false | | |
| `path_app_url` | string | false | | Path app URL is the URL to the base path for path apps. Optional unless wildcard_hostname is set. E.g. https://us.example.com |
| `wildcard_hostname` | string | false | | Wildcard hostname is the wildcard hostname for subdomain apps. E.g. _.us.example.com E.g. _ --suffix.au.example.com Optional. Does not need to be on the same domain as PathAppURL. |
2023-06-30 15:32:35 +00:00
## codersdk.RegionsResponse-codersdk_Region
2023-04-25 14:37:52 +00:00
```json
{
"regions": [
{
"display_name": "string",
"healthy": true,
"icon_url": "string",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"path_app_url": "string",
"wildcard_hostname": "string"
}
]
}
```
### Properties
| Name | Type | Required | Restrictions | Description |
| --------- | ------------------------------------------- | -------- | ------------ | ----------- |
| `regions` | array of [codersdk.Region ](#codersdkregion ) | false | | |
2023-06-30 15:32:35 +00:00
## codersdk.RegionsResponse-codersdk_WorkspaceProxy
```json
{
"regions": [
{
"created_at": "2019-08-24T14:15:22Z",
"deleted": true,
2023-07-26 16:21:04 +00:00
"derp_enabled": true,
2023-08-02 14:35:06 +00:00
"derp_only": true,
2023-06-30 15:32:35 +00:00
"display_name": "string",
"healthy": true,
"icon_url": "string",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"path_app_url": "string",
"status": {
"checked_at": "2019-08-24T14:15:22Z",
"report": {
"errors": ["string"],
"warnings": ["string"]
},
"status": "ok"
},
"updated_at": "2019-08-24T14:15:22Z",
2023-11-21 11:21:25 +00:00
"version": "string",
2023-06-30 15:32:35 +00:00
"wildcard_hostname": "string"
}
]
}
```
### Properties
| Name | Type | Required | Restrictions | Description |
| --------- | ----------------------------------------------------------- | -------- | ------------ | ----------- |
| `regions` | array of [codersdk.WorkspaceProxy ](#codersdkworkspaceproxy ) | false | | |
2023-01-11 15:05:42 +00:00
## codersdk.Replica
```json
{
"created_at": "2019-08-24T14:15:22Z",
"database_latency": 0,
"error": "string",
"hostname": "string",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"region_id": 0,
"relay_address": "string"
}
```
### Properties
| Name | Type | Required | Restrictions | Description |
| ------------------ | ------- | -------- | ------------ | ------------------------------------------------------------------ |
| `created_at` | string | false | | Created at is the timestamp when the replica was first seen. |
| `database_latency` | integer | false | | Database latency is the latency in microseconds to the database. |
| `error` | string | false | | Error is the replica error. |
| `hostname` | string | false | | Hostname is the hostname of the replica. |
| `id` | string | false | | ID is the unique identifier for the replica. |
| `region_id` | integer | false | | Region ID is the region of the replica. |
| `relay_address` | string | false | | Relay address is the accessible address to relay DERP connections. |
2023-11-09 05:24:56 +00:00
## codersdk.ResolveAutostartResponse
```json
{
"parameter_mismatch": true
}
```
### Properties
| Name | Type | Required | Restrictions | Description |
| -------------------- | ------- | -------- | ------------ | ----------- |
| `parameter_mismatch` | boolean | false | | |
2023-01-10 14:47:08 +00:00
## codersdk.ResourceType
```json
2023-01-26 23:14:09 +00:00
"template"
2023-01-10 14:47:08 +00:00
```
### Properties
#### Enumerated Values
| Value |
| ------------------ |
| `template` |
| `template_version` |
| `user` |
| `workspace` |
| `workspace_build` |
| `git_ssh_key` |
| `api_key` |
| `group` |
2023-02-14 21:34:13 +00:00
| `license` |
2023-06-30 12:38:48 +00:00
| `convert_login` |
2023-11-28 17:15:17 +00:00
| `health_settings` |
2023-08-21 15:53:41 +00:00
| `workspace_proxy` |
| `organization` |
2023-01-10 14:47:08 +00:00
2022-12-19 17:43:46 +00:00
## codersdk.Response
```json
{
"detail": "string",
"message": "string",
"validations": [
{
"detail": "string",
"field": "string"
}
]
}
```
### Properties
2022-12-21 14:37:30 +00:00
| Name | Type | Required | Restrictions | Description |
| ------------- | ------------------------------------------------------------- | -------- | ------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `detail` | string | false | | Detail is a debug message that provides further insight into why the action failed. This information can be technical and a regular golang err.Error() text. - "database: too many open connections" - "stat: too many open files" |
| `message` | string | false | | Message is an actionable message that depicts actions the request took. These messages should be fully formed sentences with proper punctuation. Examples: - "A user has been created." - "Failed to create a user." |
| `validations` | array of [codersdk.ValidationError ](#codersdkvalidationerror ) | false | | Validations are form field-specific friendly error messages. They will be shown on a form field in the UI. These can also be used to add additional context if there is a set of errors in the primary 'Message'. |
2022-12-19 17:43:46 +00:00
2023-01-03 18:21:10 +00:00
## codersdk.Role
```json
{
"display_name": "string",
"name": "string"
}
```
### Properties
| Name | Type | Required | Restrictions | Description |
| -------------- | ------ | -------- | ------------ | ----------- |
| `display_name` | string | false | | |
| `name` | string | false | | |
2023-03-16 18:03:37 +00:00
## codersdk.SSHConfig
```json
{
"deploymentName": "string",
"sshconfigOptions": ["string"]
}
```
### Properties
| Name | Type | Required | Restrictions | Description |
| ------------------ | --------------- | -------- | ------------ | --------------------------------------------------------------------------------------------------- |
| `deploymentName` | string | false | | Deploymentname is the config-ssh Hostname prefix |
| `sshconfigOptions` | array of string | false | | Sshconfigoptions are additional options to add to the ssh config file. This will override defaults. |
## codersdk.SSHConfigResponse
```json
{
"hostname_prefix": "string",
"ssh_config_options": {
"property1": "string",
"property2": "string"
}
}
```
### Properties
| Name | Type | Required | Restrictions | Description |
| -------------------- | ------ | -------- | ------------ | ----------- |
| `hostname_prefix` | string | false | | |
| `ssh_config_options` | object | false | | |
| » `[any property]` | string | false | | |
2023-01-11 15:05:42 +00:00
## codersdk.ServiceBannerConfig
```json
{
"background_color": "string",
"enabled": true,
"message": "string"
}
```
### Properties
| Name | Type | Required | Restrictions | Description |
| ------------------ | ------- | -------- | ------------ | ----------- |
| `background_color` | string | false | | |
| `enabled` | boolean | false | | |
| `message` | string | false | | |
2023-03-09 03:05:45 +00:00
## codersdk.SessionCountDeploymentStats
```json
{
"jetbrains": 0,
"reconnecting_pty": 0,
"ssh": 0,
"vscode": 0
}
```
### Properties
| Name | Type | Required | Restrictions | Description |
| ------------------ | ------- | -------- | ------------ | ----------- |
| `jetbrains` | integer | false | | |
| `reconnecting_pty` | integer | false | | |
| `ssh` | integer | false | | |
| `vscode` | integer | false | | |
2023-02-27 08:25:04 +00:00
## codersdk.SupportConfig
```json
{
"links": {
"value": [
{
2024-01-15 15:56:01 +00:00
"icon": "bug",
2023-02-27 08:25:04 +00:00
"name": "string",
"target": "string"
}
]
}
}
```
### Properties
2023-03-07 21:10:01 +00:00
| Name | Type | Required | Restrictions | Description |
| ------- | ------------------------------------------------------------------------------------ | -------- | ------------ | ----------- |
| `links` | [clibase.Struct-array_codersdk_LinkConfig ](#clibasestruct-array_codersdk_linkconfig ) | false | | |
2023-02-27 08:25:04 +00:00
2023-01-03 18:21:10 +00:00
## codersdk.SwaggerConfig
```json
{
2023-03-07 21:10:01 +00:00
"enable": true
2023-01-03 18:21:10 +00:00
}
```
### Properties
2023-03-07 21:10:01 +00:00
| Name | Type | Required | Restrictions | Description |
| -------- | ------- | -------- | ------------ | ----------- |
| `enable` | boolean | false | | |
2023-01-03 18:21:10 +00:00
## codersdk.TLSConfig
```json
{
"address": {
2023-03-07 21:10:01 +00:00
"host": "string",
"port": "string"
2023-01-03 18:21:10 +00:00
},
2023-11-07 14:55:39 +00:00
"allow_insecure_ciphers": true,
2023-03-07 21:10:01 +00:00
"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",
2023-11-07 14:55:39 +00:00
"redirect_http": true,
"supported_ciphers": ["string"]
2023-01-03 18:21:10 +00:00
}
```
### Properties
2023-11-07 14:55:39 +00:00
| Name | Type | Required | Restrictions | Description |
| ------------------------ | ------------------------------------ | -------- | ------------ | ----------- |
| `address` | [clibase.HostPort ](#clibasehostport ) | false | | |
| `allow_insecure_ciphers` | boolean | false | | |
| `cert_file` | array of string | false | | |
| `client_auth` | string | false | | |
| `client_ca_file` | string | false | | |
| `client_cert_file` | string | false | | |
| `client_key_file` | string | false | | |
| `enable` | boolean | false | | |
| `key_file` | array of string | false | | |
| `min_version` | string | false | | |
| `redirect_http` | boolean | false | | |
| `supported_ciphers` | array of string | false | | |
2023-01-03 18:21:10 +00:00
## codersdk.TelemetryConfig
```json
{
2023-03-07 21:10:01 +00:00
"enable": true,
"trace": true,
2023-01-03 18:21:10 +00:00
"url": {
2023-03-07 21:10:01 +00:00
"forceQuery": true,
"fragment": "string",
"host": "string",
"omitHost": true,
"opaque": "string",
"path": "string",
"rawFragment": "string",
"rawPath": "string",
"rawQuery": "string",
"scheme": "string",
"user": {}
2023-01-03 18:21:10 +00:00
}
}
```
### Properties
2023-03-07 21:10:01 +00:00
| Name | Type | Required | Restrictions | Description |
| -------- | -------------------------- | -------- | ------------ | ----------- |
| `enable` | boolean | false | | |
| `trace` | boolean | false | | |
| `url` | [clibase.URL ](#clibaseurl ) | false | | |
2023-01-03 18:21:10 +00:00
2022-12-19 17:43:46 +00:00
## codersdk.Template
```json
{
"active_user_count": 0,
2023-01-11 13:08:04 +00:00
"active_version_id": "eae64611-bd53-4a80-bb77-df1e432c0fbc",
2024-02-13 07:00:35 +00:00
"activity_bump_ms": 0,
2023-04-04 12:48:35 +00:00
"allow_user_autostart": true,
"allow_user_autostop": true,
2022-12-19 17:43:46 +00:00
"allow_user_cancel_workspace_jobs": true,
2023-10-13 16:57:18 +00:00
"autostart_requirement": {
"days_of_week": ["monday"]
},
2023-08-29 18:35:05 +00:00
"autostop_requirement": {
"days_of_week": ["monday"],
"weeks": 0
},
2022-12-19 17:43:46 +00:00
"build_time_stats": {
"property1": {
"p50": 123,
"p95": 146
},
"property2": {
"p50": 123,
"p95": 146
}
},
"created_at": "2019-08-24T14:15:22Z",
"created_by_id": "9377d689-01fb-4abf-8450-3368d2c1924f",
"created_by_name": "string",
"default_ttl_ms": 0,
2023-11-20 19:16:18 +00:00
"deprecated": true,
"deprecation_message": "string",
2022-12-19 17:43:46 +00:00
"description": "string",
"display_name": "string",
2023-05-05 15:19:26 +00:00
"failure_ttl_ms": 0,
2022-12-19 17:43:46 +00:00
"icon": "string",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
2024-02-13 14:31:20 +00:00
"max_port_share_level": "owner",
2023-03-07 14:14:58 +00:00
"max_ttl_ms": 0,
2022-12-19 17:43:46 +00:00
"name": "string",
"organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
2023-01-10 14:47:08 +00:00
"provisioner": "terraform",
2023-10-18 22:07:21 +00:00
"require_active_version": true,
2023-08-24 18:25:54 +00:00
"time_til_dormant_autodelete_ms": 0,
"time_til_dormant_ms": 0,
2023-12-15 08:27:56 +00:00
"updated_at": "2019-08-24T14:15:22Z",
"use_max_ttl": true
2022-12-19 17:43:46 +00:00
}
```
### Properties
2023-10-13 16:57:18 +00:00
| Name | Type | Required | Restrictions | Description |
| ---------------------------------- | ------------------------------------------------------------------------------ | -------- | ------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `active_user_count` | integer | false | | Active user count is set to -1 when loading. |
| `active_version_id` | string | false | | |
2024-02-13 07:00:35 +00:00
| `activity_bump_ms` | integer | false | | |
2023-10-13 16:57:18 +00:00
| `allow_user_autostart` | boolean | false | | Allow user autostart and AllowUserAutostop are enterprise-only. Their values are only used if your license is entitled to use the advanced template scheduling feature. |
| `allow_user_autostop` | boolean | false | | |
| `allow_user_cancel_workspace_jobs` | boolean | false | | |
| `autostart_requirement` | [codersdk.TemplateAutostartRequirement ](#codersdktemplateautostartrequirement ) | false | | |
| `autostop_requirement` | [codersdk.TemplateAutostopRequirement ](#codersdktemplateautostoprequirement ) | false | | Autostop requirement and AutostartRequirement are enterprise features. Its value is only used if your license is entitled to use the advanced template scheduling feature. |
| `build_time_stats` | [codersdk.TemplateBuildTimeStats ](#codersdktemplatebuildtimestats ) | false | | |
| `created_at` | string | false | | |
| `created_by_id` | string | false | | |
| `created_by_name` | string | false | | |
| `default_ttl_ms` | integer | false | | |
2023-11-20 19:16:18 +00:00
| `deprecated` | boolean | false | | |
| `deprecation_message` | string | false | | |
2023-10-13 16:57:18 +00:00
| `description` | string | false | | |
| `display_name` | string | false | | |
| `failure_ttl_ms` | integer | false | | Failure ttl ms TimeTilDormantMillis, and TimeTilDormantAutoDeleteMillis are enterprise-only. Their values are used if your license is entitled to use the advanced template scheduling feature. |
| `icon` | string | false | | |
| `id` | string | false | | |
2024-02-13 14:31:20 +00:00
| `max_port_share_level` | [codersdk.WorkspaceAgentPortShareLevel ](#codersdkworkspaceagentportsharelevel ) | false | | |
2023-10-13 16:57:18 +00:00
| `max_ttl_ms` | integer | false | | Max ttl ms remove max_ttl once autostop_requirement is matured |
| `name` | string | false | | |
| `organization_id` | string | false | | |
| `provisioner` | string | false | | |
2023-10-18 22:07:21 +00:00
| `require_active_version` | boolean | false | | Require active version mandates that workspaces are built with the active template version. |
2023-10-13 16:57:18 +00:00
| `time_til_dormant_autodelete_ms` | integer | false | | |
| `time_til_dormant_ms` | integer | false | | |
| `updated_at` | string | false | | |
2023-12-15 08:27:56 +00:00
| `use_max_ttl` | boolean | false | | Use max ttl picks whether to use the deprecated max TTL for the template or the new autostop requirement. |
2022-12-19 17:43:46 +00:00
2023-01-10 14:47:08 +00:00
#### Enumerated Values
| Property | Value |
| ------------- | ----------- |
| `provisioner` | `terraform` |
2023-07-21 18:00:19 +00:00
## codersdk.TemplateAppUsage
```json
{
"display_name": "Visual Studio Code",
"icon": "string",
"seconds": 80500,
"slug": "vscode",
"template_ids": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"],
"type": "builtin"
}
```
### Properties
| Name | Type | Required | Restrictions | Description |
| -------------- | ------------------------------------------------------ | -------- | ------------ | ----------- |
| `display_name` | string | false | | |
| `icon` | string | false | | |
| `seconds` | integer | false | | |
| `slug` | string | false | | |
| `template_ids` | array of string | false | | |
| `type` | [codersdk.TemplateAppsType ](#codersdktemplateappstype ) | false | | |
## codersdk.TemplateAppsType
```json
"builtin"
```
### Properties
#### Enumerated Values
| Value |
| --------- |
| `builtin` |
2023-08-21 12:08:58 +00:00
| `app` |
2023-07-21 18:00:19 +00:00
2023-10-13 16:57:18 +00:00
## codersdk.TemplateAutostartRequirement
```json
{
"days_of_week": ["monday"]
}
```
### Properties
| Name | Type | Required | Restrictions | Description |
| -------------- | --------------- | -------- | ------------ | --------------------------------------------------------------------------------------------------------------------------------------- |
| `days_of_week` | array of string | false | | Days of week is a list of days of the week in which autostart is allowed to happen. If no days are specified, autostart is not allowed. |
2023-08-29 18:35:05 +00:00
## codersdk.TemplateAutostopRequirement
```json
{
"days_of_week": ["monday"],
"weeks": 0
}
```
### Properties
| Name | Type | Required | Restrictions | Description |
| ------------------------------------------------------------------------------------- | --------------- | -------- | ------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `days_of_week` | array of string | false | | Days of week is a list of days of the week on which restarts are required. Restarts happen within the user's quiet hours (in their configured timezone). If no days are specified, restarts are not required. Weekdays cannot be specified twice. |
| Restarts will only happen on weekdays in this list on weeks which line up with Weeks. |
| `weeks` | integer | false | | Weeks is the number of weeks between required restarts. Weeks are synced across all workspaces (and Coder deployments) using modulo math on a hardcoded epoch week of January 2nd, 2023 (the first Monday of 2023). Values of 0 or 1 indicate weekly restarts. Values of 2 indicate fortnightly restarts, etc. |
2022-12-19 17:43:46 +00:00
## codersdk.TemplateBuildTimeStats
```json
{
"property1": {
"p50": 123,
"p95": 146
},
"property2": {
"p50": 123,
"p95": 146
}
}
```
### Properties
| Name | Type | Required | Restrictions | Description |
| ---------------- | ---------------------------------------------------- | -------- | ------------ | ----------- |
2022-12-21 14:37:30 +00:00
| `[any property]` | [codersdk.TransitionStats ](#codersdktransitionstats ) | false | | |
2022-12-19 17:43:46 +00:00
2023-01-11 11:16:09 +00:00
## codersdk.TemplateExample
```json
{
"description": "string",
"icon": "string",
2023-01-11 13:08:04 +00:00
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
2023-01-11 11:16:09 +00:00
"markdown": "string",
"name": "string",
"tags": ["string"],
"url": "string"
}
```
### Properties
| Name | Type | Required | Restrictions | Description |
| ------------- | --------------- | -------- | ------------ | ----------- |
| `description` | string | false | | |
| `icon` | string | false | | |
| `id` | string | false | | |
| `markdown` | string | false | | |
| `name` | string | false | | |
| `tags` | array of string | false | | |
| `url` | string | false | | |
2023-07-21 18:00:19 +00:00
## codersdk.TemplateInsightsIntervalReport
```json
{
"active_users": 14,
"end_time": "2019-08-24T14:15:22Z",
2023-09-19 11:06:19 +00:00
"interval": "week",
2023-07-21 18:00:19 +00:00
"start_time": "2019-08-24T14:15:22Z",
"template_ids": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"]
}
```
### Properties
| Name | Type | Required | Restrictions | Description |
| -------------- | ------------------------------------------------------------------ | -------- | ------------ | ----------- |
| `active_users` | integer | false | | |
| `end_time` | string | false | | |
| `interval` | [codersdk.InsightsReportInterval ](#codersdkinsightsreportinterval ) | false | | |
| `start_time` | string | false | | |
| `template_ids` | array of string | false | | |
## codersdk.TemplateInsightsReport
```json
{
"active_users": 22,
"apps_usage": [
{
"display_name": "Visual Studio Code",
"icon": "string",
"seconds": 80500,
"slug": "vscode",
"template_ids": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"],
"type": "builtin"
}
],
"end_time": "2019-08-24T14:15:22Z",
2023-08-03 14:43:23 +00:00
"parameters_usage": [
{
2023-08-07 16:11:44 +00:00
"description": "string",
2023-08-03 14:43:23 +00:00
"display_name": "string",
"name": "string",
"options": [
{
"description": "string",
"icon": "string",
"name": "string",
"value": "string"
}
],
"template_ids": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"],
2023-08-07 16:11:44 +00:00
"type": "string",
2023-08-03 14:43:23 +00:00
"values": [
{
"count": 0,
"value": "string"
}
]
}
],
2023-07-21 18:00:19 +00:00
"start_time": "2019-08-24T14:15:22Z",
"template_ids": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"]
}
```
### Properties
2023-08-03 14:43:23 +00:00
| Name | Type | Required | Restrictions | Description |
| ------------------ | --------------------------------------------------------------------------- | -------- | ------------ | ----------- |
| `active_users` | integer | false | | |
| `apps_usage` | array of [codersdk.TemplateAppUsage ](#codersdktemplateappusage ) | false | | |
| `end_time` | string | false | | |
| `parameters_usage` | array of [codersdk.TemplateParameterUsage ](#codersdktemplateparameterusage ) | false | | |
| `start_time` | string | false | | |
| `template_ids` | array of string | false | | |
2023-07-21 18:00:19 +00:00
## codersdk.TemplateInsightsResponse
```json
{
"interval_reports": [
{
"active_users": 14,
"end_time": "2019-08-24T14:15:22Z",
2023-09-19 11:06:19 +00:00
"interval": "week",
2023-07-21 18:00:19 +00:00
"start_time": "2019-08-24T14:15:22Z",
"template_ids": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"]
}
],
"report": {
"active_users": 22,
"apps_usage": [
{
"display_name": "Visual Studio Code",
"icon": "string",
"seconds": 80500,
"slug": "vscode",
"template_ids": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"],
"type": "builtin"
}
],
"end_time": "2019-08-24T14:15:22Z",
2023-08-03 14:43:23 +00:00
"parameters_usage": [
{
2023-08-07 16:11:44 +00:00
"description": "string",
2023-08-03 14:43:23 +00:00
"display_name": "string",
"name": "string",
"options": [
{
"description": "string",
"icon": "string",
"name": "string",
"value": "string"
}
],
"template_ids": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"],
2023-08-07 16:11:44 +00:00
"type": "string",
2023-08-03 14:43:23 +00:00
"values": [
{
"count": 0,
"value": "string"
}
]
}
],
2023-07-21 18:00:19 +00:00
"start_time": "2019-08-24T14:15:22Z",
"template_ids": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"]
}
}
```
### Properties
| Name | Type | Required | Restrictions | Description |
| ------------------ | ------------------------------------------------------------------------------------------- | -------- | ------------ | ----------- |
| `interval_reports` | array of [codersdk.TemplateInsightsIntervalReport ](#codersdktemplateinsightsintervalreport ) | false | | |
| `report` | [codersdk.TemplateInsightsReport ](#codersdktemplateinsightsreport ) | false | | |
2023-08-03 14:43:23 +00:00
## codersdk.TemplateParameterUsage
```json
{
2023-08-07 16:11:44 +00:00
"description": "string",
2023-08-03 14:43:23 +00:00
"display_name": "string",
"name": "string",
"options": [
{
"description": "string",
"icon": "string",
"name": "string",
"value": "string"
}
],
"template_ids": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"],
2023-08-07 16:11:44 +00:00
"type": "string",
2023-08-03 14:43:23 +00:00
"values": [
{
"count": 0,
"value": "string"
}
]
}
```
### Properties
| Name | Type | Required | Restrictions | Description |
| -------------- | ------------------------------------------------------------------------------------------- | -------- | ------------ | ----------- |
2023-08-07 16:11:44 +00:00
| `description` | string | false | | |
2023-08-03 14:43:23 +00:00
| `display_name` | string | false | | |
| `name` | string | false | | |
| `options` | array of [codersdk.TemplateVersionParameterOption ](#codersdktemplateversionparameteroption ) | false | | |
| `template_ids` | array of string | false | | |
2023-08-07 16:11:44 +00:00
| `type` | string | false | | |
2023-08-03 14:43:23 +00:00
| `values` | array of [codersdk.TemplateParameterValue ](#codersdktemplateparametervalue ) | false | | |
## codersdk.TemplateParameterValue
```json
{
"count": 0,
"value": "string"
}
```
### Properties
| Name | Type | Required | Restrictions | Description |
| ------- | ------- | -------- | ------------ | ----------- |
| `count` | integer | false | | |
| `value` | string | false | | |
2023-01-11 15:05:42 +00:00
## codersdk.TemplateRole
```json
"admin"
```
### Properties
#### Enumerated Values
| Value |
| ------- |
| `admin` |
| `use` |
| `` |
## codersdk.TemplateUser
```json
{
"avatar_url": "http://example.com",
"created_at": "2019-08-24T14:15:22Z",
"email": "user@example.com",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"last_seen_at": "2019-08-24T14:15:22Z",
2023-08-11 01:04:35 +00:00
"login_type": "",
2024-01-17 12:20:45 +00:00
"name": "string",
2023-01-11 15:05:42 +00:00
"organization_ids": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"],
"role": "admin",
"roles": [
{
"display_name": "string",
"name": "string"
}
],
"status": "active",
2023-12-14 17:38:44 +00:00
"theme_preference": "string",
2023-01-11 15:05:42 +00:00
"username": "string"
}
```
### Properties
| Name | Type | Required | Restrictions | Description |
| ------------------ | ---------------------------------------------- | -------- | ------------ | ----------- |
| `avatar_url` | string | false | | |
| `created_at` | string | true | | |
| `email` | string | true | | |
| `id` | string | true | | |
| `last_seen_at` | string | false | | |
2023-07-24 12:34:24 +00:00
| `login_type` | [codersdk.LoginType ](#codersdklogintype ) | false | | |
2024-01-17 12:20:45 +00:00
| `name` | string | false | | |
2023-01-11 15:05:42 +00:00
| `organization_ids` | array of string | false | | |
| `role` | [codersdk.TemplateRole ](#codersdktemplaterole ) | false | | |
| `roles` | array of [codersdk.Role ](#codersdkrole ) | false | | |
| `status` | [codersdk.UserStatus ](#codersdkuserstatus ) | false | | |
2023-12-14 17:38:44 +00:00
| `theme_preference` | string | false | | |
2023-01-11 15:05:42 +00:00
| `username` | string | true | | |
#### Enumerated Values
| Property | Value |
| -------- | ----------- |
| `role` | `admin` |
| `role` | `use` |
| `status` | `active` |
| `status` | `suspended` |
2023-01-11 11:16:09 +00:00
## codersdk.TemplateVersion
```json
{
2023-10-11 14:26:22 +00:00
"archived": true,
2023-01-11 11:16:09 +00:00
"created_at": "2019-08-24T14:15:22Z",
"created_by": {
"avatar_url": "http://example.com",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"username": "string"
},
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"job": {
"canceled_at": "2019-08-24T14:15:22Z",
"completed_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z",
"error": "string",
2023-08-23 16:18:38 +00:00
"error_code": "REQUIRED_TEMPLATE_VARIABLES",
2023-01-11 11:16:09 +00:00
"file_id": "8a0cfb4f-ddc9-436d-91bb-75133c583767",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
2023-06-20 20:07:18 +00:00
"queue_position": 0,
"queue_size": 0,
2023-01-11 11:16:09 +00:00
"started_at": "2019-08-24T14:15:22Z",
"status": "pending",
"tags": {
"property1": "string",
"property2": "string"
},
"worker_id": "ae5fa6f7-c55b-40c1-b40a-b36ac467652b"
},
2023-07-11 10:11:08 +00:00
"message": "string",
2023-01-11 11:16:09 +00:00
"name": "string",
"organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
"readme": "string",
"template_id": "c6d67e98-83ea-49f0-8812-e4abae2b68bc",
2023-05-12 09:21:49 +00:00
"updated_at": "2019-08-24T14:15:22Z",
2023-06-02 09:16:46 +00:00
"warnings": ["UNSUPPORTED_WORKSPACES"]
2023-01-11 11:16:09 +00:00
}
```
### Properties
2023-05-12 09:21:49 +00:00
| Name | Type | Required | Restrictions | Description |
| ----------------- | --------------------------------------------------------------------------- | -------- | ------------ | ----------- |
2023-10-11 14:26:22 +00:00
| `archived` | boolean | false | | |
2023-05-12 09:21:49 +00:00
| `created_at` | string | false | | |
2023-07-25 13:14:38 +00:00
| `created_by` | [codersdk.MinimalUser ](#codersdkminimaluser ) | false | | |
2023-05-12 09:21:49 +00:00
| `id` | string | false | | |
| `job` | [codersdk.ProvisionerJob ](#codersdkprovisionerjob ) | false | | |
2023-07-11 10:11:08 +00:00
| `message` | string | false | | |
2023-05-12 09:21:49 +00:00
| `name` | string | false | | |
| `organization_id` | string | false | | |
| `readme` | string | false | | |
| `template_id` | string | false | | |
| `updated_at` | string | false | | |
| `warnings` | array of [codersdk.TemplateVersionWarning ](#codersdktemplateversionwarning ) | false | | |
2023-01-11 11:16:09 +00:00
2023-09-29 19:13:20 +00:00
## codersdk.TemplateVersionExternalAuth
2023-02-27 16:18:19 +00:00
```json
{
"authenticate_url": "string",
"authenticated": true,
2023-10-03 14:04:39 +00:00
"display_icon": "string",
"display_name": "string",
2023-02-27 16:18:19 +00:00
"id": "string",
2023-10-03 14:04:39 +00:00
"type": "string"
2023-02-27 16:18:19 +00:00
}
```
### Properties
2023-10-03 14:04:39 +00:00
| Name | Type | Required | Restrictions | Description |
| ------------------ | ------- | -------- | ------------ | ----------- |
| `authenticate_url` | string | false | | |
| `authenticated` | boolean | false | | |
| `display_icon` | string | false | | |
| `display_name` | string | false | | |
| `id` | string | false | | |
| `type` | string | false | | |
2023-02-27 16:18:19 +00:00
2023-02-07 08:36:13 +00:00
## codersdk.TemplateVersionParameter
```json
{
"default_value": "string",
"description": "string",
2023-02-08 11:57:12 +00:00
"description_plaintext": "string",
2023-04-03 12:37:47 +00:00
"display_name": "string",
2023-07-10 11:44:03 +00:00
"ephemeral": true,
2023-02-07 08:36:13 +00:00
"icon": "string",
"mutable": true,
"name": "string",
"options": [
{
"description": "string",
"icon": "string",
"name": "string",
"value": "string"
}
],
2023-03-07 15:38:31 +00:00
"required": true,
2023-02-07 08:36:13 +00:00
"type": "string",
"validation_error": "string",
"validation_max": 0,
"validation_min": 0,
"validation_monotonic": "increasing",
"validation_regex": "string"
}
```
### Properties
2023-02-08 11:57:12 +00:00
| Name | Type | Required | Restrictions | Description |
| ----------------------- | ------------------------------------------------------------------------------------------- | -------- | ------------ | ----------- |
| `default_value` | string | false | | |
| `description` | string | false | | |
| `description_plaintext` | string | false | | |
2023-04-03 12:37:47 +00:00
| `display_name` | string | false | | |
2023-07-10 11:44:03 +00:00
| `ephemeral` | boolean | false | | |
2023-02-08 11:57:12 +00:00
| `icon` | string | false | | |
| `mutable` | boolean | false | | |
| `name` | string | false | | |
| `options` | array of [codersdk.TemplateVersionParameterOption ](#codersdktemplateversionparameteroption ) | false | | |
2023-03-07 15:38:31 +00:00
| `required` | boolean | false | | |
2023-02-08 11:57:12 +00:00
| `type` | string | false | | |
| `validation_error` | string | false | | |
| `validation_max` | integer | false | | |
| `validation_min` | integer | false | | |
| `validation_monotonic` | [codersdk.ValidationMonotonicOrder ](#codersdkvalidationmonotonicorder ) | false | | |
| `validation_regex` | string | false | | |
2023-02-07 08:36:13 +00:00
#### Enumerated Values
2023-03-16 10:07:10 +00:00
| Property | Value |
| ---------------------- | -------------- |
| `type` | `string` |
| `type` | `number` |
| `type` | `bool` |
| `type` | `list(string)` |
| `validation_monotonic` | `increasing` |
| `validation_monotonic` | `decreasing` |
2023-02-07 08:36:13 +00:00
## codersdk.TemplateVersionParameterOption
```json
{
"description": "string",
"icon": "string",
"name": "string",
"value": "string"
}
```
### Properties
| Name | Type | Required | Restrictions | Description |
| ------------- | ------ | -------- | ------------ | ----------- |
| `description` | string | false | | |
| `icon` | string | false | | |
| `name` | string | false | | |
| `value` | string | false | | |
2023-02-15 17:24:15 +00:00
## codersdk.TemplateVersionVariable
```json
{
"default_value": "string",
"description": "string",
"name": "string",
"required": true,
"sensitive": true,
"type": "string",
"value": "string"
}
```
### Properties
| Name | Type | Required | Restrictions | Description |
| --------------- | ------- | -------- | ------------ | ----------- |
| `default_value` | string | false | | |
| `description` | string | false | | |
| `name` | string | false | | |
| `required` | boolean | false | | |
| `sensitive` | boolean | false | | |
| `type` | string | false | | |
| `value` | string | false | | |
#### Enumerated Values
| Property | Value |
| -------- | -------- |
| `type` | `string` |
| `type` | `number` |
| `type` | `bool` |
2023-05-12 09:21:49 +00:00
## codersdk.TemplateVersionWarning
```json
2023-06-02 09:16:46 +00:00
"UNSUPPORTED_WORKSPACES"
2023-05-12 09:21:49 +00:00
```
### Properties
#### Enumerated Values
2023-06-02 09:16:46 +00:00
| Value |
| ------------------------ |
| `UNSUPPORTED_WORKSPACES` |
2023-05-12 09:21:49 +00:00
2023-03-16 15:25:08 +00:00
## codersdk.TokenConfig
```json
{
"max_token_lifetime": 0
}
```
### Properties
| Name | Type | Required | Restrictions | Description |
| -------------------- | ------- | -------- | ------------ | ----------- |
| `max_token_lifetime` | integer | false | | |
2023-01-03 18:21:10 +00:00
## codersdk.TraceConfig
```json
{
2023-03-07 21:10:01 +00:00
"capture_logs": true,
2023-08-29 22:14:28 +00:00
"data_dog": true,
2023-03-07 21:10:01 +00:00
"enable": true,
"honeycomb_api_key": "string"
2023-01-03 18:21:10 +00:00
}
```
### Properties
2023-03-07 21:10:01 +00:00
| Name | Type | Required | Restrictions | Description |
| ------------------- | ------- | -------- | ------------ | ----------- |
| `capture_logs` | boolean | false | | |
2023-08-29 22:14:28 +00:00
| `data_dog` | boolean | false | | |
2023-03-07 21:10:01 +00:00
| `enable` | boolean | false | | |
| `honeycomb_api_key` | string | false | | |
2023-01-03 18:21:10 +00:00
2022-12-19 17:43:46 +00:00
## codersdk.TransitionStats
```json
{
"p50": 123,
"p95": 146
}
```
### Properties
| Name | Type | Required | Restrictions | Description |
| ----- | ------- | -------- | ------------ | ----------- |
2022-12-21 14:37:30 +00:00
| `p50` | integer | false | | |
| `p95` | integer | false | | |
2022-12-19 17:43:46 +00:00
2023-01-11 11:16:09 +00:00
## codersdk.UpdateActiveTemplateVersion
```json
{
2023-01-11 13:08:04 +00:00
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
2023-01-11 11:16:09 +00:00
}
```
### Properties
| Name | Type | Required | Restrictions | Description |
| ---- | ------ | -------- | ------------ | ----------- |
| `id` | string | true | | |
2023-02-27 08:25:04 +00:00
## codersdk.UpdateAppearanceConfig
```json
{
2023-09-27 15:02:18 +00:00
"application_name": "string",
2023-02-27 08:25:04 +00:00
"logo_url": "string",
"service_banner": {
"background_color": "string",
"enabled": true,
"message": "string"
}
}
```
### Properties
2023-09-27 15:02:18 +00:00
| Name | Type | Required | Restrictions | Description |
| ------------------ | ------------------------------------------------------------ | -------- | ------------ | ----------- |
| `application_name` | string | false | | |
| `logo_url` | string | false | | |
| `service_banner` | [codersdk.ServiceBannerConfig ](#codersdkservicebannerconfig ) | false | | |
2023-02-27 08:25:04 +00:00
2022-12-22 14:53:14 +00:00
## codersdk.UpdateCheckResponse
```json
{
"current": true,
"url": "string",
"version": "string"
}
```
### Properties
| Name | Type | Required | Restrictions | Description |
| --------- | ------- | -------- | ------------ | ----------------------------------------------------------------------- |
| `current` | boolean | false | | Current indicates whether the server version is the same as the latest. |
| `url` | string | false | | URL to download the latest release of Coder. |
| `version` | string | false | | Version is the semantic version for the latest release of Coder. |
2023-11-28 17:15:17 +00:00
## codersdk.UpdateHealthSettings
```json
{
2023-12-05 20:00:27 +00:00
"dismissed_healthchecks": ["DERP"]
2023-11-28 17:15:17 +00:00
}
```
### Properties
2023-12-05 20:00:27 +00:00
| Name | Type | Required | Restrictions | Description |
| ------------------------ | --------------------------------------------------------- | -------- | ------------ | ----------- |
| `dismissed_healthchecks` | array of [codersdk.HealthSection ](#codersdkhealthsection ) | false | | |
2023-11-28 17:15:17 +00:00
2023-01-11 11:16:09 +00:00
## codersdk.UpdateRoles
```json
{
"roles": ["string"]
}
```
### Properties
| Name | Type | Required | Restrictions | Description |
| ------- | --------------- | -------- | ------------ | ----------- |
| `roles` | array of string | false | | |
2023-01-11 15:05:42 +00:00
## codersdk.UpdateTemplateACL
```json
{
"group_perms": {
2023-07-05 17:24:21 +00:00
"8bd26b20-f3e8-48be-a903-46bb920cf671": "use",
"< user_id > >": "admin"
2023-01-11 15:05:42 +00:00
},
"user_perms": {
2023-07-05 17:24:21 +00:00
"4df59e74-c027-470b-ab4d-cbba8963a5e9": "use",
"< group_id > ": "admin"
2023-01-11 15:05:42 +00:00
}
}
```
### Properties
2023-07-05 17:24:21 +00:00
| Name | Type | Required | Restrictions | Description |
| ------------------ | ---------------------------------------------- | -------- | ------------ | ----------------------------------------------------------------------------------------------------------------------------- |
| `group_perms` | object | false | | Group perms should be a mapping of group ID to role. |
| » `[any property]` | [codersdk.TemplateRole ](#codersdktemplaterole ) | false | | |
| `user_perms` | object | false | | User perms should be a mapping of user ID to role. The user ID must be the uuid of the user, not a username or email address. |
| » `[any property]` | [codersdk.TemplateRole ](#codersdktemplaterole ) | false | | |
2023-01-11 15:05:42 +00:00
2023-12-14 17:38:44 +00:00
## codersdk.UpdateUserAppearanceSettingsRequest
```json
{
"theme_preference": "string"
}
```
### Properties
| Name | Type | Required | Restrictions | Description |
| ------------------ | ------ | -------- | ------------ | ----------- |
| `theme_preference` | string | true | | |
2023-01-11 13:08:04 +00:00
## codersdk.UpdateUserPasswordRequest
```json
{
"old_password": "string",
"password": "string"
}
```
### Properties
| Name | Type | Required | Restrictions | Description |
| -------------- | ------ | -------- | ------------ | ----------- |
| `old_password` | string | false | | |
| `password` | string | true | | |
## codersdk.UpdateUserProfileRequest
```json
{
2024-01-17 12:20:45 +00:00
"name": "string",
2023-01-11 13:08:04 +00:00
"username": "string"
}
```
### Properties
| Name | Type | Required | Restrictions | Description |
| ---------- | ------ | -------- | ------------ | ----------- |
2024-01-17 12:20:45 +00:00
| `name` | string | false | | |
2023-01-11 13:08:04 +00:00
| `username` | string | true | | |
2023-07-20 13:35:41 +00:00
## codersdk.UpdateUserQuietHoursScheduleRequest
```json
{
"schedule": "string"
}
```
### Properties
| Name | Type | Required | Restrictions | Description |
| ---------- | ------ | -------- | ------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `schedule` | string | true | | Schedule is a cron expression that defines when the user's quiet hours window is. Schedule must not be empty. For new users, the schedule is set to 2am in their browser or computer's timezone. The schedule denotes the beginning of a 4 hour window where the workspace is allowed to automatically stop or restart due to maintenance or template max TTL. |
The schedule must be daily with a single time, and should have a timezone specified via a CRON_TZ prefix (otherwise UTC will be used).
If the schedule is empty, the user will be updated to use the default schedule.|
2023-10-06 09:27:12 +00:00
## codersdk.UpdateWorkspaceAutomaticUpdatesRequest
```json
{
"automatic_updates": "always"
}
```
### Properties
| Name | Type | Required | Restrictions | Description |
| ------------------- | ------------------------------------------------------ | -------- | ------------ | ----------- |
| `automatic_updates` | [codersdk.AutomaticUpdates ](#codersdkautomaticupdates ) | false | | |
2022-12-19 17:43:46 +00:00
## codersdk.UpdateWorkspaceAutostartRequest
```json
{
"schedule": "string"
}
```
### Properties
| Name | Type | Required | Restrictions | Description |
| ---------- | ------ | -------- | ------------ | ----------- |
2022-12-21 14:37:30 +00:00
| `schedule` | string | false | | |
2022-12-19 17:43:46 +00:00
2023-08-24 18:25:54 +00:00
## codersdk.UpdateWorkspaceDormancy
2023-06-28 21:12:49 +00:00
```json
{
2023-08-24 18:25:54 +00:00
"dormant": true
2023-06-28 21:12:49 +00:00
}
```
### Properties
2023-08-24 18:25:54 +00:00
| Name | Type | Required | Restrictions | Description |
| --------- | ------- | -------- | ------------ | ----------- |
| `dormant` | boolean | false | | |
2023-06-28 21:12:49 +00:00
2022-12-19 17:43:46 +00:00
## codersdk.UpdateWorkspaceRequest
```json
{
"name": "string"
}
```
### Properties
| Name | Type | Required | Restrictions | Description |
| ------ | ------ | -------- | ------------ | ----------- |
2022-12-21 14:37:30 +00:00
| `name` | string | false | | |
2022-12-19 17:43:46 +00:00
## codersdk.UpdateWorkspaceTTLRequest
```json
{
"ttl_ms": 0
}
```
### Properties
| Name | Type | Required | Restrictions | Description |
| -------- | ------- | -------- | ------------ | ----------- |
2022-12-21 14:37:30 +00:00
| `ttl_ms` | integer | false | | |
2022-12-19 17:43:46 +00:00
2023-01-03 18:21:10 +00:00
## codersdk.UploadResponse
```json
{
"hash": "19686d84-b10d-4f90-b18e-84fd3fa038fd"
}
```
### Properties
| Name | Type | Required | Restrictions | Description |
| ------ | ------ | -------- | ------------ | ----------- |
| `hash` | string | false | | |
2024-02-13 14:31:20 +00:00
## codersdk.UpsertWorkspaceAgentPortShareRequest
```json
{
"agent_name": "string",
"port": 0,
"share_level": "owner"
}
```
### Properties
| Name | Type | Required | Restrictions | Description |
| ------------- | ------------------------------------------------------------------------------ | -------- | ------------ | ----------- |
| `agent_name` | string | false | | |
| `port` | integer | false | | |
| `share_level` | [codersdk.WorkspaceAgentPortShareLevel ](#codersdkworkspaceagentportsharelevel ) | false | | |
2023-01-03 18:21:10 +00:00
## codersdk.User
```json
{
2023-01-11 11:16:09 +00:00
"avatar_url": "http://example.com",
"created_at": "2019-08-24T14:15:22Z",
2023-01-11 13:08:04 +00:00
"email": "user@example.com",
2023-01-11 11:16:09 +00:00
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"last_seen_at": "2019-08-24T14:15:22Z",
2023-08-11 01:04:35 +00:00
"login_type": "",
2024-01-17 12:20:45 +00:00
"name": "string",
2023-01-11 11:16:09 +00:00
"organization_ids": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"],
2023-01-03 18:21:10 +00:00
"roles": [
{
"display_name": "string",
"name": "string"
}
],
2023-01-10 14:47:08 +00:00
"status": "active",
2023-12-14 17:38:44 +00:00
"theme_preference": "string",
2023-01-03 18:21:10 +00:00
"username": "string"
}
```
### Properties
2023-01-10 14:47:08 +00:00
| Name | Type | Required | Restrictions | Description |
| ------------------ | ------------------------------------------ | -------- | ------------ | ----------- |
| `avatar_url` | string | false | | |
| `created_at` | string | true | | |
| `email` | string | true | | |
| `id` | string | true | | |
| `last_seen_at` | string | false | | |
2023-07-24 12:34:24 +00:00
| `login_type` | [codersdk.LoginType ](#codersdklogintype ) | false | | |
2024-01-17 12:20:45 +00:00
| `name` | string | false | | |
2023-01-10 14:47:08 +00:00
| `organization_ids` | array of string | false | | |
| `roles` | array of [codersdk.Role ](#codersdkrole ) | false | | |
| `status` | [codersdk.UserStatus ](#codersdkuserstatus ) | false | | |
2023-12-14 17:38:44 +00:00
| `theme_preference` | string | false | | |
2023-01-10 14:47:08 +00:00
| `username` | string | true | | |
2023-01-11 11:16:09 +00:00
#### Enumerated Values
| Property | Value |
| -------- | ----------- |
| `status` | `active` |
| `status` | `suspended` |
2023-09-26 16:42:16 +00:00
## codersdk.UserActivity
```json
{
"avatar_url": "http://example.com",
"seconds": 80500,
"template_ids": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"],
"user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
"username": "string"
}
```
### Properties
| Name | Type | Required | Restrictions | Description |
| -------------- | --------------- | -------- | ------------ | ----------- |
| `avatar_url` | string | false | | |
| `seconds` | integer | false | | |
| `template_ids` | array of string | false | | |
| `user_id` | string | false | | |
| `username` | string | false | | |
## codersdk.UserActivityInsightsReport
```json
{
"end_time": "2019-08-24T14:15:22Z",
"start_time": "2019-08-24T14:15:22Z",
"template_ids": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"],
"users": [
{
"avatar_url": "http://example.com",
"seconds": 80500,
"template_ids": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"],
"user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
"username": "string"
}
]
}
```
### Properties
| Name | Type | Required | Restrictions | Description |
| -------------- | ------------------------------------------------------- | -------- | ------------ | ----------- |
| `end_time` | string | false | | |
| `start_time` | string | false | | |
| `template_ids` | array of string | false | | |
| `users` | array of [codersdk.UserActivity ](#codersdkuseractivity ) | false | | |
## codersdk.UserActivityInsightsResponse
```json
{
"report": {
"end_time": "2019-08-24T14:15:22Z",
"start_time": "2019-08-24T14:15:22Z",
"template_ids": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"],
"users": [
{
"avatar_url": "http://example.com",
"seconds": 80500,
"template_ids": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"],
"user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
"username": "string"
}
]
}
}
```
### Properties
| Name | Type | Required | Restrictions | Description |
| -------- | -------------------------------------------------------------------------- | -------- | ------------ | ----------- |
| `report` | [codersdk.UserActivityInsightsReport ](#codersdkuseractivityinsightsreport ) | false | | |
2023-07-21 18:00:19 +00:00
## codersdk.UserLatency
```json
{
2023-07-25 10:15:46 +00:00
"avatar_url": "http://example.com",
2023-07-21 18:00:19 +00:00
"latency_ms": {
"p50": 31.312,
"p95": 119.832
},
"template_ids": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"],
"user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
"username": "string"
}
```
### Properties
| Name | Type | Required | Restrictions | Description |
| -------------- | -------------------------------------------------------- | -------- | ------------ | ----------- |
2023-07-25 10:15:46 +00:00
| `avatar_url` | string | false | | |
2023-07-21 18:00:19 +00:00
| `latency_ms` | [codersdk.ConnectionLatency ](#codersdkconnectionlatency ) | false | | |
| `template_ids` | array of string | false | | |
| `user_id` | string | false | | |
| `username` | string | false | | |
## codersdk.UserLatencyInsightsReport
```json
{
"end_time": "2019-08-24T14:15:22Z",
"start_time": "2019-08-24T14:15:22Z",
"template_ids": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"],
"users": [
{
2023-07-25 10:15:46 +00:00
"avatar_url": "http://example.com",
2023-07-21 18:00:19 +00:00
"latency_ms": {
"p50": 31.312,
"p95": 119.832
},
"template_ids": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"],
"user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
"username": "string"
}
]
}
```
### Properties
| Name | Type | Required | Restrictions | Description |
| -------------- | ----------------------------------------------------- | -------- | ------------ | ----------- |
| `end_time` | string | false | | |
| `start_time` | string | false | | |
| `template_ids` | array of string | false | | |
| `users` | array of [codersdk.UserLatency ](#codersdkuserlatency ) | false | | |
## codersdk.UserLatencyInsightsResponse
```json
{
"report": {
"end_time": "2019-08-24T14:15:22Z",
"start_time": "2019-08-24T14:15:22Z",
"template_ids": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"],
"users": [
{
2023-07-25 10:15:46 +00:00
"avatar_url": "http://example.com",
2023-07-21 18:00:19 +00:00
"latency_ms": {
"p50": 31.312,
"p95": 119.832
},
"template_ids": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"],
"user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
"username": "string"
}
]
}
}
```
### Properties
| Name | Type | Required | Restrictions | Description |
| -------- | ------------------------------------------------------------------------ | -------- | ------------ | ----------- |
| `report` | [codersdk.UserLatencyInsightsReport ](#codersdkuserlatencyinsightsreport ) | false | | |
2023-06-30 12:38:48 +00:00
## codersdk.UserLoginType
```json
{
2023-08-11 01:04:35 +00:00
"login_type": ""
2023-06-30 12:38:48 +00:00
}
```
### Properties
| Name | Type | Required | Restrictions | Description |
| ------------ | ---------------------------------------- | -------- | ------------ | ----------- |
| `login_type` | [codersdk.LoginType ](#codersdklogintype ) | false | | |
2024-01-30 22:02:21 +00:00
## codersdk.UserParameter
```json
{
"name": "string",
"value": "string"
}
```
### Properties
| Name | Type | Required | Restrictions | Description |
| ------- | ------ | -------- | ------------ | ----------- |
| `name` | string | false | | |
| `value` | string | false | | |
2023-07-20 13:35:41 +00:00
## codersdk.UserQuietHoursScheduleConfig
```json
{
2023-12-15 09:33:51 +00:00
"allow_user_custom": true,
2023-07-20 13:35:41 +00:00
"default_schedule": "string"
}
```
### Properties
2023-12-15 09:33:51 +00:00
| Name | Type | Required | Restrictions | Description |
| ------------------- | ------- | -------- | ------------ | ----------- |
| `allow_user_custom` | boolean | false | | |
| `default_schedule` | string | false | | |
2023-07-20 13:35:41 +00:00
## codersdk.UserQuietHoursScheduleResponse
```json
{
"next": "2019-08-24T14:15:22Z",
"raw_schedule": "string",
"time": "string",
"timezone": "string",
2023-12-15 09:33:51 +00:00
"user_can_set": true,
2023-07-20 13:35:41 +00:00
"user_set": true
}
```
### Properties
2023-12-15 09:33:51 +00:00
| Name | Type | Required | Restrictions | Description |
| -------------- | ------- | -------- | ------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `next` | string | false | | Next is the next time that the quiet hours window will start. |
| `raw_schedule` | string | false | | |
| `time` | string | false | | Time is the time of day that the quiet hours window starts in the given Timezone each day. |
| `timezone` | string | false | | raw format from the cron expression, UTC if unspecified |
| `user_can_set` | boolean | false | | User can set is true if the user is allowed to set their own quiet hours schedule. If false, the user cannot set a custom schedule and the default schedule will always be used. |
| `user_set` | boolean | false | | User set is true if the user has set their own quiet hours schedule. If false, the user is using the default schedule. |
2023-07-20 13:35:41 +00:00
2023-01-10 14:47:08 +00:00
## codersdk.UserStatus
```json
"active"
```
### Properties
#### Enumerated Values
| Value |
| ----------- |
| `active` |
2023-08-02 14:31:25 +00:00
| `dormant` |
2023-01-10 14:47:08 +00:00
| `suspended` |
2023-01-03 18:21:10 +00:00
2022-12-19 17:43:46 +00:00
## codersdk.ValidationError
```json
{
"detail": "string",
"field": "string"
}
```
### Properties
| Name | Type | Required | Restrictions | Description |
| -------- | ------ | -------- | ------------ | ----------- |
2022-12-21 14:37:30 +00:00
| `detail` | string | true | | |
| `field` | string | true | | |
2022-12-19 17:43:46 +00:00
2023-02-07 08:36:13 +00:00
## codersdk.ValidationMonotonicOrder
```json
"increasing"
```
### Properties
#### Enumerated Values
| Value |
| ------------ |
| `increasing` |
| `decreasing` |
2023-02-15 17:24:15 +00:00
## codersdk.VariableValue
```json
{
"name": "string",
"value": "string"
}
```
### Properties
| Name | Type | Required | Restrictions | Description |
| ------- | ------ | -------- | ------------ | ----------- |
| `name` | string | false | | |
| `value` | string | false | | |
2022-12-19 17:43:46 +00:00
## codersdk.Workspace
```json
{
2023-12-15 18:38:47 +00:00
"allow_renames": true,
2023-10-06 09:27:12 +00:00
"automatic_updates": "always",
2022-12-19 17:43:46 +00:00
"autostart_schedule": "string",
"created_at": "2019-08-24T14:15:22Z",
2023-05-11 15:47:53 +00:00
"deleting_at": "2019-08-24T14:15:22Z",
2023-08-24 18:25:54 +00:00
"dormant_at": "2019-08-24T14:15:22Z",
2024-01-24 13:39:19 +00:00
"favorite": true,
2023-07-10 09:40:11 +00:00
"health": {
"failing_agents": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"],
"healthy": false
},
2022-12-19 17:43:46 +00:00
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"last_used_at": "2019-08-24T14:15:22Z",
"latest_build": {
"build_number": 0,
"created_at": "2019-08-24T14:15:22Z",
"daily_cost": 0,
2023-01-03 18:21:10 +00:00
"deadline": "2019-08-24T14:15:22Z",
2022-12-19 17:43:46 +00:00
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"initiator_id": "06588898-9a84-4b35-ba8f-f9cbd64946f3",
"initiator_name": "string",
"job": {
2023-01-05 14:27:10 +00:00
"canceled_at": "2019-08-24T14:15:22Z",
"completed_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z",
2022-12-19 17:43:46 +00:00
"error": "string",
2023-08-23 16:18:38 +00:00
"error_code": "REQUIRED_TEMPLATE_VARIABLES",
2023-01-05 14:27:10 +00:00
"file_id": "8a0cfb4f-ddc9-436d-91bb-75133c583767",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
2023-06-20 20:07:18 +00:00
"queue_position": 0,
"queue_size": 0,
2023-01-05 14:27:10 +00:00
"started_at": "2019-08-24T14:15:22Z",
"status": "pending",
2022-12-19 17:43:46 +00:00
"tags": {
"property1": "string",
"property2": "string"
},
2023-01-05 14:27:10 +00:00
"worker_id": "ae5fa6f7-c55b-40c1-b40a-b36ac467652b"
2022-12-19 17:43:46 +00:00
},
2023-03-07 14:14:58 +00:00
"max_deadline": "2019-08-24T14:15:22Z",
2023-01-05 14:27:10 +00:00
"reason": "initiator",
2022-12-19 17:43:46 +00:00
"resources": [
{
"agents": [
{
2023-10-31 06:08:43 +00:00
"api_version": "string",
2022-12-19 17:43:46 +00:00
"apps": [
{
"command": "string",
"display_name": "string",
"external": true,
2023-01-10 14:47:08 +00:00
"health": "disabled",
2022-12-19 17:43:46 +00:00
"healthcheck": {
"interval": 0,
"threshold": 0,
"url": "string"
},
"icon": "string",
2023-01-05 14:27:10 +00:00
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"sharing_level": "owner",
2022-12-19 17:43:46 +00:00
"slug": "string",
"subdomain": true,
2023-09-12 13:25:10 +00:00
"subdomain_name": "string",
2022-12-19 17:43:46 +00:00
"url": "string"
}
],
"architecture": "string",
"connection_timeout_seconds": 0,
2023-01-05 14:27:10 +00:00
"created_at": "2019-08-24T14:15:22Z",
2022-12-19 17:43:46 +00:00
"directory": "string",
2023-01-05 14:27:10 +00:00
"disconnected_at": "2019-08-24T14:15:22Z",
2023-08-30 19:53:42 +00:00
"display_apps": ["vscode"],
2022-12-19 17:43:46 +00:00
"environment_variables": {
"property1": "string",
"property2": "string"
},
2023-02-07 21:35:09 +00:00
"expanded_directory": "string",
2023-01-05 14:27:10 +00:00
"first_connected_at": "2019-08-24T14:15:22Z",
2023-07-10 09:40:11 +00:00
"health": {
"healthy": false,
"reason": "agent has lost connection"
},
2023-01-05 14:27:10 +00:00
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
2022-12-19 17:43:46 +00:00
"instance_id": "string",
2023-01-05 14:27:10 +00:00
"last_connected_at": "2019-08-24T14:15:22Z",
2022-12-19 17:43:46 +00:00
"latency": {
"property1": {
"latency_ms": 0,
"preferred": true
},
"property2": {
"latency_ms": 0,
"preferred": true
}
},
2023-01-24 12:24:27 +00:00
"lifecycle_state": "created",
2023-09-25 21:47:17 +00:00
"log_sources": [
{
"created_at": "2019-08-24T14:15:22Z",
"display_name": "string",
"icon": "string",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"workspace_agent_id": "7ad2e618-fea7-4c1a-b70a-f501566a72f1"
}
],
2023-07-28 15:57:23 +00:00
"logs_length": 0,
"logs_overflowed": true,
2022-12-19 17:43:46 +00:00
"name": "string",
"operating_system": "string",
2023-06-20 11:41:55 +00:00
"ready_at": "2019-08-24T14:15:22Z",
2023-01-05 14:27:10 +00:00
"resource_id": "4d5215ed-38bb-48ed-879a-fdb9ca58522f",
2023-09-25 21:47:17 +00:00
"scripts": [
{
"cron": "string",
"log_path": "string",
"log_source_id": "4197ab25-95cf-4b91-9c78-f7f2af5d353a",
"run_on_start": true,
"run_on_stop": true,
"script": "string",
"start_blocks_login": true,
"timeout": 0
}
],
2023-06-20 11:41:55 +00:00
"started_at": "2019-08-24T14:15:22Z",
2023-06-06 08:58:07 +00:00
"startup_script_behavior": "blocking",
2023-01-05 14:27:10 +00:00
"status": "connecting",
2023-08-09 05:10:28 +00:00
"subsystems": ["envbox"],
2022-12-19 17:43:46 +00:00
"troubleshooting_url": "string",
2023-01-05 14:27:10 +00:00
"updated_at": "2019-08-24T14:15:22Z",
2022-12-19 17:43:46 +00:00
"version": "string"
}
],
"created_at": "2019-08-24T14:15:22Z",
"daily_cost": 0,
"hide": true,
"icon": "string",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"job_id": "453bd7d7-5355-4d6d-a38e-d9e7eb218c3f",
"metadata": [
{
"key": "string",
"sensitive": true,
"value": "string"
}
],
"name": "string",
"type": "string",
"workspace_transition": "start"
}
],
"status": "pending",
"template_version_id": "0ba39c92-1f1b-4c32-aa3e-9925d7713eb1",
"template_version_name": "string",
"transition": "start",
"updated_at": "2019-08-24T14:15:22Z",
"workspace_id": "0967198e-ec7b-4c6b-b4d3-f71244cadbe9",
"workspace_name": "string",
2024-01-30 17:07:06 +00:00
"workspace_owner_avatar_url": "string",
2022-12-19 17:43:46 +00:00
"workspace_owner_id": "e7078695-5279-4c86-8774-3ac2367a2fc7",
"workspace_owner_name": "string"
},
"name": "string",
2023-03-21 14:10:22 +00:00
"organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
2022-12-19 17:43:46 +00:00
"outdated": true,
2024-01-30 17:07:06 +00:00
"owner_avatar_url": "string",
2022-12-19 17:43:46 +00:00
"owner_id": "8826ee2e-7933-4665-aef2-2393f84a0d05",
"owner_name": "string",
2023-08-27 16:26:20 +00:00
"template_active_version_id": "b0da9c29-67d8-4c87-888c-bafe356f7f3c",
2022-12-19 17:43:46 +00:00
"template_allow_user_cancel_workspace_jobs": true,
"template_display_name": "string",
"template_icon": "string",
"template_id": "c6d67e98-83ea-49f0-8812-e4abae2b68bc",
"template_name": "string",
2023-10-19 23:21:52 +00:00
"template_require_active_version": true,
2022-12-19 17:43:46 +00:00
"ttl_ms": 0,
"updated_at": "2019-08-24T14:15:22Z"
}
```
### Properties
2023-10-06 09:27:12 +00:00
| Name | Type | Required | Restrictions | Description |
| ------------------------------------------- | ------------------------------------------------------ | -------- | ------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
2023-12-15 18:38:47 +00:00
| `allow_renames` | boolean | false | | |
2023-10-06 09:27:12 +00:00
| `automatic_updates` | [codersdk.AutomaticUpdates ](#codersdkautomaticupdates ) | false | | |
| `autostart_schedule` | string | false | | |
| `created_at` | string | false | | |
| `deleting_at` | string | false | | Deleting at indicates the time at which the workspace will be permanently deleted. A workspace is eligible for deletion if it is dormant (a non-nil dormant_at value) and a value has been specified for time_til_dormant_autodelete on its template. |
| `dormant_at` | string | false | | Dormant at being non-nil indicates a workspace that is dormant. A dormant workspace is no longer accessible must be activated. It is subject to deletion if it breaches the duration of the time*til* field on its template. |
2024-01-24 13:39:19 +00:00
| `favorite` | boolean | false | | |
2023-10-06 09:27:12 +00:00
| `health` | [codersdk.WorkspaceHealth ](#codersdkworkspacehealth ) | false | | Health shows the health of the workspace and information about what is causing an unhealthy status. |
| `id` | string | false | | |
| `last_used_at` | string | false | | |
| `latest_build` | [codersdk.WorkspaceBuild ](#codersdkworkspacebuild ) | false | | |
| `name` | string | false | | |
| `organization_id` | string | false | | |
| `outdated` | boolean | false | | |
2024-01-30 17:07:06 +00:00
| `owner_avatar_url` | string | false | | |
2023-10-06 09:27:12 +00:00
| `owner_id` | string | false | | |
| `owner_name` | string | false | | |
| `template_active_version_id` | string | false | | |
| `template_allow_user_cancel_workspace_jobs` | boolean | false | | |
| `template_display_name` | string | false | | |
| `template_icon` | string | false | | |
| `template_id` | string | false | | |
| `template_name` | string | false | | |
2023-10-19 23:21:52 +00:00
| `template_require_active_version` | boolean | false | | |
2023-10-06 09:27:12 +00:00
| `ttl_ms` | integer | false | | |
| `updated_at` | string | false | | |
#### Enumerated Values
| Property | Value |
| ------------------- | -------- |
| `automatic_updates` | `always` |
| `automatic_updates` | `never` |
2022-12-19 17:43:46 +00:00
## codersdk.WorkspaceAgent
```json
{
2023-10-31 06:08:43 +00:00
"api_version": "string",
2022-12-19 17:43:46 +00:00
"apps": [
{
"command": "string",
"display_name": "string",
"external": true,
2023-01-10 14:47:08 +00:00
"health": "disabled",
2022-12-19 17:43:46 +00:00
"healthcheck": {
"interval": 0,
"threshold": 0,
"url": "string"
},
"icon": "string",
2023-01-05 14:27:10 +00:00
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"sharing_level": "owner",
2022-12-19 17:43:46 +00:00
"slug": "string",
"subdomain": true,
2023-09-12 13:25:10 +00:00
"subdomain_name": "string",
2022-12-19 17:43:46 +00:00
"url": "string"
}
],
"architecture": "string",
"connection_timeout_seconds": 0,
2023-01-05 14:27:10 +00:00
"created_at": "2019-08-24T14:15:22Z",
2022-12-19 17:43:46 +00:00
"directory": "string",
2023-01-05 14:27:10 +00:00
"disconnected_at": "2019-08-24T14:15:22Z",
2023-08-30 19:53:42 +00:00
"display_apps": ["vscode"],
2022-12-19 17:43:46 +00:00
"environment_variables": {
"property1": "string",
"property2": "string"
},
2023-02-07 21:35:09 +00:00
"expanded_directory": "string",
2023-01-05 14:27:10 +00:00
"first_connected_at": "2019-08-24T14:15:22Z",
2023-07-10 09:40:11 +00:00
"health": {
"healthy": false,
"reason": "agent has lost connection"
},
2023-01-05 14:27:10 +00:00
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
2022-12-19 17:43:46 +00:00
"instance_id": "string",
2023-01-05 14:27:10 +00:00
"last_connected_at": "2019-08-24T14:15:22Z",
2022-12-19 17:43:46 +00:00
"latency": {
"property1": {
"latency_ms": 0,
"preferred": true
},
"property2": {
"latency_ms": 0,
"preferred": true
}
},
2023-01-24 12:24:27 +00:00
"lifecycle_state": "created",
2023-09-25 21:47:17 +00:00
"log_sources": [
{
"created_at": "2019-08-24T14:15:22Z",
"display_name": "string",
"icon": "string",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"workspace_agent_id": "7ad2e618-fea7-4c1a-b70a-f501566a72f1"
}
],
2023-07-28 15:57:23 +00:00
"logs_length": 0,
"logs_overflowed": true,
2022-12-19 17:43:46 +00:00
"name": "string",
"operating_system": "string",
2023-06-20 11:41:55 +00:00
"ready_at": "2019-08-24T14:15:22Z",
2023-01-05 14:27:10 +00:00
"resource_id": "4d5215ed-38bb-48ed-879a-fdb9ca58522f",
2023-09-25 21:47:17 +00:00
"scripts": [
{
"cron": "string",
"log_path": "string",
"log_source_id": "4197ab25-95cf-4b91-9c78-f7f2af5d353a",
"run_on_start": true,
"run_on_stop": true,
"script": "string",
"start_blocks_login": true,
"timeout": 0
}
],
2023-06-20 11:41:55 +00:00
"started_at": "2019-08-24T14:15:22Z",
2023-06-06 08:58:07 +00:00
"startup_script_behavior": "blocking",
2023-01-05 14:27:10 +00:00
"status": "connecting",
2023-08-09 05:10:28 +00:00
"subsystems": ["envbox"],
2022-12-19 17:43:46 +00:00
"troubleshooting_url": "string",
2023-01-05 14:27:10 +00:00
"updated_at": "2019-08-24T14:15:22Z",
2022-12-19 17:43:46 +00:00
"version": "string"
}
```
### Properties
2023-09-25 21:47:17 +00:00
| Name | Type | Required | Restrictions | Description |
| ---------------------------- | -------------------------------------------------------------------------------------------- | -------- | ------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
2023-10-31 06:08:43 +00:00
| `api_version` | string | false | | |
2023-09-25 21:47:17 +00:00
| `apps` | array of [codersdk.WorkspaceApp ](#codersdkworkspaceapp ) | false | | |
| `architecture` | string | false | | |
| `connection_timeout_seconds` | integer | false | | |
| `created_at` | string | false | | |
| `directory` | string | false | | |
| `disconnected_at` | string | false | | |
| `display_apps` | array of [codersdk.DisplayApp ](#codersdkdisplayapp ) | false | | |
| `environment_variables` | object | false | | |
| » `[any property]` | string | false | | |
| `expanded_directory` | string | false | | |
| `first_connected_at` | string | false | | |
| `health` | [codersdk.WorkspaceAgentHealth ](#codersdkworkspaceagenthealth ) | false | | Health reports the health of the agent. |
| `id` | string | false | | |
| `instance_id` | string | false | | |
| `last_connected_at` | string | false | | |
| `latency` | object | false | | Latency is mapped by region name (e.g. "New York City", "Seattle"). |
| » `[any property]` | [codersdk.DERPRegion ](#codersdkderpregion ) | false | | |
| `lifecycle_state` | [codersdk.WorkspaceAgentLifecycle ](#codersdkworkspaceagentlifecycle ) | false | | |
| `log_sources` | array of [codersdk.WorkspaceAgentLogSource ](#codersdkworkspaceagentlogsource ) | false | | |
| `logs_length` | integer | false | | |
| `logs_overflowed` | boolean | false | | |
| `name` | string | false | | |
| `operating_system` | string | false | | |
| `ready_at` | string | false | | |
| `resource_id` | string | false | | |
| `scripts` | array of [codersdk.WorkspaceAgentScript ](#codersdkworkspaceagentscript ) | false | | |
| `started_at` | string | false | | |
| `startup_script_behavior` | [codersdk.WorkspaceAgentStartupScriptBehavior ](#codersdkworkspaceagentstartupscriptbehavior ) | false | | Startup script behavior is a legacy field that is deprecated in favor of the `coder_script` resource. It's only referenced by old clients. Deprecated: Remove in the future! |
| `status` | [codersdk.WorkspaceAgentStatus ](#codersdkworkspaceagentstatus ) | false | | |
| `subsystems` | array of [codersdk.AgentSubsystem ](#codersdkagentsubsystem ) | false | | |
| `troubleshooting_url` | string | false | | |
| `updated_at` | string | false | | |
| `version` | string | false | | |
2023-01-05 14:27:10 +00:00
2023-01-13 11:27:21 +00:00
## codersdk.WorkspaceAgentConnectionInfo
```json
{
2023-08-24 17:22:31 +00:00
"derp_force_websockets": true,
2023-01-13 11:27:21 +00:00
"derp_map": {
2023-08-09 19:50:26 +00:00
"homeParams": {
"regionScore": {
"property1": 0,
"property2": 0
}
},
2023-01-13 11:27:21 +00:00
"omitDefaultRegions": true,
"regions": {
"property1": {
"avoid": true,
"embeddedRelay": true,
"nodes": [
{
2023-08-09 19:50:26 +00:00
"canPort80": true,
2023-01-13 11:27:21 +00:00
"certName": "string",
"derpport": 0,
"forceHTTP": true,
"hostName": "string",
"insecureForTests": true,
"ipv4": "string",
"ipv6": "string",
"name": "string",
"regionID": 0,
"stunonly": true,
"stunport": 0,
"stuntestIP": "string"
}
],
"regionCode": "string",
"regionID": 0,
"regionName": "string"
},
"property2": {
"avoid": true,
"embeddedRelay": true,
"nodes": [
{
2023-08-09 19:50:26 +00:00
"canPort80": true,
2023-01-13 11:27:21 +00:00
"certName": "string",
"derpport": 0,
"forceHTTP": true,
"hostName": "string",
"insecureForTests": true,
"ipv4": "string",
"ipv6": "string",
"name": "string",
"regionID": 0,
"stunonly": true,
"stunport": 0,
"stuntestIP": "string"
}
],
"regionCode": "string",
"regionID": 0,
"regionName": "string"
}
}
2023-06-21 22:02:05 +00:00
},
"disable_direct_connections": true
2023-01-13 11:27:21 +00:00
}
```
### Properties
2023-06-21 22:02:05 +00:00
| Name | Type | Required | Restrictions | Description |
| ---------------------------- | ---------------------------------- | -------- | ------------ | ----------- |
2023-08-24 17:22:31 +00:00
| `derp_force_websockets` | boolean | false | | |
2023-06-21 22:02:05 +00:00
| `derp_map` | [tailcfg.DERPMap ](#tailcfgderpmap ) | false | | |
| `disable_direct_connections` | boolean | false | | |
2023-01-13 11:27:21 +00:00
2023-07-10 09:40:11 +00:00
## codersdk.WorkspaceAgentHealth
```json
{
"healthy": false,
"reason": "agent has lost connection"
}
```
### Properties
| Name | Type | Required | Restrictions | Description |
| --------- | ------- | -------- | ------------ | --------------------------------------------------------------------------------------------- |
| `healthy` | boolean | false | | Healthy is true if the agent is healthy. |
| `reason` | string | false | | Reason is a human-readable explanation of the agent's health. It is empty if Healthy is true. |
2023-01-24 12:24:27 +00:00
## codersdk.WorkspaceAgentLifecycle
```json
"created"
```
### Properties
#### Enumerated Values
2023-03-06 19:34:00 +00:00
| Value |
| ------------------ |
| `created` |
| `starting` |
| `start_timeout` |
| `start_error` |
| `ready` |
| `shutting_down` |
| `shutdown_timeout` |
| `shutdown_error` |
| `off` |
2023-01-24 12:24:27 +00:00
2023-01-29 21:47:24 +00:00
## codersdk.WorkspaceAgentListeningPort
2023-01-05 14:27:10 +00:00
```json
{
2023-01-29 21:47:24 +00:00
"network": "string",
"port": 0,
"process_name": "string"
}
```
### Properties
| Name | Type | Required | Restrictions | Description |
| -------------- | ------- | -------- | ------------ | ------------------------ |
| `network` | string | false | | only "tcp" at the moment |
| `port` | integer | false | | |
| `process_name` | string | false | | may be empty |
## codersdk.WorkspaceAgentListeningPortsResponse
```json
{
"ports": [
2023-01-05 14:27:10 +00:00
{
2023-01-29 21:47:24 +00:00
"network": "string",
"port": 0,
"process_name": "string"
2023-01-05 14:27:10 +00:00
}
2023-01-29 21:47:24 +00:00
]
2023-01-05 14:27:10 +00:00
}
```
### Properties
2023-01-29 21:47:24 +00:00
| Name | Type | Required | Restrictions | Description |
| ------- | ------------------------------------------------------------------------------------- | -------- | ------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `ports` | array of [codersdk.WorkspaceAgentListeningPort ](#codersdkworkspaceagentlisteningport ) | false | | If there are no ports in the list, nothing should be displayed in the UI. There must not be a "no ports available" message or anything similar, as there will always be no ports displayed on platforms where our port detection logic is unsupported. |
2023-01-05 14:27:10 +00:00
2023-07-28 15:57:23 +00:00
## codersdk.WorkspaceAgentLog
```json
{
"created_at": "2019-08-24T14:15:22Z",
"id": 0,
"level": "trace",
2023-09-25 21:47:17 +00:00
"output": "string",
"source_id": "ae50a35c-df42-4eff-ba26-f8bc28d2af81"
2023-07-28 15:57:23 +00:00
}
```
### Properties
| Name | Type | Required | Restrictions | Description |
| ------------ | -------------------------------------- | -------- | ------------ | ----------- |
| `created_at` | string | false | | |
| `id` | integer | false | | |
| `level` | [codersdk.LogLevel ](#codersdkloglevel ) | false | | |
| `output` | string | false | | |
2023-09-25 21:47:17 +00:00
| `source_id` | string | false | | |
2023-07-28 15:57:23 +00:00
## codersdk.WorkspaceAgentLogSource
```json
2023-09-25 21:47:17 +00:00
{
"created_at": "2019-08-24T14:15:22Z",
"display_name": "string",
"icon": "string",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"workspace_agent_id": "7ad2e618-fea7-4c1a-b70a-f501566a72f1"
}
2023-07-28 15:57:23 +00:00
```
### Properties
2023-09-25 21:47:17 +00:00
| Name | Type | Required | Restrictions | Description |
| -------------------- | ------ | -------- | ------------ | ----------- |
| `created_at` | string | false | | |
| `display_name` | string | false | | |
| `icon` | string | false | | |
| `id` | string | false | | |
| `workspace_agent_id` | string | false | | |
2023-07-28 15:57:23 +00:00
2023-03-31 20:26:19 +00:00
## codersdk.WorkspaceAgentMetadataDescription
```json
{
"display_name": "string",
"interval": 0,
"key": "string",
"script": "string",
"timeout": 0
}
```
### Properties
| Name | Type | Required | Restrictions | Description |
| -------------- | ------- | -------- | ------------ | ----------- |
| `display_name` | string | false | | |
| `interval` | integer | false | | |
| `key` | string | false | | |
| `script` | string | false | | |
| `timeout` | integer | false | | |
2024-02-13 14:31:20 +00:00
## codersdk.WorkspaceAgentPortShare
```json
{
"agent_name": "string",
"port": 0,
"share_level": "owner",
"workspace_id": "0967198e-ec7b-4c6b-b4d3-f71244cadbe9"
}
```
### Properties
| Name | Type | Required | Restrictions | Description |
| -------------- | ------------------------------------------------------------------------------ | -------- | ------------ | ----------- |
| `agent_name` | string | false | | |
| `port` | integer | false | | |
| `share_level` | [codersdk.WorkspaceAgentPortShareLevel ](#codersdkworkspaceagentportsharelevel ) | false | | |
| `workspace_id` | string | false | | |
## codersdk.WorkspaceAgentPortShareLevel
```json
"owner"
```
### Properties
#### Enumerated Values
| Value |
| --------------- |
| `owner` |
| `authenticated` |
| `public` |
## codersdk.WorkspaceAgentPortShares
```json
{
"shares": [
{
"agent_name": "string",
"port": 0,
"share_level": "owner",
"workspace_id": "0967198e-ec7b-4c6b-b4d3-f71244cadbe9"
}
]
}
```
### Properties
| Name | Type | Required | Restrictions | Description |
| -------- | ----------------------------------------------------------------------------- | -------- | ------------ | ----------- |
| `shares` | array of [codersdk.WorkspaceAgentPortShare ](#codersdkworkspaceagentportshare ) | false | | |
2023-09-25 21:47:17 +00:00
## codersdk.WorkspaceAgentScript
```json
{
"cron": "string",
"log_path": "string",
"log_source_id": "4197ab25-95cf-4b91-9c78-f7f2af5d353a",
"run_on_start": true,
"run_on_stop": true,
"script": "string",
"start_blocks_login": true,
"timeout": 0
}
```
### Properties
| Name | Type | Required | Restrictions | Description |
| -------------------- | ------- | -------- | ------------ | ----------- |
| `cron` | string | false | | |
| `log_path` | string | false | | |
| `log_source_id` | string | false | | |
| `run_on_start` | boolean | false | | |
| `run_on_stop` | boolean | false | | |
| `script` | string | false | | |
| `start_blocks_login` | boolean | false | | |
| `timeout` | integer | false | | |
2023-06-06 08:58:07 +00:00
## codersdk.WorkspaceAgentStartupScriptBehavior
```json
"blocking"
```
### Properties
#### Enumerated Values
| Value |
| -------------- |
| `blocking` |
| `non-blocking` |
2023-01-10 14:47:08 +00:00
## codersdk.WorkspaceAgentStatus
```json
"connecting"
```
### Properties
#### Enumerated Values
| Value |
| -------------- |
| `connecting` |
| `connected` |
| `disconnected` |
| `timeout` |
2022-12-19 17:43:46 +00:00
## codersdk.WorkspaceApp
```json
{
"command": "string",
"display_name": "string",
"external": true,
2023-01-10 14:47:08 +00:00
"health": "disabled",
2022-12-19 17:43:46 +00:00
"healthcheck": {
"interval": 0,
"threshold": 0,
"url": "string"
},
"icon": "string",
2023-01-05 14:27:10 +00:00
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"sharing_level": "owner",
2022-12-19 17:43:46 +00:00
"slug": "string",
"subdomain": true,
2023-09-12 13:25:10 +00:00
"subdomain_name": "string",
2022-12-19 17:43:46 +00:00
"url": "string"
}
```
### Properties
2023-09-12 13:25:10 +00:00
| Name | Type | Required | Restrictions | Description |
| ---------------- | ---------------------------------------------------------------------- | -------- | ------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `command` | string | false | | |
| `display_name` | string | false | | Display name is a friendly name for the app. |
| `external` | boolean | false | | External specifies whether the URL should be opened externally on the client or not. |
| `health` | [codersdk.WorkspaceAppHealth ](#codersdkworkspaceapphealth ) | false | | |
| `healthcheck` | [codersdk.Healthcheck ](#codersdkhealthcheck ) | false | | Healthcheck specifies the configuration for checking app health. |
| `icon` | string | false | | Icon is a relative path or external URL that specifies an icon to be displayed in the dashboard. |
| `id` | string | false | | |
| `sharing_level` | [codersdk.WorkspaceAppSharingLevel ](#codersdkworkspaceappsharinglevel ) | false | | |
| `slug` | string | false | | Slug is a unique identifier within the agent. |
| `subdomain` | boolean | false | | Subdomain denotes whether the app should be accessed via a path on the `coder server` or via a hostname-based dev URL. If this is set to true and there is no app wildcard configured on the server, the app will not be accessible in the UI. |
| `subdomain_name` | string | false | | Subdomain name is the application domain exposed on the `coder server` . |
| `url` | string | false | | URL is the address being proxied to inside the workspace. If external is specified, this will be opened on the client. |
2022-12-19 17:43:46 +00:00
2023-01-05 14:27:10 +00:00
#### Enumerated Values
| Property | Value |
| --------------- | --------------- |
| `sharing_level` | `owner` |
| `sharing_level` | `authenticated` |
| `sharing_level` | `public` |
2023-01-10 14:47:08 +00:00
## codersdk.WorkspaceAppHealth
```json
"disabled"
```
### Properties
#### Enumerated Values
| Value |
| -------------- |
| `disabled` |
| `initializing` |
| `healthy` |
| `unhealthy` |
## codersdk.WorkspaceAppSharingLevel
```json
"owner"
```
### Properties
#### Enumerated Values
| Value |
| --------------- |
| `owner` |
| `authenticated` |
| `public` |
2022-12-19 17:43:46 +00:00
## codersdk.WorkspaceBuild
```json
{
"build_number": 0,
"created_at": "2019-08-24T14:15:22Z",
"daily_cost": 0,
2023-01-03 18:21:10 +00:00
"deadline": "2019-08-24T14:15:22Z",
2022-12-19 17:43:46 +00:00
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"initiator_id": "06588898-9a84-4b35-ba8f-f9cbd64946f3",
"initiator_name": "string",
"job": {
2023-01-05 14:27:10 +00:00
"canceled_at": "2019-08-24T14:15:22Z",
"completed_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z",
2022-12-19 17:43:46 +00:00
"error": "string",
2023-08-23 16:18:38 +00:00
"error_code": "REQUIRED_TEMPLATE_VARIABLES",
2023-01-05 14:27:10 +00:00
"file_id": "8a0cfb4f-ddc9-436d-91bb-75133c583767",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
2023-06-20 20:07:18 +00:00
"queue_position": 0,
"queue_size": 0,
2023-01-05 14:27:10 +00:00
"started_at": "2019-08-24T14:15:22Z",
"status": "pending",
2022-12-19 17:43:46 +00:00
"tags": {
"property1": "string",
"property2": "string"
},
2023-01-05 14:27:10 +00:00
"worker_id": "ae5fa6f7-c55b-40c1-b40a-b36ac467652b"
2022-12-19 17:43:46 +00:00
},
2023-03-07 14:14:58 +00:00
"max_deadline": "2019-08-24T14:15:22Z",
2023-01-05 14:27:10 +00:00
"reason": "initiator",
2022-12-19 17:43:46 +00:00
"resources": [
{
"agents": [
{
2023-10-31 06:08:43 +00:00
"api_version": "string",
2022-12-19 17:43:46 +00:00
"apps": [
{
"command": "string",
"display_name": "string",
"external": true,
2023-01-10 14:47:08 +00:00
"health": "disabled",
2022-12-19 17:43:46 +00:00
"healthcheck": {
"interval": 0,
"threshold": 0,
"url": "string"
},
"icon": "string",
2023-01-05 14:27:10 +00:00
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"sharing_level": "owner",
2022-12-19 17:43:46 +00:00
"slug": "string",
"subdomain": true,
2023-09-12 13:25:10 +00:00
"subdomain_name": "string",
2022-12-19 17:43:46 +00:00
"url": "string"
}
],
"architecture": "string",
"connection_timeout_seconds": 0,
2023-01-05 14:27:10 +00:00
"created_at": "2019-08-24T14:15:22Z",
2022-12-19 17:43:46 +00:00
"directory": "string",
2023-01-05 14:27:10 +00:00
"disconnected_at": "2019-08-24T14:15:22Z",
2023-08-30 19:53:42 +00:00
"display_apps": ["vscode"],
2022-12-19 17:43:46 +00:00
"environment_variables": {
"property1": "string",
"property2": "string"
},
2023-02-07 21:35:09 +00:00
"expanded_directory": "string",
2023-01-05 14:27:10 +00:00
"first_connected_at": "2019-08-24T14:15:22Z",
2023-07-10 09:40:11 +00:00
"health": {
"healthy": false,
"reason": "agent has lost connection"
},
2023-01-05 14:27:10 +00:00
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
2022-12-19 17:43:46 +00:00
"instance_id": "string",
2023-01-05 14:27:10 +00:00
"last_connected_at": "2019-08-24T14:15:22Z",
2022-12-19 17:43:46 +00:00
"latency": {
"property1": {
"latency_ms": 0,
"preferred": true
},
"property2": {
"latency_ms": 0,
"preferred": true
}
},
2023-01-24 12:24:27 +00:00
"lifecycle_state": "created",
2023-09-25 21:47:17 +00:00
"log_sources": [
{
"created_at": "2019-08-24T14:15:22Z",
"display_name": "string",
"icon": "string",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"workspace_agent_id": "7ad2e618-fea7-4c1a-b70a-f501566a72f1"
}
],
2023-07-28 15:57:23 +00:00
"logs_length": 0,
"logs_overflowed": true,
2022-12-19 17:43:46 +00:00
"name": "string",
"operating_system": "string",
2023-06-20 11:41:55 +00:00
"ready_at": "2019-08-24T14:15:22Z",
2023-01-05 14:27:10 +00:00
"resource_id": "4d5215ed-38bb-48ed-879a-fdb9ca58522f",
2023-09-25 21:47:17 +00:00
"scripts": [
{
"cron": "string",
"log_path": "string",
"log_source_id": "4197ab25-95cf-4b91-9c78-f7f2af5d353a",
"run_on_start": true,
"run_on_stop": true,
"script": "string",
"start_blocks_login": true,
"timeout": 0
}
],
2023-06-20 11:41:55 +00:00
"started_at": "2019-08-24T14:15:22Z",
2023-06-06 08:58:07 +00:00
"startup_script_behavior": "blocking",
2023-01-05 14:27:10 +00:00
"status": "connecting",
2023-08-09 05:10:28 +00:00
"subsystems": ["envbox"],
2022-12-19 17:43:46 +00:00
"troubleshooting_url": "string",
2023-01-05 14:27:10 +00:00
"updated_at": "2019-08-24T14:15:22Z",
2022-12-19 17:43:46 +00:00
"version": "string"
}
],
"created_at": "2019-08-24T14:15:22Z",
"daily_cost": 0,
"hide": true,
"icon": "string",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"job_id": "453bd7d7-5355-4d6d-a38e-d9e7eb218c3f",
"metadata": [
{
"key": "string",
"sensitive": true,
"value": "string"
}
],
"name": "string",
"type": "string",
"workspace_transition": "start"
}
],
"status": "pending",
"template_version_id": "0ba39c92-1f1b-4c32-aa3e-9925d7713eb1",
"template_version_name": "string",
"transition": "start",
"updated_at": "2019-08-24T14:15:22Z",
"workspace_id": "0967198e-ec7b-4c6b-b4d3-f71244cadbe9",
"workspace_name": "string",
2024-01-30 17:07:06 +00:00
"workspace_owner_avatar_url": "string",
2022-12-19 17:43:46 +00:00
"workspace_owner_id": "e7078695-5279-4c86-8774-3ac2367a2fc7",
"workspace_owner_name": "string"
}
```
### Properties
2024-01-30 17:07:06 +00:00
| Name | Type | Required | Restrictions | Description |
| ---------------------------- | ----------------------------------------------------------------- | -------- | ------------ | ----------- |
| `build_number` | integer | false | | |
| `created_at` | string | false | | |
| `daily_cost` | integer | false | | |
| `deadline` | string | false | | |
| `id` | string | false | | |
| `initiator_id` | string | false | | |
| `initiator_name` | string | false | | |
| `job` | [codersdk.ProvisionerJob ](#codersdkprovisionerjob ) | false | | |
| `max_deadline` | string | false | | |
| `reason` | [codersdk.BuildReason ](#codersdkbuildreason ) | false | | |
| `resources` | array of [codersdk.WorkspaceResource ](#codersdkworkspaceresource ) | false | | |
| `status` | [codersdk.WorkspaceStatus ](#codersdkworkspacestatus ) | false | | |
| `template_version_id` | string | false | | |
| `template_version_name` | string | false | | |
| `transition` | [codersdk.WorkspaceTransition ](#codersdkworkspacetransition ) | false | | |
| `updated_at` | string | false | | |
| `workspace_id` | string | false | | |
| `workspace_name` | string | false | | |
| `workspace_owner_avatar_url` | string | false | | |
| `workspace_owner_id` | string | false | | |
| `workspace_owner_name` | string | false | | |
2022-12-19 17:43:46 +00:00
#### Enumerated Values
2022-12-22 14:53:14 +00:00
| Property | Value |
| ------------ | ----------- |
2023-01-05 14:27:10 +00:00
| `reason` | `initiator` |
| `reason` | `autostart` |
| `reason` | `autostop` |
2022-12-22 14:53:14 +00:00
| `status` | `pending` |
| `status` | `starting` |
| `status` | `running` |
| `status` | `stopping` |
| `status` | `stopped` |
| `status` | `failed` |
| `status` | `canceling` |
| `status` | `canceled` |
| `status` | `deleting` |
| `status` | `deleted` |
| `transition` | `start` |
| `transition` | `stop` |
| `transition` | `delete` |
2022-12-19 17:43:46 +00:00
2023-01-17 15:24:45 +00:00
## codersdk.WorkspaceBuildParameter
```json
{
"name": "string",
"value": "string"
}
```
### Properties
| Name | Type | Required | Restrictions | Description |
| ------- | ------ | -------- | ------------ | ----------- |
| `name` | string | false | | |
| `value` | string | false | | |
2023-03-09 03:05:45 +00:00
## codersdk.WorkspaceConnectionLatencyMS
```json
{
"p50": 0,
"p95": 0
}
```
### Properties
| Name | Type | Required | Restrictions | Description |
| ----- | ------ | -------- | ------------ | ----------- |
| `p50` | number | false | | |
| `p95` | number | false | | |
## codersdk.WorkspaceDeploymentStats
```json
{
"building": 0,
"connection_latency_ms": {
"p50": 0,
"p95": 0
},
"failed": 0,
"pending": 0,
"running": 0,
"rx_bytes": 0,
"stopped": 0,
"tx_bytes": 0
}
```
### Properties
| Name | Type | Required | Restrictions | Description |
| ----------------------- | ------------------------------------------------------------------------------ | -------- | ------------ | ----------- |
| `building` | integer | false | | |
| `connection_latency_ms` | [codersdk.WorkspaceConnectionLatencyMS ](#codersdkworkspaceconnectionlatencyms ) | false | | |
| `failed` | integer | false | | |
| `pending` | integer | false | | |
| `running` | integer | false | | |
| `rx_bytes` | integer | false | | |
| `stopped` | integer | false | | |
| `tx_bytes` | integer | false | | |
2023-07-10 09:40:11 +00:00
## codersdk.WorkspaceHealth
```json
{
"failing_agents": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"],
"healthy": false
}
```
### Properties
| Name | Type | Required | Restrictions | Description |
| ---------------- | --------------- | -------- | ------------ | -------------------------------------------------------------------- |
| `failing_agents` | array of string | false | | Failing agents lists the IDs of the agents that are failing, if any. |
| `healthy` | boolean | false | | Healthy is true if the workspace is healthy. |
2023-04-04 20:07:29 +00:00
## codersdk.WorkspaceProxy
```json
{
"created_at": "2019-08-24T14:15:22Z",
"deleted": true,
2023-07-26 16:21:04 +00:00
"derp_enabled": true,
2023-08-02 14:35:06 +00:00
"derp_only": true,
2023-05-09 18:46:50 +00:00
"display_name": "string",
2023-06-30 15:32:35 +00:00
"healthy": true,
"icon_url": "string",
2023-04-04 20:07:29 +00:00
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
2023-06-30 15:32:35 +00:00
"path_app_url": "string",
2023-04-24 15:25:35 +00:00
"status": {
"checked_at": "2019-08-24T14:15:22Z",
"report": {
"errors": ["string"],
"warnings": ["string"]
},
2023-05-11 00:23:16 +00:00
"status": "ok"
2023-04-24 15:25:35 +00:00
},
2023-04-04 20:07:29 +00:00
"updated_at": "2019-08-24T14:15:22Z",
2023-11-21 11:21:25 +00:00
"version": "string",
2023-04-04 20:07:29 +00:00
"wildcard_hostname": "string"
}
```
### Properties
2023-06-30 15:32:35 +00:00
| Name | Type | Required | Restrictions | Description |
| ------------------- | -------------------------------------------------------------- | -------- | ------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `created_at` | string | false | | |
| `deleted` | boolean | false | | |
2023-07-26 16:21:04 +00:00
| `derp_enabled` | boolean | false | | |
2023-08-02 14:35:06 +00:00
| `derp_only` | boolean | false | | |
2023-06-30 15:32:35 +00:00
| `display_name` | string | false | | |
| `healthy` | boolean | false | | |
| `icon_url` | string | false | | |
| `id` | string | false | | |
| `name` | string | false | | |
| `path_app_url` | string | false | | Path app URL is the URL to the base path for path apps. Optional unless wildcard_hostname is set. E.g. https://us.example.com |
| `status` | [codersdk.WorkspaceProxyStatus ](#codersdkworkspaceproxystatus ) | false | | Status is the latest status check of the proxy. This will be empty for deleted proxies. This value can be used to determine if a workspace proxy is healthy and ready to use. |
| `updated_at` | string | false | | |
2023-11-21 11:21:25 +00:00
| `version` | string | false | | |
2023-06-30 15:32:35 +00:00
| `wildcard_hostname` | string | false | | Wildcard hostname is the wildcard hostname for subdomain apps. E.g. _.us.example.com E.g. _ --suffix.au.example.com Optional. Does not need to be on the same domain as PathAppURL. |
2023-04-24 15:25:35 +00:00
## codersdk.WorkspaceProxyStatus
```json
{
"checked_at": "2019-08-24T14:15:22Z",
"report": {
"errors": ["string"],
"warnings": ["string"]
},
2023-05-11 00:23:16 +00:00
"status": "ok"
2023-04-24 15:25:35 +00:00
}
```
### Properties
| Name | Type | Required | Restrictions | Description |
| ------------ | -------------------------------------------------------- | -------- | ------------ | ------------------------------------------------------------------------- |
| `checked_at` | string | false | | |
| `report` | [codersdk.ProxyHealthReport ](#codersdkproxyhealthreport ) | false | | Report provides more information about the health of the workspace proxy. |
| `status` | [codersdk.ProxyHealthStatus ](#codersdkproxyhealthstatus ) | false | | |
2023-04-04 20:07:29 +00:00
2023-01-11 15:05:42 +00:00
## codersdk.WorkspaceQuota
```json
{
"budget": 0,
"credits_consumed": 0
}
```
### Properties
| Name | Type | Required | Restrictions | Description |
| ------------------ | ------- | -------- | ------------ | ----------- |
| `budget` | integer | false | | |
| `credits_consumed` | integer | false | | |
2022-12-19 17:43:46 +00:00
## codersdk.WorkspaceResource
```json
{
"agents": [
{
2023-10-31 06:08:43 +00:00
"api_version": "string",
2022-12-19 17:43:46 +00:00
"apps": [
{
"command": "string",
"display_name": "string",
"external": true,
2023-01-10 14:47:08 +00:00
"health": "disabled",
2022-12-19 17:43:46 +00:00
"healthcheck": {
"interval": 0,
"threshold": 0,
"url": "string"
},
"icon": "string",
2023-01-05 14:27:10 +00:00
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"sharing_level": "owner",
2022-12-19 17:43:46 +00:00
"slug": "string",
"subdomain": true,
2023-09-12 13:25:10 +00:00
"subdomain_name": "string",
2022-12-19 17:43:46 +00:00
"url": "string"
}
],
"architecture": "string",
"connection_timeout_seconds": 0,
2023-01-05 14:27:10 +00:00
"created_at": "2019-08-24T14:15:22Z",
2022-12-19 17:43:46 +00:00
"directory": "string",
2023-01-05 14:27:10 +00:00
"disconnected_at": "2019-08-24T14:15:22Z",
2023-08-30 19:53:42 +00:00
"display_apps": ["vscode"],
2022-12-19 17:43:46 +00:00
"environment_variables": {
"property1": "string",
"property2": "string"
},
2023-02-07 21:35:09 +00:00
"expanded_directory": "string",
2023-01-05 14:27:10 +00:00
"first_connected_at": "2019-08-24T14:15:22Z",
2023-07-10 09:40:11 +00:00
"health": {
"healthy": false,
"reason": "agent has lost connection"
},
2023-01-05 14:27:10 +00:00
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
2022-12-19 17:43:46 +00:00
"instance_id": "string",
2023-01-05 14:27:10 +00:00
"last_connected_at": "2019-08-24T14:15:22Z",
2022-12-19 17:43:46 +00:00
"latency": {
"property1": {
"latency_ms": 0,
"preferred": true
},
"property2": {
"latency_ms": 0,
"preferred": true
}
},
2023-01-24 12:24:27 +00:00
"lifecycle_state": "created",
2023-09-25 21:47:17 +00:00
"log_sources": [
{
"created_at": "2019-08-24T14:15:22Z",
"display_name": "string",
"icon": "string",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"workspace_agent_id": "7ad2e618-fea7-4c1a-b70a-f501566a72f1"
}
],
2023-07-28 15:57:23 +00:00
"logs_length": 0,
"logs_overflowed": true,
2022-12-19 17:43:46 +00:00
"name": "string",
"operating_system": "string",
2023-06-20 11:41:55 +00:00
"ready_at": "2019-08-24T14:15:22Z",
2023-01-05 14:27:10 +00:00
"resource_id": "4d5215ed-38bb-48ed-879a-fdb9ca58522f",
2023-09-25 21:47:17 +00:00
"scripts": [
{
"cron": "string",
"log_path": "string",
"log_source_id": "4197ab25-95cf-4b91-9c78-f7f2af5d353a",
"run_on_start": true,
"run_on_stop": true,
"script": "string",
"start_blocks_login": true,
"timeout": 0
}
],
2023-06-20 11:41:55 +00:00
"started_at": "2019-08-24T14:15:22Z",
2023-06-06 08:58:07 +00:00
"startup_script_behavior": "blocking",
2023-01-05 14:27:10 +00:00
"status": "connecting",
2023-08-09 05:10:28 +00:00
"subsystems": ["envbox"],
2022-12-19 17:43:46 +00:00
"troubleshooting_url": "string",
2023-01-05 14:27:10 +00:00
"updated_at": "2019-08-24T14:15:22Z",
2022-12-19 17:43:46 +00:00
"version": "string"
}
],
"created_at": "2019-08-24T14:15:22Z",
"daily_cost": 0,
"hide": true,
"icon": "string",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"job_id": "453bd7d7-5355-4d6d-a38e-d9e7eb218c3f",
"metadata": [
{
"key": "string",
"sensitive": true,
"value": "string"
}
],
"name": "string",
"type": "string",
"workspace_transition": "start"
}
```
### Properties
| Name | Type | Required | Restrictions | Description |
| ---------------------- | --------------------------------------------------------------------------------- | -------- | ------------ | ----------- |
2022-12-21 14:37:30 +00:00
| `agents` | array of [codersdk.WorkspaceAgent ](#codersdkworkspaceagent ) | false | | |
| `created_at` | string | false | | |
| `daily_cost` | integer | false | | |
| `hide` | boolean | false | | |
| `icon` | string | false | | |
| `id` | string | false | | |
| `job_id` | string | false | | |
| `metadata` | array of [codersdk.WorkspaceResourceMetadata ](#codersdkworkspaceresourcemetadata ) | false | | |
| `name` | string | false | | |
| `type` | string | false | | |
2023-01-10 14:47:08 +00:00
| `workspace_transition` | [codersdk.WorkspaceTransition ](#codersdkworkspacetransition ) | false | | |
2022-12-19 17:43:46 +00:00
#### Enumerated Values
2022-12-22 14:53:14 +00:00
| Property | Value |
| ---------------------- | -------- |
| `workspace_transition` | `start` |
| `workspace_transition` | `stop` |
| `workspace_transition` | `delete` |
2022-12-19 17:43:46 +00:00
## codersdk.WorkspaceResourceMetadata
```json
{
"key": "string",
"sensitive": true,
"value": "string"
}
```
### Properties
| Name | Type | Required | Restrictions | Description |
| ----------- | ------- | -------- | ------------ | ----------- |
2022-12-21 14:37:30 +00:00
| `key` | string | false | | |
| `sensitive` | boolean | false | | |
| `value` | string | false | | |
2022-12-19 17:43:46 +00:00
2023-01-10 14:47:08 +00:00
## codersdk.WorkspaceStatus
```json
"pending"
```
### Properties
#### Enumerated Values
| Value |
| ----------- |
| `pending` |
| `starting` |
| `running` |
| `stopping` |
| `stopped` |
| `failed` |
| `canceling` |
| `canceled` |
| `deleting` |
| `deleted` |
## codersdk.WorkspaceTransition
```json
"start"
```
### Properties
#### Enumerated Values
| Value |
| -------- |
| `start` |
| `stop` |
| `delete` |
2022-12-19 17:43:46 +00:00
## codersdk.WorkspacesResponse
```json
{
"count": 0,
"workspaces": [
{
2023-12-15 18:38:47 +00:00
"allow_renames": true,
2023-10-06 09:27:12 +00:00
"automatic_updates": "always",
2022-12-19 17:43:46 +00:00
"autostart_schedule": "string",
"created_at": "2019-08-24T14:15:22Z",
2023-05-11 15:47:53 +00:00
"deleting_at": "2019-08-24T14:15:22Z",
2023-08-24 18:25:54 +00:00
"dormant_at": "2019-08-24T14:15:22Z",
2024-01-24 13:39:19 +00:00
"favorite": true,
2023-07-10 09:40:11 +00:00
"health": {
"failing_agents": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"],
"healthy": false
},
2022-12-19 17:43:46 +00:00
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"last_used_at": "2019-08-24T14:15:22Z",
"latest_build": {
"build_number": 0,
"created_at": "2019-08-24T14:15:22Z",
"daily_cost": 0,
2023-01-03 18:21:10 +00:00
"deadline": "2019-08-24T14:15:22Z",
2022-12-19 17:43:46 +00:00
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"initiator_id": "06588898-9a84-4b35-ba8f-f9cbd64946f3",
"initiator_name": "string",
"job": {
2023-01-05 14:27:10 +00:00
"canceled_at": "2019-08-24T14:15:22Z",
"completed_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z",
2022-12-19 17:43:46 +00:00
"error": "string",
2023-08-23 16:18:38 +00:00
"error_code": "REQUIRED_TEMPLATE_VARIABLES",
2023-01-05 14:27:10 +00:00
"file_id": "8a0cfb4f-ddc9-436d-91bb-75133c583767",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
2023-06-20 20:07:18 +00:00
"queue_position": 0,
"queue_size": 0,
2023-01-05 14:27:10 +00:00
"started_at": "2019-08-24T14:15:22Z",
"status": "pending",
2022-12-19 17:43:46 +00:00
"tags": {
"property1": "string",
"property2": "string"
},
2023-01-05 14:27:10 +00:00
"worker_id": "ae5fa6f7-c55b-40c1-b40a-b36ac467652b"
2022-12-19 17:43:46 +00:00
},
2023-03-07 14:14:58 +00:00
"max_deadline": "2019-08-24T14:15:22Z",
2023-01-05 14:27:10 +00:00
"reason": "initiator",
2022-12-19 17:43:46 +00:00
"resources": [
{
"agents": [
{
2023-10-31 06:08:43 +00:00
"api_version": "string",
2022-12-19 17:43:46 +00:00
"apps": [
{
"command": "string",
"display_name": "string",
"external": true,
2023-01-10 14:47:08 +00:00
"health": "disabled",
2022-12-19 17:43:46 +00:00
"healthcheck": {},
"icon": "string",
2023-01-05 14:27:10 +00:00
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"sharing_level": "owner",
2022-12-19 17:43:46 +00:00
"slug": "string",
"subdomain": true,
2023-09-12 13:25:10 +00:00
"subdomain_name": "string",
2022-12-19 17:43:46 +00:00
"url": "string"
}
],
"architecture": "string",
"connection_timeout_seconds": 0,
2023-01-05 14:27:10 +00:00
"created_at": "2019-08-24T14:15:22Z",
2022-12-19 17:43:46 +00:00
"directory": "string",
2023-01-05 14:27:10 +00:00
"disconnected_at": "2019-08-24T14:15:22Z",
2023-08-30 19:53:42 +00:00
"display_apps": ["vscode"],
2022-12-19 17:43:46 +00:00
"environment_variables": {
"property1": "string",
"property2": "string"
},
2023-02-07 21:35:09 +00:00
"expanded_directory": "string",
2023-01-05 14:27:10 +00:00
"first_connected_at": "2019-08-24T14:15:22Z",
2023-07-10 09:40:11 +00:00
"health": {
"healthy": false,
"reason": "agent has lost connection"
},
2023-01-05 14:27:10 +00:00
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
2022-12-19 17:43:46 +00:00
"instance_id": "string",
2023-01-05 14:27:10 +00:00
"last_connected_at": "2019-08-24T14:15:22Z",
2022-12-19 17:43:46 +00:00
"latency": {
"property1": {
"latency_ms": 0,
"preferred": true
},
"property2": {
"latency_ms": 0,
"preferred": true
}
},
2023-01-24 12:24:27 +00:00
"lifecycle_state": "created",
2023-09-25 21:47:17 +00:00
"log_sources": [
{
"created_at": "2019-08-24T14:15:22Z",
"display_name": "string",
"icon": "string",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"workspace_agent_id": "7ad2e618-fea7-4c1a-b70a-f501566a72f1"
}
],
2023-07-28 15:57:23 +00:00
"logs_length": 0,
"logs_overflowed": true,
2022-12-19 17:43:46 +00:00
"name": "string",
"operating_system": "string",
2023-06-20 11:41:55 +00:00
"ready_at": "2019-08-24T14:15:22Z",
2023-01-05 14:27:10 +00:00
"resource_id": "4d5215ed-38bb-48ed-879a-fdb9ca58522f",
2023-09-25 21:47:17 +00:00
"scripts": [
{
"cron": "string",
"log_path": "string",
"log_source_id": "4197ab25-95cf-4b91-9c78-f7f2af5d353a",
"run_on_start": true,
"run_on_stop": true,
"script": "string",
"start_blocks_login": true,
"timeout": 0
}
],
2023-06-20 11:41:55 +00:00
"started_at": "2019-08-24T14:15:22Z",
2023-06-06 08:58:07 +00:00
"startup_script_behavior": "blocking",
2023-01-05 14:27:10 +00:00
"status": "connecting",
2023-08-09 05:10:28 +00:00
"subsystems": ["envbox"],
2022-12-19 17:43:46 +00:00
"troubleshooting_url": "string",
2023-01-05 14:27:10 +00:00
"updated_at": "2019-08-24T14:15:22Z",
2022-12-19 17:43:46 +00:00
"version": "string"
}
],
"created_at": "2019-08-24T14:15:22Z",
"daily_cost": 0,
"hide": true,
"icon": "string",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"job_id": "453bd7d7-5355-4d6d-a38e-d9e7eb218c3f",
"metadata": [
{
"key": "string",
"sensitive": true,
"value": "string"
}
],
"name": "string",
"type": "string",
"workspace_transition": "start"
}
],
"status": "pending",
"template_version_id": "0ba39c92-1f1b-4c32-aa3e-9925d7713eb1",
"template_version_name": "string",
"transition": "start",
"updated_at": "2019-08-24T14:15:22Z",
"workspace_id": "0967198e-ec7b-4c6b-b4d3-f71244cadbe9",
"workspace_name": "string",
2024-01-30 17:07:06 +00:00
"workspace_owner_avatar_url": "string",
2022-12-19 17:43:46 +00:00
"workspace_owner_id": "e7078695-5279-4c86-8774-3ac2367a2fc7",
"workspace_owner_name": "string"
},
"name": "string",
2023-03-21 14:10:22 +00:00
"organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
2022-12-19 17:43:46 +00:00
"outdated": true,
2024-01-30 17:07:06 +00:00
"owner_avatar_url": "string",
2022-12-19 17:43:46 +00:00
"owner_id": "8826ee2e-7933-4665-aef2-2393f84a0d05",
"owner_name": "string",
2023-08-27 16:26:20 +00:00
"template_active_version_id": "b0da9c29-67d8-4c87-888c-bafe356f7f3c",
2022-12-19 17:43:46 +00:00
"template_allow_user_cancel_workspace_jobs": true,
"template_display_name": "string",
"template_icon": "string",
"template_id": "c6d67e98-83ea-49f0-8812-e4abae2b68bc",
"template_name": "string",
2023-10-19 23:21:52 +00:00
"template_require_active_version": true,
2022-12-19 17:43:46 +00:00
"ttl_ms": 0,
"updated_at": "2019-08-24T14:15:22Z"
}
]
}
```
### Properties
| Name | Type | Required | Restrictions | Description |
| ------------ | ------------------------------------------------- | -------- | ------------ | ----------- |
2022-12-21 14:37:30 +00:00
| `count` | integer | false | | |
| `workspaces` | array of [codersdk.Workspace ](#codersdkworkspace ) | false | | |
2023-01-03 18:21:10 +00:00
2023-04-20 01:03:05 +00:00
## derp.ServerInfoMessage
```json
{
"tokenBucketBytesBurst": 0,
"tokenBucketBytesPerSecond": 0
}
```
### Properties
| Name | Type | Required | Restrictions | Description |
| ------------------------------------------------------------------------------------------ | ------- | -------- | ------------ | ------------------------------------------------------------------------------------------------------------------------ |
| `tokenBucketBytesBurst` | integer | false | | Tokenbucketbytesburst is how many bytes the server will allow to burst, temporarily violating TokenBucketBytesPerSecond. |
| Zero means unspecified. There might be a limit, but the client need not try to respect it. |
| `tokenBucketBytesPerSecond` | integer | false | | Tokenbucketbytespersecond is how many bytes per second the server says it will accept, including all framing bytes. |
| Zero means unspecified. There might be a limit, but the client need not try to respect it. |
2023-09-04 18:41:50 +00:00
## derphealth.NodeReport
2023-04-03 06:28:42 +00:00
```json
{
"can_exchange_messages": true,
2023-06-27 19:13:54 +00:00
"client_errs": [["string"]],
2023-04-03 06:28:42 +00:00
"client_logs": [["string"]],
2023-06-27 19:13:54 +00:00
"error": "string",
2023-04-03 06:28:42 +00:00
"healthy": true,
"node": {
2023-08-09 19:50:26 +00:00
"canPort80": true,
2023-04-03 06:28:42 +00:00
"certName": "string",
"derpport": 0,
"forceHTTP": true,
"hostName": "string",
"insecureForTests": true,
"ipv4": "string",
"ipv6": "string",
"name": "string",
"regionID": 0,
"stunonly": true,
"stunport": 0,
"stuntestIP": "string"
},
2023-04-20 01:03:05 +00:00
"node_info": {
"tokenBucketBytesBurst": 0,
"tokenBucketBytesPerSecond": 0
},
2023-08-03 21:20:46 +00:00
"round_trip_ping": "string",
"round_trip_ping_ms": 0,
2023-11-23 15:08:41 +00:00
"severity": "ok",
2023-04-03 06:28:42 +00:00
"stun": {
"canSTUN": true,
"enabled": true,
2023-08-03 21:20:46 +00:00
"error": "string"
2023-04-03 06:28:42 +00:00
},
2023-11-17 15:00:49 +00:00
"uses_websocket": true,
2023-11-30 14:49:50 +00:00
"warnings": [
{
"code": "EUNKNOWN",
"message": "string"
}
]
2023-04-03 06:28:42 +00:00
}
```
### Properties
2023-11-23 15:08:41 +00:00
| Name | Type | Required | Restrictions | Description |
| ----------------------- | ------------------------------------------------ | -------- | ------------ | ------------------------------------------------------------------------------------------- |
| `can_exchange_messages` | boolean | false | | |
| `client_errs` | array of array | false | | |
| `client_logs` | array of array | false | | |
| `error` | string | false | | |
| `healthy` | boolean | false | | Healthy is deprecated and left for backward compatibility purposes, use `Severity` instead. |
| `node` | [tailcfg.DERPNode ](#tailcfgderpnode ) | false | | |
| `node_info` | [derp.ServerInfoMessage ](#derpserverinfomessage ) | false | | |
| `round_trip_ping` | string | false | | |
| `round_trip_ping_ms` | integer | false | | |
| `severity` | [health.Severity ](#healthseverity ) | false | | |
| `stun` | [derphealth.StunReport ](#derphealthstunreport ) | false | | |
| `uses_websocket` | boolean | false | | |
2023-11-30 14:49:50 +00:00
| `warnings` | array of [health.Message ](#healthmessage ) | false | | |
2023-11-23 15:08:41 +00:00
#### Enumerated Values
| Property | Value |
| ---------- | --------- |
| `severity` | `ok` |
| `severity` | `warning` |
| `severity` | `error` |
2023-04-03 06:28:42 +00:00
2023-09-04 18:41:50 +00:00
## derphealth.RegionReport
2023-04-03 06:28:42 +00:00
```json
{
2023-06-27 19:13:54 +00:00
"error": "string",
2023-04-03 06:28:42 +00:00
"healthy": true,
"node_reports": [
{
"can_exchange_messages": true,
2023-06-27 19:13:54 +00:00
"client_errs": [["string"]],
2023-04-03 06:28:42 +00:00
"client_logs": [["string"]],
2023-06-27 19:13:54 +00:00
"error": "string",
2023-04-03 06:28:42 +00:00
"healthy": true,
"node": {
2023-08-09 19:50:26 +00:00
"canPort80": true,
2023-04-03 06:28:42 +00:00
"certName": "string",
"derpport": 0,
"forceHTTP": true,
"hostName": "string",
"insecureForTests": true,
"ipv4": "string",
"ipv6": "string",
"name": "string",
"regionID": 0,
"stunonly": true,
"stunport": 0,
"stuntestIP": "string"
},
2023-04-20 01:03:05 +00:00
"node_info": {
"tokenBucketBytesBurst": 0,
"tokenBucketBytesPerSecond": 0
},
2023-08-03 21:20:46 +00:00
"round_trip_ping": "string",
"round_trip_ping_ms": 0,
2023-11-23 15:08:41 +00:00
"severity": "ok",
2023-04-03 06:28:42 +00:00
"stun": {
"canSTUN": true,
"enabled": true,
2023-08-03 21:20:46 +00:00
"error": "string"
2023-04-03 06:28:42 +00:00
},
2023-11-17 15:00:49 +00:00
"uses_websocket": true,
2023-11-30 14:49:50 +00:00
"warnings": [
{
"code": "EUNKNOWN",
"message": "string"
}
]
2023-04-03 06:28:42 +00:00
}
],
"region": {
"avoid": true,
"embeddedRelay": true,
"nodes": [
{
2023-08-09 19:50:26 +00:00
"canPort80": true,
2023-04-03 06:28:42 +00:00
"certName": "string",
"derpport": 0,
"forceHTTP": true,
"hostName": "string",
"insecureForTests": true,
"ipv4": "string",
"ipv6": "string",
"name": "string",
"regionID": 0,
"stunonly": true,
"stunport": 0,
"stuntestIP": "string"
}
],
"regionCode": "string",
"regionID": 0,
"regionName": "string"
2023-11-17 15:00:49 +00:00
},
2023-11-23 15:08:41 +00:00
"severity": "ok",
2023-11-30 14:49:50 +00:00
"warnings": [
{
"code": "EUNKNOWN",
"message": "string"
}
]
2023-04-03 06:28:42 +00:00
}
```
### Properties
2023-11-23 15:08:41 +00:00
| Name | Type | Required | Restrictions | Description |
| -------------- | ------------------------------------------------------- | -------- | ------------ | ------------------------------------------------------------------------------------------- |
| `error` | string | false | | |
| `healthy` | boolean | false | | Healthy is deprecated and left for backward compatibility purposes, use `Severity` instead. |
| `node_reports` | array of [derphealth.NodeReport ](#derphealthnodereport ) | false | | |
| `region` | [tailcfg.DERPRegion ](#tailcfgderpregion ) | false | | |
| `severity` | [health.Severity ](#healthseverity ) | false | | |
2023-11-30 14:49:50 +00:00
| `warnings` | array of [health.Message ](#healthmessage ) | false | | |
2023-11-23 15:08:41 +00:00
#### Enumerated Values
| Property | Value |
| ---------- | --------- |
| `severity` | `ok` |
| `severity` | `warning` |
| `severity` | `error` |
2023-04-03 06:28:42 +00:00
2023-09-04 18:41:50 +00:00
## derphealth.Report
2023-04-03 06:28:42 +00:00
```json
{
2023-11-29 16:37:40 +00:00
"dismissed": true,
2023-06-27 19:13:54 +00:00
"error": "string",
2023-04-03 06:28:42 +00:00
"healthy": true,
"netcheck": {
"captivePortal": "string",
"globalV4": "string",
"globalV6": "string",
"hairPinning": "string",
"icmpv4": true,
"ipv4": true,
"ipv4CanSend": true,
"ipv6": true,
"ipv6CanSend": true,
"mappingVariesByDestIP": "string",
"oshasIPv6": true,
"pcp": "string",
"pmp": "string",
"preferredDERP": 0,
"regionLatency": {
"property1": 0,
"property2": 0
},
"regionV4Latency": {
"property1": 0,
"property2": 0
},
"regionV6Latency": {
"property1": 0,
"property2": 0
},
"udp": true,
"upnP": "string"
},
2023-06-27 19:13:54 +00:00
"netcheck_err": "string",
2023-04-03 06:28:42 +00:00
"netcheck_logs": ["string"],
"regions": {
"property1": {
2023-06-27 19:13:54 +00:00
"error": "string",
2023-04-03 06:28:42 +00:00
"healthy": true,
"node_reports": [
{
"can_exchange_messages": true,
2023-06-27 19:13:54 +00:00
"client_errs": [["string"]],
2023-04-03 06:28:42 +00:00
"client_logs": [["string"]],
2023-06-27 19:13:54 +00:00
"error": "string",
2023-04-03 06:28:42 +00:00
"healthy": true,
"node": {
2023-08-09 19:50:26 +00:00
"canPort80": true,
2023-04-03 06:28:42 +00:00
"certName": "string",
"derpport": 0,
"forceHTTP": true,
"hostName": "string",
"insecureForTests": true,
"ipv4": "string",
"ipv6": "string",
"name": "string",
"regionID": 0,
"stunonly": true,
"stunport": 0,
"stuntestIP": "string"
},
2023-04-20 01:03:05 +00:00
"node_info": {
"tokenBucketBytesBurst": 0,
"tokenBucketBytesPerSecond": 0
},
2023-08-03 21:20:46 +00:00
"round_trip_ping": "string",
"round_trip_ping_ms": 0,
2023-11-23 15:08:41 +00:00
"severity": "ok",
2023-04-03 06:28:42 +00:00
"stun": {
"canSTUN": true,
"enabled": true,
2023-08-03 21:20:46 +00:00
"error": "string"
2023-04-03 06:28:42 +00:00
},
2023-11-17 15:00:49 +00:00
"uses_websocket": true,
2023-11-30 14:49:50 +00:00
"warnings": [
{
"code": "EUNKNOWN",
"message": "string"
}
]
2023-04-03 06:28:42 +00:00
}
],
"region": {
"avoid": true,
"embeddedRelay": true,
"nodes": [
{
2023-08-09 19:50:26 +00:00
"canPort80": true,
2023-04-03 06:28:42 +00:00
"certName": "string",
"derpport": 0,
"forceHTTP": true,
"hostName": "string",
"insecureForTests": true,
"ipv4": "string",
"ipv6": "string",
"name": "string",
"regionID": 0,
"stunonly": true,
"stunport": 0,
"stuntestIP": "string"
}
],
"regionCode": "string",
"regionID": 0,
"regionName": "string"
2023-11-17 15:00:49 +00:00
},
2023-11-23 15:08:41 +00:00
"severity": "ok",
2023-11-30 14:49:50 +00:00
"warnings": [
{
"code": "EUNKNOWN",
"message": "string"
}
]
2023-04-03 06:28:42 +00:00
},
"property2": {
2023-06-27 19:13:54 +00:00
"error": "string",
2023-04-03 06:28:42 +00:00
"healthy": true,
"node_reports": [
{
"can_exchange_messages": true,
2023-06-27 19:13:54 +00:00
"client_errs": [["string"]],
2023-04-03 06:28:42 +00:00
"client_logs": [["string"]],
2023-06-27 19:13:54 +00:00
"error": "string",
2023-04-03 06:28:42 +00:00
"healthy": true,
"node": {
2023-08-09 19:50:26 +00:00
"canPort80": true,
2023-04-03 06:28:42 +00:00
"certName": "string",
"derpport": 0,
"forceHTTP": true,
"hostName": "string",
"insecureForTests": true,
"ipv4": "string",
"ipv6": "string",
"name": "string",
"regionID": 0,
"stunonly": true,
"stunport": 0,
"stuntestIP": "string"
},
2023-04-20 01:03:05 +00:00
"node_info": {
"tokenBucketBytesBurst": 0,
"tokenBucketBytesPerSecond": 0
},
2023-08-03 21:20:46 +00:00
"round_trip_ping": "string",
"round_trip_ping_ms": 0,
2023-11-23 15:08:41 +00:00
"severity": "ok",
2023-04-03 06:28:42 +00:00
"stun": {
"canSTUN": true,
"enabled": true,
2023-08-03 21:20:46 +00:00
"error": "string"
2023-04-03 06:28:42 +00:00
},
2023-11-17 15:00:49 +00:00
"uses_websocket": true,
2023-11-30 14:49:50 +00:00
"warnings": [
{
"code": "EUNKNOWN",
"message": "string"
}
]
2023-04-03 06:28:42 +00:00
}
],
"region": {
"avoid": true,
"embeddedRelay": true,
"nodes": [
{
2023-08-09 19:50:26 +00:00
"canPort80": true,
2023-04-03 06:28:42 +00:00
"certName": "string",
"derpport": 0,
"forceHTTP": true,
"hostName": "string",
"insecureForTests": true,
"ipv4": "string",
"ipv6": "string",
"name": "string",
"regionID": 0,
"stunonly": true,
"stunport": 0,
"stuntestIP": "string"
}
],
"regionCode": "string",
"regionID": 0,
"regionName": "string"
2023-11-17 15:00:49 +00:00
},
2023-11-23 15:08:41 +00:00
"severity": "ok",
2023-11-30 14:49:50 +00:00
"warnings": [
{
"code": "EUNKNOWN",
"message": "string"
}
]
2023-04-03 06:28:42 +00:00
}
2023-11-17 15:00:49 +00:00
},
2023-11-23 15:08:41 +00:00
"severity": "ok",
2023-11-30 14:49:50 +00:00
"warnings": [
{
"code": "EUNKNOWN",
"message": "string"
}
]
2023-04-03 06:28:42 +00:00
}
```
### Properties
2023-11-23 15:08:41 +00:00
| Name | Type | Required | Restrictions | Description |
| ------------------ | -------------------------------------------------- | -------- | ------------ | ------------------------------------------------------------------------------------------- |
2023-11-29 16:37:40 +00:00
| `dismissed` | boolean | false | | |
2023-11-23 15:08:41 +00:00
| `error` | string | false | | |
| `healthy` | boolean | false | | Healthy is deprecated and left for backward compatibility purposes, use `Severity` instead. |
| `netcheck` | [netcheck.Report ](#netcheckreport ) | false | | |
| `netcheck_err` | string | false | | |
| `netcheck_logs` | array of string | false | | |
| `regions` | object | false | | |
| » `[any property]` | [derphealth.RegionReport ](#derphealthregionreport ) | false | | |
| `severity` | [health.Severity ](#healthseverity ) | false | | |
2023-11-30 14:49:50 +00:00
| `warnings` | array of [health.Message ](#healthmessage ) | false | | |
2023-11-23 15:08:41 +00:00
#### Enumerated Values
| Property | Value |
| ---------- | --------- |
| `severity` | `ok` |
| `severity` | `warning` |
| `severity` | `error` |
2023-04-03 06:28:42 +00:00
2023-09-04 18:41:50 +00:00
## derphealth.StunReport
2023-04-03 06:28:42 +00:00
```json
{
"canSTUN": true,
"enabled": true,
2023-08-03 21:20:46 +00:00
"error": "string"
2023-04-03 06:28:42 +00:00
}
```
### Properties
| Name | Type | Required | Restrictions | Description |
| --------- | ------- | -------- | ------------ | ----------- |
| `canSTUN` | boolean | false | | |
| `enabled` | boolean | false | | |
2023-08-03 21:20:46 +00:00
| `error` | string | false | | |
2023-04-03 06:28:42 +00:00
2023-11-30 14:49:50 +00:00
## health.Code
```json
"EUNKNOWN"
```
### Properties
#### Enumerated Values
| Value |
| ---------- |
| `EUNKNOWN` |
| `EWP01` |
| `EWP02` |
| `EWP03` |
| `EWP04` |
| `EDB01` |
| `EDB02` |
| `EWS01` |
| `EWS02` |
| `EWS03` |
| `EACS01` |
| `EACS02` |
| `EACS03` |
| `EACS04` |
| `EDERP01` |
| `EDERP02` |
2024-01-08 09:29:04 +00:00
| `EPD01` |
| `EPD02` |
| `EPD03` |
2023-11-30 14:49:50 +00:00
## health.Message
```json
{
"code": "EUNKNOWN",
"message": "string"
}
```
### Properties
| Name | Type | Required | Restrictions | Description |
| --------- | -------------------------- | -------- | ------------ | ----------- |
| `code` | [health.Code ](#healthcode ) | false | | |
| `message` | string | false | | |
2023-11-23 15:08:41 +00:00
## health.Severity
```json
"ok"
```
### Properties
#### Enumerated Values
| Value |
| --------- |
| `ok` |
| `warning` |
| `error` |
2023-09-04 18:41:50 +00:00
## healthcheck.AccessURLReport
```json
{
"access_url": "string",
2023-11-29 16:37:40 +00:00
"dismissed": true,
2023-09-04 18:41:50 +00:00
"error": "string",
"healthy": true,
"healthz_response": "string",
"reachable": true,
2023-11-23 15:08:41 +00:00
"severity": "ok",
2023-11-17 15:00:49 +00:00
"status_code": 0,
2023-11-30 14:49:50 +00:00
"warnings": [
{
"code": "EUNKNOWN",
"message": "string"
}
]
2023-09-04 18:41:50 +00:00
}
```
### Properties
2023-11-30 14:49:50 +00:00
| Name | Type | Required | Restrictions | Description |
| ------------------ | ----------------------------------------- | -------- | ------------ | ------------------------------------------------------------------------------------------- |
| `access_url` | string | false | | |
| `dismissed` | boolean | false | | |
| `error` | string | false | | |
| `healthy` | boolean | false | | Healthy is deprecated and left for backward compatibility purposes, use `Severity` instead. |
| `healthz_response` | string | false | | |
| `reachable` | boolean | false | | |
| `severity` | [health.Severity ](#healthseverity ) | false | | |
| `status_code` | integer | false | | |
| `warnings` | array of [health.Message ](#healthmessage ) | false | | |
2023-11-23 15:08:41 +00:00
#### Enumerated Values
| Property | Value |
| ---------- | --------- |
| `severity` | `ok` |
| `severity` | `warning` |
| `severity` | `error` |
2023-09-04 18:41:50 +00:00
2023-06-20 15:13:22 +00:00
## healthcheck.DatabaseReport
```json
{
2023-11-29 16:37:40 +00:00
"dismissed": true,
2023-06-27 19:13:54 +00:00
"error": "string",
2023-06-20 15:13:22 +00:00
"healthy": true,
2023-08-03 21:20:46 +00:00
"latency": "string",
"latency_ms": 0,
2023-11-13 14:14:43 +00:00
"reachable": true,
2023-11-23 15:08:41 +00:00
"severity": "ok",
2023-11-17 15:00:49 +00:00
"threshold_ms": 0,
2023-11-30 14:49:50 +00:00
"warnings": [
{
"code": "EUNKNOWN",
"message": "string"
}
]
2023-06-20 15:13:22 +00:00
}
```
### Properties
2023-11-30 14:49:50 +00:00
| Name | Type | Required | Restrictions | Description |
| -------------- | ----------------------------------------- | -------- | ------------ | ------------------------------------------------------------------------------------------- |
| `dismissed` | boolean | false | | |
| `error` | string | false | | |
| `healthy` | boolean | false | | Healthy is deprecated and left for backward compatibility purposes, use `Severity` instead. |
| `latency` | string | false | | |
| `latency_ms` | integer | false | | |
| `reachable` | boolean | false | | |
| `severity` | [health.Severity ](#healthseverity ) | false | | |
| `threshold_ms` | integer | false | | |
| `warnings` | array of [health.Message ](#healthmessage ) | false | | |
2023-11-23 15:08:41 +00:00
#### Enumerated Values
| Property | Value |
| ---------- | --------- |
| `severity` | `ok` |
| `severity` | `warning` |
| `severity` | `error` |
2023-06-20 15:13:22 +00:00
2024-01-08 09:29:04 +00:00
## healthcheck.ProvisionerDaemonsReport
```json
{
"dismissed": true,
"error": "string",
2024-01-08 13:55:00 +00:00
"items": [
2024-01-08 09:29:04 +00:00
{
2024-01-08 13:55:00 +00:00
"provisioner_daemon": {
"api_version": "string",
"created_at": "2019-08-24T14:15:22Z",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"last_seen_at": "2019-08-24T14:15:22Z",
"name": "string",
"provisioners": ["string"],
"tags": {
"property1": "string",
"property2": "string"
},
"version": "string"
2024-01-08 09:29:04 +00:00
},
2024-01-08 13:55:00 +00:00
"warnings": [
{
"code": "EUNKNOWN",
"message": "string"
}
]
2024-01-08 09:29:04 +00:00
}
],
"severity": "ok",
"warnings": [
{
"code": "EUNKNOWN",
"message": "string"
}
]
}
```
### Properties
2024-01-08 13:55:00 +00:00
| Name | Type | Required | Restrictions | Description |
| ----------- | --------------------------------------------------------------------------------------------- | -------- | ------------ | ----------- |
| `dismissed` | boolean | false | | |
| `error` | string | false | | |
| `items` | array of [healthcheck.ProvisionerDaemonsReportItem ](#healthcheckprovisionerdaemonsreportitem ) | false | | |
| `severity` | [health.Severity ](#healthseverity ) | false | | |
| `warnings` | array of [health.Message ](#healthmessage ) | false | | |
## healthcheck.ProvisionerDaemonsReportItem
```json
{
"provisioner_daemon": {
"api_version": "string",
"created_at": "2019-08-24T14:15:22Z",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"last_seen_at": "2019-08-24T14:15:22Z",
"name": "string",
"provisioners": ["string"],
"tags": {
"property1": "string",
"property2": "string"
},
"version": "string"
},
"warnings": [
{
"code": "EUNKNOWN",
"message": "string"
}
]
}
```
### Properties
| Name | Type | Required | Restrictions | Description |
| -------------------- | -------------------------------------------------------- | -------- | ------------ | ----------- |
| `provisioner_daemon` | [codersdk.ProvisionerDaemon ](#codersdkprovisionerdaemon ) | false | | |
| `warnings` | array of [health.Message ](#healthmessage ) | false | | |
2024-01-08 09:29:04 +00:00
2023-04-03 06:28:42 +00:00
## healthcheck.Report
```json
{
2023-04-18 20:52:00 +00:00
"access_url": {
2023-06-27 19:13:54 +00:00
"access_url": "string",
2023-11-29 16:37:40 +00:00
"dismissed": true,
2023-06-27 19:13:54 +00:00
"error": "string",
2023-04-18 20:52:00 +00:00
"healthy": true,
2023-05-31 20:17:33 +00:00
"healthz_response": "string",
2023-04-18 20:52:00 +00:00
"reachable": true,
2023-11-23 15:08:41 +00:00
"severity": "ok",
2023-11-17 15:00:49 +00:00
"status_code": 0,
2023-11-30 14:49:50 +00:00
"warnings": [
{
"code": "EUNKNOWN",
"message": "string"
}
]
2023-04-18 20:52:00 +00:00
},
2023-06-27 19:13:54 +00:00
"coder_version": "string",
2023-06-20 15:13:22 +00:00
"database": {
2023-11-29 16:37:40 +00:00
"dismissed": true,
2023-06-27 19:13:54 +00:00
"error": "string",
2023-06-20 15:13:22 +00:00
"healthy": true,
2023-08-03 21:20:46 +00:00
"latency": "string",
"latency_ms": 0,
2023-11-13 14:14:43 +00:00
"reachable": true,
2023-11-23 15:08:41 +00:00
"severity": "ok",
2023-11-17 15:00:49 +00:00
"threshold_ms": 0,
2023-11-30 14:49:50 +00:00
"warnings": [
{
"code": "EUNKNOWN",
"message": "string"
}
]
2023-06-20 15:13:22 +00:00
},
2023-04-03 06:28:42 +00:00
"derp": {
2023-11-29 16:37:40 +00:00
"dismissed": true,
2023-06-27 19:13:54 +00:00
"error": "string",
2023-04-03 06:28:42 +00:00
"healthy": true,
"netcheck": {
"captivePortal": "string",
"globalV4": "string",
"globalV6": "string",
"hairPinning": "string",
"icmpv4": true,
"ipv4": true,
"ipv4CanSend": true,
"ipv6": true,
"ipv6CanSend": true,
"mappingVariesByDestIP": "string",
"oshasIPv6": true,
"pcp": "string",
"pmp": "string",
"preferredDERP": 0,
"regionLatency": {
"property1": 0,
"property2": 0
},
"regionV4Latency": {
"property1": 0,
"property2": 0
},
"regionV6Latency": {
"property1": 0,
"property2": 0
},
"udp": true,
"upnP": "string"
},
2023-06-27 19:13:54 +00:00
"netcheck_err": "string",
2023-04-03 06:28:42 +00:00
"netcheck_logs": ["string"],
"regions": {
"property1": {
2023-06-27 19:13:54 +00:00
"error": "string",
2023-04-03 06:28:42 +00:00
"healthy": true,
"node_reports": [
{
"can_exchange_messages": true,
2023-06-27 19:13:54 +00:00
"client_errs": [["string"]],
2023-04-03 06:28:42 +00:00
"client_logs": [["string"]],
2023-06-27 19:13:54 +00:00
"error": "string",
2023-04-03 06:28:42 +00:00
"healthy": true,
"node": {
2023-08-09 19:50:26 +00:00
"canPort80": true,
2023-04-03 06:28:42 +00:00
"certName": "string",
"derpport": 0,
"forceHTTP": true,
"hostName": "string",
"insecureForTests": true,
"ipv4": "string",
"ipv6": "string",
"name": "string",
"regionID": 0,
"stunonly": true,
"stunport": 0,
"stuntestIP": "string"
},
2023-04-20 01:03:05 +00:00
"node_info": {
"tokenBucketBytesBurst": 0,
"tokenBucketBytesPerSecond": 0
},
2023-08-03 21:20:46 +00:00
"round_trip_ping": "string",
"round_trip_ping_ms": 0,
2023-11-23 15:08:41 +00:00
"severity": "ok",
2023-04-03 06:28:42 +00:00
"stun": {
"canSTUN": true,
"enabled": true,
2023-08-03 21:20:46 +00:00
"error": "string"
2023-04-03 06:28:42 +00:00
},
2023-11-17 15:00:49 +00:00
"uses_websocket": true,
2023-11-30 14:49:50 +00:00
"warnings": [
{
"code": "EUNKNOWN",
"message": "string"
}
]
2023-04-03 06:28:42 +00:00
}
],
"region": {
"avoid": true,
"embeddedRelay": true,
"nodes": [
{
2023-08-09 19:50:26 +00:00
"canPort80": true,
2023-04-03 06:28:42 +00:00
"certName": "string",
"derpport": 0,
"forceHTTP": true,
"hostName": "string",
"insecureForTests": true,
"ipv4": "string",
"ipv6": "string",
"name": "string",
"regionID": 0,
"stunonly": true,
"stunport": 0,
"stuntestIP": "string"
}
],
"regionCode": "string",
"regionID": 0,
"regionName": "string"
2023-11-17 15:00:49 +00:00
},
2023-11-23 15:08:41 +00:00
"severity": "ok",
2023-11-30 14:49:50 +00:00
"warnings": [
{
"code": "EUNKNOWN",
"message": "string"
}
]
2023-04-03 06:28:42 +00:00
},
"property2": {
2023-06-27 19:13:54 +00:00
"error": "string",
2023-04-03 06:28:42 +00:00
"healthy": true,
"node_reports": [
{
"can_exchange_messages": true,
2023-06-27 19:13:54 +00:00
"client_errs": [["string"]],
2023-04-03 06:28:42 +00:00
"client_logs": [["string"]],
2023-06-27 19:13:54 +00:00
"error": "string",
2023-04-03 06:28:42 +00:00
"healthy": true,
"node": {
2023-08-09 19:50:26 +00:00
"canPort80": true,
2023-04-03 06:28:42 +00:00
"certName": "string",
"derpport": 0,
"forceHTTP": true,
"hostName": "string",
"insecureForTests": true,
"ipv4": "string",
"ipv6": "string",
"name": "string",
"regionID": 0,
"stunonly": true,
"stunport": 0,
"stuntestIP": "string"
},
2023-04-20 01:03:05 +00:00
"node_info": {
"tokenBucketBytesBurst": 0,
"tokenBucketBytesPerSecond": 0
},
2023-08-03 21:20:46 +00:00
"round_trip_ping": "string",
"round_trip_ping_ms": 0,
2023-11-23 15:08:41 +00:00
"severity": "ok",
2023-04-03 06:28:42 +00:00
"stun": {
"canSTUN": true,
"enabled": true,
2023-08-03 21:20:46 +00:00
"error": "string"
2023-04-03 06:28:42 +00:00
},
2023-11-17 15:00:49 +00:00
"uses_websocket": true,
2023-11-30 14:49:50 +00:00
"warnings": [
{
"code": "EUNKNOWN",
"message": "string"
}
]
2023-04-03 06:28:42 +00:00
}
],
"region": {
"avoid": true,
"embeddedRelay": true,
"nodes": [
{
2023-08-09 19:50:26 +00:00
"canPort80": true,
2023-04-03 06:28:42 +00:00
"certName": "string",
"derpport": 0,
"forceHTTP": true,
"hostName": "string",
"insecureForTests": true,
"ipv4": "string",
"ipv6": "string",
"name": "string",
"regionID": 0,
"stunonly": true,
"stunport": 0,
"stuntestIP": "string"
}
],
"regionCode": "string",
"regionID": 0,
"regionName": "string"
2023-11-17 15:00:49 +00:00
},
2023-11-23 15:08:41 +00:00
"severity": "ok",
2023-11-30 14:49:50 +00:00
"warnings": [
{
"code": "EUNKNOWN",
"message": "string"
}
]
2023-04-03 06:28:42 +00:00
}
2023-11-17 15:00:49 +00:00
},
2023-11-23 15:08:41 +00:00
"severity": "ok",
2023-11-30 14:49:50 +00:00
"warnings": [
{
"code": "EUNKNOWN",
"message": "string"
}
]
2023-04-03 06:28:42 +00:00
},
2023-12-05 20:00:27 +00:00
"failing_sections": ["DERP"],
2023-05-31 20:17:33 +00:00
"healthy": true,
2024-01-08 09:29:04 +00:00
"provisioner_daemons": {
"dismissed": true,
"error": "string",
2024-01-08 13:55:00 +00:00
"items": [
2024-01-08 09:29:04 +00:00
{
2024-01-08 13:55:00 +00:00
"provisioner_daemon": {
"api_version": "string",
"created_at": "2019-08-24T14:15:22Z",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"last_seen_at": "2019-08-24T14:15:22Z",
"name": "string",
"provisioners": ["string"],
"tags": {
"property1": "string",
"property2": "string"
},
"version": "string"
2024-01-08 09:29:04 +00:00
},
2024-01-08 13:55:00 +00:00
"warnings": [
{
"code": "EUNKNOWN",
"message": "string"
}
]
2024-01-08 09:29:04 +00:00
}
],
"severity": "ok",
"warnings": [
{
"code": "EUNKNOWN",
"message": "string"
}
]
},
2023-11-23 15:08:41 +00:00
"severity": "ok",
2023-05-30 19:22:32 +00:00
"time": "string",
"websocket": {
2023-08-03 21:20:46 +00:00
"body": "string",
"code": 0,
2023-11-29 16:37:40 +00:00
"dismissed": true,
2023-06-27 19:13:54 +00:00
"error": "string",
2023-11-17 15:00:49 +00:00
"healthy": true,
2023-11-23 15:08:41 +00:00
"severity": "ok",
2023-11-17 15:00:49 +00:00
"warnings": ["string"]
2023-11-24 15:06:51 +00:00
},
"workspace_proxy": {
2023-11-29 16:37:40 +00:00
"dismissed": true,
2023-11-24 15:06:51 +00:00
"error": "string",
"healthy": true,
"severity": "ok",
2023-11-30 14:49:50 +00:00
"warnings": [
{
"code": "EUNKNOWN",
"message": "string"
}
],
2023-11-24 15:06:51 +00:00
"workspace_proxies": {
"regions": [
{
"created_at": "2019-08-24T14:15:22Z",
"deleted": true,
"derp_enabled": true,
"derp_only": true,
"display_name": "string",
"healthy": true,
"icon_url": "string",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"path_app_url": "string",
"status": {
"checked_at": "2019-08-24T14:15:22Z",
"report": {
"errors": ["string"],
"warnings": ["string"]
},
"status": "ok"
},
"updated_at": "2019-08-24T14:15:22Z",
"version": "string",
"wildcard_hostname": "string"
}
]
}
2023-05-30 19:22:32 +00:00
}
2023-04-03 06:28:42 +00:00
}
```
### Properties
2024-01-08 09:29:04 +00:00
| Name | Type | Required | Restrictions | Description |
| --------------------- | ---------------------------------------------------------------------------- | -------- | ------------ | ----------------------------------------------------------------------------------- |
| `access_url` | [healthcheck.AccessURLReport ](#healthcheckaccessurlreport ) | false | | |
| `coder_version` | string | false | | The Coder version of the server that the report was generated on. |
| `database` | [healthcheck.DatabaseReport ](#healthcheckdatabasereport ) | false | | |
| `derp` | [derphealth.Report ](#derphealthreport ) | false | | |
| `failing_sections` | array of [codersdk.HealthSection ](#codersdkhealthsection ) | false | | Failing sections is a list of sections that have failed their healthcheck. |
| `healthy` | boolean | false | | Healthy is true if the report returns no errors. Deprecated: use `Severity` instead |
| `provisioner_daemons` | [healthcheck.ProvisionerDaemonsReport ](#healthcheckprovisionerdaemonsreport ) | false | | |
| `severity` | [health.Severity ](#healthseverity ) | false | | Severity indicates the status of Coder health. |
| `time` | string | false | | Time is the time the report was generated at. |
| `websocket` | [healthcheck.WebsocketReport ](#healthcheckwebsocketreport ) | false | | |
| `workspace_proxy` | [healthcheck.WorkspaceProxyReport ](#healthcheckworkspaceproxyreport ) | false | | |
2023-11-23 15:08:41 +00:00
#### Enumerated Values
| Property | Value |
| ---------- | --------- |
| `severity` | `ok` |
| `severity` | `warning` |
| `severity` | `error` |
2023-05-30 19:22:32 +00:00
## healthcheck.WebsocketReport
```json
{
"body": "string",
2023-08-03 21:20:46 +00:00
"code": 0,
2023-11-29 16:37:40 +00:00
"dismissed": true,
2023-08-03 21:20:46 +00:00
"error": "string",
2023-11-17 15:00:49 +00:00
"healthy": true,
2023-11-23 15:08:41 +00:00
"severity": "ok",
2023-11-17 15:00:49 +00:00
"warnings": ["string"]
2023-05-30 19:22:32 +00:00
}
```
### Properties
2023-11-29 16:37:40 +00:00
| Name | Type | Required | Restrictions | Description |
| ----------- | ---------------------------------- | -------- | ------------ | ------------------------------------------------------------------------------------------- |
| `body` | string | false | | |
| `code` | integer | false | | |
| `dismissed` | boolean | false | | |
| `error` | string | false | | |
| `healthy` | boolean | false | | Healthy is deprecated and left for backward compatibility purposes, use `Severity` instead. |
| `severity` | [health.Severity ](#healthseverity ) | false | | |
| `warnings` | array of string | false | | |
2023-11-23 15:08:41 +00:00
#### Enumerated Values
| Property | Value |
| ---------- | --------- |
| `severity` | `ok` |
| `severity` | `warning` |
| `severity` | `error` |
2023-04-03 06:28:42 +00:00
2023-11-24 15:06:51 +00:00
## healthcheck.WorkspaceProxyReport
```json
{
2023-11-29 16:37:40 +00:00
"dismissed": true,
2023-11-24 15:06:51 +00:00
"error": "string",
"healthy": true,
"severity": "ok",
2023-11-30 14:49:50 +00:00
"warnings": [
{
"code": "EUNKNOWN",
"message": "string"
}
],
2023-11-24 15:06:51 +00:00
"workspace_proxies": {
"regions": [
{
"created_at": "2019-08-24T14:15:22Z",
"deleted": true,
"derp_enabled": true,
"derp_only": true,
"display_name": "string",
"healthy": true,
"icon_url": "string",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"path_app_url": "string",
"status": {
"checked_at": "2019-08-24T14:15:22Z",
"report": {
"errors": ["string"],
"warnings": ["string"]
},
"status": "ok"
},
"updated_at": "2019-08-24T14:15:22Z",
"version": "string",
"wildcard_hostname": "string"
}
]
}
}
```
### Properties
| Name | Type | Required | Restrictions | Description |
| ------------------- | ---------------------------------------------------------------------------------------------------- | -------- | ------------ | ----------- |
2023-11-29 16:37:40 +00:00
| `dismissed` | boolean | false | | |
2023-11-24 15:06:51 +00:00
| `error` | string | false | | |
| `healthy` | boolean | false | | |
| `severity` | [health.Severity ](#healthseverity ) | false | | |
2023-11-30 14:49:50 +00:00
| `warnings` | array of [health.Message ](#healthmessage ) | false | | |
2023-11-24 15:06:51 +00:00
| `workspace_proxies` | [codersdk.RegionsResponse-codersdk_WorkspaceProxy ](#codersdkregionsresponse-codersdk_workspaceproxy ) | false | | |
2023-04-03 06:28:42 +00:00
## netcheck.Report
```json
{
"captivePortal": "string",
"globalV4": "string",
"globalV6": "string",
"hairPinning": "string",
"icmpv4": true,
"ipv4": true,
"ipv4CanSend": true,
"ipv6": true,
"ipv6CanSend": true,
"mappingVariesByDestIP": "string",
"oshasIPv6": true,
"pcp": "string",
"pmp": "string",
"preferredDERP": 0,
"regionLatency": {
"property1": 0,
"property2": 0
},
"regionV4Latency": {
"property1": 0,
"property2": 0
},
"regionV6Latency": {
"property1": 0,
"property2": 0
},
"udp": true,
"upnP": "string"
}
```
### Properties
| Name | Type | Required | Restrictions | Description |
| ----------------------- | ------- | -------- | ------------ | ---------------------------------------------------------------------------------------------------------------------------------- |
| `captivePortal` | string | false | | Captiveportal is set when we think there's a captive portal that is intercepting HTTP traffic. |
| `globalV4` | string | false | | ip:port of global IPv4 |
| `globalV6` | string | false | | [ip]:port of global IPv6 |
| `hairPinning` | string | false | | Hairpinning is whether the router supports communicating between two local devices through the NATted public IP address (on IPv4). |
| `icmpv4` | boolean | false | | an ICMPv4 round trip completed |
| `ipv4` | boolean | false | | an IPv4 STUN round trip completed |
| `ipv4CanSend` | boolean | false | | an IPv4 packet was able to be sent |
| `ipv6` | boolean | false | | an IPv6 STUN round trip completed |
| `ipv6CanSend` | boolean | false | | an IPv6 packet was able to be sent |
| `mappingVariesByDestIP` | string | false | | Mappingvariesbydestip is whether STUN results depend which STUN server you're talking to (on IPv4). |
| `oshasIPv6` | boolean | false | | could bind a socket to ::1 |
| `pcp` | string | false | | Pcp is whether PCP appears present on the LAN. Empty means not checked. |
| `pmp` | string | false | | Pmp is whether NAT-PMP appears present on the LAN. Empty means not checked. |
| `preferredDERP` | integer | false | | or 0 for unknown |
| `regionLatency` | object | false | | keyed by DERP Region ID |
| » `[any property]` | integer | false | | |
| `regionV4Latency` | object | false | | keyed by DERP Region ID |
| » `[any property]` | integer | false | | |
| `regionV6Latency` | object | false | | keyed by DERP Region ID |
| » `[any property]` | integer | false | | |
| `udp` | boolean | false | | a UDP STUN round trip completed |
| `upnP` | string | false | | Upnp is whether UPnP appears present on the LAN. Empty means not checked. |
2023-08-09 19:50:26 +00:00
## tailcfg.DERPHomeParams
```json
{
"regionScore": {
"property1": 0,
"property2": 0
}
}
```
### Properties
| Name | Type | Required | Restrictions | Description |
| ------------- | ------ | -------- | ------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `regionScore` | object | false | | Regionscore scales latencies of DERP regions by a given scaling factor when determining which region to use as the home ("preferred") DERP. Scores in the range (0, 1) will cause this region to be proportionally more preferred, and scores in the range (1, ∞) will penalize a region. |
If a region is not present in this map, it is treated as having a score of 1.0.
Scores should not be 0 or negative; such scores will be ignored.
A nil map means no change from the previous value (if any); an empty non-nil map can be sent to reset all scores back to 1.0.|
|» `[any property]` |number|false|||
2023-01-05 14:27:10 +00:00
## tailcfg.DERPMap
```json
{
2023-08-09 19:50:26 +00:00
"homeParams": {
"regionScore": {
"property1": 0,
"property2": 0
}
},
2023-01-05 14:27:10 +00:00
"omitDefaultRegions": true,
"regions": {
"property1": {
"avoid": true,
"embeddedRelay": true,
"nodes": [
{
2023-08-09 19:50:26 +00:00
"canPort80": true,
2023-01-05 14:27:10 +00:00
"certName": "string",
"derpport": 0,
"forceHTTP": true,
"hostName": "string",
"insecureForTests": true,
"ipv4": "string",
"ipv6": "string",
"name": "string",
"regionID": 0,
"stunonly": true,
"stunport": 0,
"stuntestIP": "string"
}
],
"regionCode": "string",
"regionID": 0,
"regionName": "string"
},
"property2": {
"avoid": true,
"embeddedRelay": true,
"nodes": [
{
2023-08-09 19:50:26 +00:00
"canPort80": true,
2023-01-05 14:27:10 +00:00
"certName": "string",
"derpport": 0,
"forceHTTP": true,
"hostName": "string",
"insecureForTests": true,
"ipv4": "string",
"ipv6": "string",
"name": "string",
"regionID": 0,
"stunonly": true,
"stunport": 0,
"stuntestIP": "string"
}
],
"regionCode": "string",
"regionID": 0,
"regionName": "string"
}
}
}
```
### Properties
2023-08-09 19:50:26 +00:00
| Name | Type | Required | Restrictions | Description |
| ---------------------------------------------------------------------------------- | ------------------------------------------------ | -------- | ------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `homeParams` | [tailcfg.DERPHomeParams ](#tailcfgderphomeparams ) | false | | Homeparams if non-nil, is a change in home parameters. |
| The rest of the DEPRMap fields, if zero, means unchanged. |
| `omitDefaultRegions` | boolean | false | | Omitdefaultregions specifies to not use Tailscale's DERP servers, and only use those specified in this DERPMap. If there are none set outside of the defaults, this is a noop. |
| This field is only meaningful if the Regions map is non-nil (indicating a change). |
| `regions` | object | false | | Regions is the set of geographic regions running DERP node(s). |
2023-01-05 14:27:10 +00:00
It's keyed by the DERPRegion.RegionID.
The numbers are not necessarily contiguous.|
|» `[any property]` |[tailcfg.DERPRegion](#tailcfgderpregion)|false|||
## tailcfg.DERPNode
```json
{
2023-08-09 19:50:26 +00:00
"canPort80": true,
2023-01-05 14:27:10 +00:00
"certName": "string",
"derpport": 0,
"forceHTTP": true,
"hostName": "string",
"insecureForTests": true,
"ipv4": "string",
"ipv6": "string",
"name": "string",
"regionID": 0,
"stunonly": true,
"stunport": 0,
"stuntestIP": "string"
}
```
### Properties
| Name | Type | Required | Restrictions | Description |
| --------------------------------------------------------------------------------------------------------------------- | ------- | -------- | ------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
2023-08-09 19:50:26 +00:00
| `canPort80` | boolean | false | | Canport80 specifies whether this DERP node is accessible over HTTP on port 80 specifically. This is used for captive portal checks. |
2023-01-05 14:27:10 +00:00
| `certName` | string | false | | Certname optionally specifies the expected TLS cert common name. If empty, HostName is used. If CertName is non-empty, HostName is only used for the TCP dial (if IPv4/IPv6 are not present) + TLS ClientHello. |
| `derpport` | integer | false | | Derpport optionally provides an alternate TLS port number for the DERP HTTPS server. |
| If zero, 443 is used. |
| `forceHTTP` | boolean | false | | Forcehttp is used by unit tests to force HTTP. It should not be set by users. |
| `hostName` | string | false | | Hostname is the DERP node's hostname. |
| It is required but need not be unique; multiple nodes may have the same HostName but vary in configuration otherwise. |
| `insecureForTests` | boolean | false | | Insecurefortests is used by unit tests to disable TLS verification. It should not be set by users. |
| `ipv4` | string | false | | Ipv4 optionally forces an IPv4 address to use, instead of using DNS. If empty, A record(s) from DNS lookups of HostName are used. If the string is not an IPv4 address, IPv4 is not used; the conventional string to disable IPv4 (and not use DNS) is "none". |
| `ipv6` | string | false | | Ipv6 optionally forces an IPv6 address to use, instead of using DNS. If empty, AAAA record(s) from DNS lookups of HostName are used. If the string is not an IPv6 address, IPv6 is not used; the conventional string to disable IPv6 (and not use DNS) is "none". |
| `name` | string | false | | Name is a unique node name (across all regions). It is not a host name. It's typically of the form "1b", "2a", "3b", etc. (region ID + suffix within that region) |
| `regionID` | integer | false | | Regionid is the RegionID of the DERPRegion that this node is running in. |
| `stunonly` | boolean | false | | Stunonly marks a node as only a STUN server and not a DERP server. |
| `stunport` | integer | false | | Port optionally specifies a STUN port to use. Zero means 3478. To disable STUN on this node, use -1. |
| `stuntestIP` | string | false | | Stuntestip is used in tests to override the STUN server's IP. If empty, it's assumed to be the same as the DERP server. |
## tailcfg.DERPRegion
```json
{
"avoid": true,
"embeddedRelay": true,
"nodes": [
{
2023-08-09 19:50:26 +00:00
"canPort80": true,
2023-01-05 14:27:10 +00:00
"certName": "string",
"derpport": 0,
"forceHTTP": true,
"hostName": "string",
"insecureForTests": true,
"ipv4": "string",
"ipv6": "string",
"name": "string",
"regionID": 0,
"stunonly": true,
"stunport": 0,
"stuntestIP": "string"
}
],
"regionCode": "string",
"regionID": 0,
"regionName": "string"
}
```
### Properties
| Name | Type | Required | Restrictions | Description |
| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------- | -------- | ------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `avoid` | boolean | false | | Avoid is whether the client should avoid picking this as its home region. The region should only be used if a peer is there. Clients already using this region as their home should migrate away to a new region without Avoid set. |
| `embeddedRelay` | boolean | false | | Embeddedrelay is true when the region is bundled with the Coder control plane. |
| `nodes` | array of [tailcfg.DERPNode ](#tailcfgderpnode ) | false | | Nodes are the DERP nodes running in this region, in priority order for the current client. Client TLS connections should ideally only go to the first entry (falling back to the second if necessary). STUN packets should go to the first 1 or 2. |
| If nodes within a region route packets amongst themselves, but not to other regions. That said, each user/domain should get a the same preferred node order, so if all nodes for a user/network pick the first one (as they should, when things are healthy), the inter-cluster routing is minimal to zero. |
| `regionCode` | string | false | | Regioncode is a short name for the region. It's usually a popular city or airport code in the region: "nyc", "sf", "sin", "fra", etc. |
| `regionID` | integer | false | | Regionid is a unique integer for a geographic region. |
It corresponds to the legacy derpN.tailscale.com hostnames used by older clients. (Older clients will continue to resolve derpN.tailscale.com when contacting peers, rather than use the server-provided DERPMap)
RegionIDs must be non-zero, positive, and guaranteed to fit in a JavaScript number.
RegionIDs in range 900-999 are reserved for end users to run their own DERP nodes.|
|`regionName`|string|false||Regionname is a long English name for the region: "New York City", "San Francisco", "Singapore", "Frankfurt", etc.|
2023-03-07 21:10:01 +00:00
## url.Userinfo
```json
{}
```
### Properties
_None_
2023-04-17 19:57:21 +00:00
## workspaceapps.AccessMethod
```json
"path"
```
### Properties
#### Enumerated Values
| Value |
| ----------- |
| `path` |
| `subdomain` |
| `terminal` |
## workspaceapps.IssueTokenRequest
```json
{
"app_hostname": "string",
"app_path": "string",
"app_query": "string",
"app_request": {
"access_method": "path",
"agent_name_or_id": "string",
2023-10-10 20:02:39 +00:00
"app_prefix": "string",
2023-04-17 19:57:21 +00:00
"app_slug_or_port": "string",
"base_path": "string",
"username_or_id": "string",
"workspace_name_or_id": "string"
},
"path_app_base_url": "string",
"session_token": "string"
}
```
### Properties
| Name | Type | Required | Restrictions | Description |
| ------------------- | ---------------------------------------------- | -------- | ------------ | --------------------------------------------------------------------------------------------------------------- |
| `app_hostname` | string | false | | App hostname is the optional hostname for subdomain apps on the external proxy. It must start with an asterisk. |
| `app_path` | string | false | | App path is the path of the user underneath the app base path. |
| `app_query` | string | false | | App query is the query parameters the user provided in the app request. |
| `app_request` | [workspaceapps.Request ](#workspaceappsrequest ) | false | | |
| `path_app_base_url` | string | false | | Path app base URL is required. |
| `session_token` | string | false | | Session token is the session token provided by the user. |
## workspaceapps.Request
```json
{
"access_method": "path",
"agent_name_or_id": "string",
2023-10-10 20:02:39 +00:00
"app_prefix": "string",
2023-04-17 19:57:21 +00:00
"app_slug_or_port": "string",
"base_path": "string",
"username_or_id": "string",
"workspace_name_or_id": "string"
}
```
### Properties
| Name | Type | Required | Restrictions | Description |
| ---------------------- | -------------------------------------------------------- | -------- | ------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `access_method` | [workspaceapps.AccessMethod ](#workspaceappsaccessmethod ) | false | | |
| `agent_name_or_id` | string | false | | Agent name or ID is not required if the workspace has only one agent. |
2023-10-10 20:02:39 +00:00
| `app_prefix` | string | false | | Prefix is the prefix of the subdomain app URL. Prefix should have a trailing "---" if set. |
2023-04-17 19:57:21 +00:00
| `app_slug_or_port` | string | false | | |
| `base_path` | string | false | | Base path of the app. For path apps, this is the path prefix in the router for this particular app. For subdomain apps, this should be "/". This is used for setting the cookie path. |
| `username_or_id` | string | false | | For the following fields, if the AccessMethod is AccessMethodTerminal, then only AgentNameOrID may be set and it must be a UUID. The other fields must be left blank. |
| `workspace_name_or_id` | string | false | | |
2023-08-16 12:22:00 +00:00
## workspaceapps.StatsReport
```json
{
"access_method": "path",
"agent_id": "string",
"requests": 0,
"session_ended_at": "string",
"session_id": "string",
"session_started_at": "string",
"slug_or_port": "string",
"user_id": "string",
"workspace_id": "string"
}
```
### Properties
| Name | Type | Required | Restrictions | Description |
| -------------------- | -------------------------------------------------------- | -------- | ------------ | --------------------------------------------------------------------------------------- |
| `access_method` | [workspaceapps.AccessMethod ](#workspaceappsaccessmethod ) | false | | |
| `agent_id` | string | false | | |
| `requests` | integer | false | | |
| `session_ended_at` | string | false | | Updated periodically while app is in use active and when the last connection is closed. |
| `session_id` | string | false | | |
| `session_started_at` | string | false | | |
| `slug_or_port` | string | false | | |
| `user_id` | string | false | | |
| `workspace_id` | string | false | | |
2023-07-26 16:21:04 +00:00
## wsproxysdk.DeregisterWorkspaceProxyRequest
```json
{
"replica_id": "string"
}
```
### Properties
| Name | Type | Required | Restrictions | Description |
| ------------ | ------ | -------- | ------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `replica_id` | string | false | | Replica ID is a unique identifier for the replica of the proxy that is deregistering. It should be generated by the client on startup and should've already been passed to the register endpoint. |
2023-04-17 19:57:21 +00:00
## wsproxysdk.IssueSignedAppTokenResponse
```json
{
"signed_token_str": "string"
}
```
### Properties
| Name | Type | Required | Restrictions | Description |
| ------------------ | ------ | -------- | ------------ | ----------------------------------------------------------- |
| `signed_token_str` | string | false | | Signed token str should be set as a cookie on the response. |
2023-04-20 14:48:47 +00:00
## wsproxysdk.RegisterWorkspaceProxyRequest
```json
{
"access_url": "string",
2023-07-26 16:21:04 +00:00
"derp_enabled": true,
2023-08-02 14:35:06 +00:00
"derp_only": true,
2023-07-26 16:21:04 +00:00
"hostname": "string",
"replica_error": "string",
"replica_id": "string",
"replica_relay_address": "string",
"version": "string",
2023-04-20 14:48:47 +00:00
"wildcard_hostname": "string"
}
```
### Properties
2023-07-26 16:21:04 +00:00
| Name | Type | Required | Restrictions | Description |
| ------------------------------------------------------------------------------------------------- | ------- | -------- | ------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `access_url` | string | false | | Access URL that hits the workspace proxy api. |
| `derp_enabled` | boolean | false | | Derp enabled indicates whether the proxy should be included in the DERP map or not. |
2023-08-02 14:35:06 +00:00
| `derp_only` | boolean | false | | Derp only indicates whether the proxy should only be included in the DERP map and should not be used for serving apps. |
2023-07-26 16:21:04 +00:00
| `hostname` | string | false | | Hostname is the OS hostname of the machine that the proxy is running on. This is only used for tracking purposes in the replicas table. |
| `replica_error` | string | false | | Replica error is the error that the replica encountered when trying to dial it's peers. This is stored in the replicas table for debugging purposes but does not affect the proxy's ability to register. |
| This value is only stored on subsequent requests to the register endpoint, not the first request. |
| `replica_id` | string | false | | Replica ID is a unique identifier for the replica of the proxy that is registering. It should be generated by the client on startup and persisted (in memory only) until the process is restarted. |
| `replica_relay_address` | string | false | | Replica relay address is the DERP address of the replica that other replicas may use to connect internally for DERP meshing. |
| `version` | string | false | | Version is the Coder version of the proxy. |
| `wildcard_hostname` | string | false | | Wildcard hostname that the workspace proxy api is serving for subdomain apps. |
2023-04-20 14:48:47 +00:00
## wsproxysdk.RegisterWorkspaceProxyResponse
```json
{
2023-07-26 16:21:04 +00:00
"app_security_key": "string",
2023-08-24 17:22:31 +00:00
"derp_force_websockets": true,
2023-08-23 11:20:31 +00:00
"derp_map": {
"homeParams": {
"regionScore": {
"property1": 0,
"property2": 0
}
},
"omitDefaultRegions": true,
"regions": {
"property1": {
"avoid": true,
"embeddedRelay": true,
"nodes": [
{
"canPort80": true,
"certName": "string",
"derpport": 0,
"forceHTTP": true,
"hostName": "string",
"insecureForTests": true,
"ipv4": "string",
"ipv6": "string",
"name": "string",
"regionID": 0,
"stunonly": true,
"stunport": 0,
"stuntestIP": "string"
}
],
"regionCode": "string",
"regionID": 0,
"regionName": "string"
},
"property2": {
"avoid": true,
"embeddedRelay": true,
"nodes": [
{
"canPort80": true,
"certName": "string",
"derpport": 0,
"forceHTTP": true,
"hostName": "string",
"insecureForTests": true,
"ipv4": "string",
"ipv6": "string",
"name": "string",
"regionID": 0,
"stunonly": true,
"stunport": 0,
"stuntestIP": "string"
}
],
"regionCode": "string",
"regionID": 0,
"regionName": "string"
}
}
},
2023-07-26 16:21:04 +00:00
"derp_mesh_key": "string",
"derp_region_id": 0,
"sibling_replicas": [
{
"created_at": "2019-08-24T14:15:22Z",
"database_latency": 0,
"error": "string",
"hostname": "string",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"region_id": 0,
"relay_address": "string"
}
]
2023-04-20 14:48:47 +00:00
}
```
### Properties
2023-08-24 17:22:31 +00:00
| Name | Type | Required | Restrictions | Description |
| ----------------------- | --------------------------------------------- | -------- | ------------ | -------------------------------------------------------------------------------------- |
| `app_security_key` | string | false | | |
| `derp_force_websockets` | boolean | false | | |
| `derp_map` | [tailcfg.DERPMap ](#tailcfgderpmap ) | false | | |
| `derp_mesh_key` | string | false | | |
| `derp_region_id` | integer | false | | |
| `sibling_replicas` | array of [codersdk.Replica ](#codersdkreplica ) | false | | Sibling replicas is a list of all other replicas of the proxy that have not timed out. |
2023-08-16 12:22:00 +00:00
## wsproxysdk.ReportAppStatsRequest
```json
{
"stats": [
{
"access_method": "path",
"agent_id": "string",
"requests": 0,
"session_ended_at": "string",
"session_id": "string",
"session_started_at": "string",
"slug_or_port": "string",
"user_id": "string",
"workspace_id": "string"
}
]
}
```
### Properties
| Name | Type | Required | Restrictions | Description |
| ------- | --------------------------------------------------------------- | -------- | ------------ | ----------- |
| `stats` | array of [workspaceapps.StatsReport ](#workspaceappsstatsreport ) | false | | |
